---
title: "Get a test email's progress"
url: https://docs.corefinity.com/api/reference/site-settings/get-site-email-command
type: endpoint
last_updated: 2026-11-13
feature: email
related:
  - https://docs.corefinity.com/guides/sites/site-settings/outbound-email.md
---
# Get a test email's progress

Answers a test send of this site. Read it until `status` is neither `queued` nor `running`: `result.sent`
then says whether the email was handed over, and `result.message` what to do next.

```http
GET /api/corestack/sites/{site}/email/commands/{command}
```

- Scope: `read`
- Rate limit: 120 a minute
- Try it in the console: on

## Path parameters

- `site` (integer, required): The id of a site row. A website's production site and each of its environments has its own id. Digits only.
- `command` (integer, required): The id of a command a test send answered.

## Request

### curl

```bash
curl https://manage.corefinity.com/api/corestack/sites/1042/email/commands/6187 \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
```

### PHP

```php
use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->get('https://manage.corefinity.com/api/corestack/sites/1042/email/commands/6187');

$data = $response->json();
```

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/email/commands/6187', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
  },
});

// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);
```

### Python

```python
import os
import requests

res = requests.get(
    "https://manage.corefinity.com/api/corestack/sites/1042/email/commands/6187",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

data = res.json() if res.content else None
```

## Responses

### 200 The test send as it stands.

```json
{
  "blocked_until_verified": false,
  "duration_ms": 0,
  "error": null,
  "exit_code": 0,
  "finished_at": "2026-11-03T09:16:40Z",
  "id": 6187,
  "input": {
    "domain": "mg.harbourandfinch.example.com",
    "to": "tom.harbour@harbourandfinch.example.com"
  },
  "kind": "email_test",
  "label": "Send a test email",
  "operation_id": null,
  "output_excerpt": "sent\n",
  "queued_at": "2026-11-03T09:16:40Z",
  "requested_by": {
    "id": 2012,
    "name": "Daniel Reyes"
  },
  "result": {
    "message": "Sent. Check the inbox (and spam) of tom.harbour@harbourandfinch.example.com.",
    "sent": true
  },
  "site": {
    "domain": "harbourandfinch.example.com",
    "id": 1042
  },
  "started_at": "2026-11-03T09:16:40Z",
  "status": "succeeded",
  "status_label": "Done"
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the scope (`scope_required`, with the `scope` to use), or your account has no company that can use Managed Clusters, for example because the company was closed (`company_not_enabled`). For Managed Clusters routes that do not ask for two-factor authentication.

```json
{
  "code": "scope_required",
  "message": "This access token does not have the destructive scope this needs. Use a token with the destructive scope.",
  "reason": "scope_required",
  "scope": "destructive"
}
```

### 404 The id does not exist or is something you cannot see, or the feature is not on for your company (`feature_off`).

```json
{
  "code": "feature_off",
  "message": "Not found.",
  "reason": "feature_off"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | Send a valid token as `Authorization: Bearer <token>`. |
| 403 | `scope_required` | Use a token with the scope named in `scope`. |
| 404 | `feature_off` | This feature is not on for your organisation yet. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |

## The same task elsewhere

- Guide: [Outbound email](https://docs.corefinity.com/guides/sites/site-settings/outbound-email.md)
