# List an automation's runs, newest first

Source: https://joinsimplesms.com/docs/api/automations/list-runs
Index: https://joinsimplesms.com/llms.txt

`GET /v1/automations/{id}/runs`

Runs are kept for 30 days after they end.

Send your API key as a bearer token: `Authorization: Bearer ssms_sk_...`. Test keys run this endpoint against the [sandbox](/docs/sandbox); see [Authentication](/docs/authentication) for key modes and scopes.

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes |  |

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | integer | No | Default 25. Maximum 100. Minimum 1. |
| `cursor` | string | No |  |

Results are paged. When `has_more` is true, pass `next_cursor` from the response as `cursor` to fetch the next page.

## Responses

| Status | Meaning | Body |
| --- | --- | --- |
| 200 | Runs | Page of `AutomationRun` |
| 401 | Missing, malformed, or revoked API key | `Error` |
| 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged | `Error` |
| 429 | Rate limit or quota exceeded | `Error` |

### 200: each item in `data` (AutomationRun)

The body is a page: `data` (the array), `has_more`, and `next_cursor` (null on the last page).

| Field | Type | Description |
| --- | --- | --- |
| `id` | string | Example: `run_1790000000000a1B2c3D4`. |
| `object` | `automation_run` |  |
| `automation_id` | string |  |
| `automation_version` | integer |  |
| `status` | `running`, `waiting`, `completed`, `failed` |  |
| `to` | string |  |
| `user_id` | string | Nullable. |
| `test` | boolean |  |
| `trigger_event` | string |  |
| `step` | integer | Index of the step the run is on. |
| `waiting_until` | string (date-time) | Nullable. |
| `waiting_for_event` | string | Nullable. |
| `end_reason` | `finished`, `end_step`, `branch_end`, `opted_out`, `flow_deleted`, `version_removed`, `expired`, `canceled`, `error`, `null` | Nullable. |
| `messages_sent` | integer |  |
| `messages_failed` | integer |  |
| `timeline` | array of object |  |
| `timeline[].at` | string (date-time) |  |
| `timeline[].type` | `started`, `sent`, `send_failed`, `send_unconfirmed`, `send_skipped`, `wait_started`, `wait_done`, `waiting_for_event`, `event_received`, `timed_out`, `condition_met`, `condition_not_met`, `ended` |  |
| `timeline[].step_id` | string |  |
| `timeline[].detail` | string |  |
| `timeline[].message_id` | string |  |
| `started_at` | string (date-time) |  |
| `ended_at` | string (date-time) | Nullable. |

## Errors

| Status | When |
| --- | --- |
| 401 | Missing, malformed, or revoked API key |
| 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged |
| 429 | Rate limit or quota exceeded |

Every error has the same JSON shape, and `request_id` matches the `X-Request-Id` response header. [Errors](/docs/errors) lists every code and what to do about it.

```json
{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}
```

## Examples

### curl

```bash
curl -X GET "https://api.joinsimplesms.com/v1/automations/auto_a1B2c3D4e5F6/runs?limit=10" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY"
```

### Node.js

```javascript
import { SimpleSMS } from 'joinsimplesms'; // npm install joinsimplesms

const sms = new SimpleSMS(process.env.SIMPLESMS_API_KEY);

const runs = await sms.automations.runs('auto_a1B2c3D4e5F6', { limit: 10 });
```

### Python

```python
import os
from joinsimplesms import SimpleSMS  # pip install joinsimplesms

client = SimpleSMS(os.environ["SIMPLESMS_API_KEY"])

runs = client.automations.runs("auto_a1B2c3D4e5F6", limit=10)
```

## Related

- Guide: [Automations](/docs/automations)
- [All automations endpoints](/docs/api#automations)
- [API reference](/docs/api)