# Export messages, delivery results, events, opt-outs, webhook deliveries, usage, credit history or the audit log as CSV

Source: https://joinsimplesms.com/docs/api/exports/csv
Index: https://joinsimplesms.com/llms.txt

`GET /v1/exports/{kind}`

Streams a CSV (UTF-8 with BOM). At most 50,000 rows per export (header X-Export-Row-Cap); narrow the date range if you hit it. Cells that would be spreadsheet formulas are prefixed with a single quote.

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 |
| --- | --- | --- | --- |
| `kind` | `messages`, `deliveries`, `events`, `opt_outs`, `webhook_deliveries`, `usage`, `usage_monthly`, `audit_log`, `credit_history` | Yes |  |

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `from` | string | No | ISO date/time or epoch ms (messages, deliveries, events, webhook_deliveries) Example: `2026-01-01`. |
| `to` | string | No | Inclusive; a bare date means the end of that day (UTC) Example: `2026-01-31`. |
| `status` | `queued`, `sent`, `delivered`, `failed`, `received` | No | messages, deliveries |
| `direction` | `outbound`, `inbound` | No | messages |
| `number` | string | No | messages, deliveries: digits matched against either side |
| `to_number` | string | No | messages, deliveries: exact recipient (E.164). `to`/`from` are the date range here. |
| `from_number` | string | No | messages, deliveries: exact sender (E.164) |
| `customer_id` | string | No | messages, deliveries |
| `batch` | string | No | messages, deliveries: batch id (bc_...) |
| `q` | string | No | messages: body/failure text; events: id/payload text |
| `type` | string | No | events, webhook_deliveries Example: `message.failed`. |
| `endpoint_id` | string | No | webhook_deliveries (default: all endpoints) |
| `ok` | boolean | No | webhook_deliveries |
| `months` | integer | No | usage: daily rows for the last N months Default 3. Maximum 12. Minimum 1. |
| `action` | string | No | audit_log: one action, or a group prefix with a trailing dot (team.) |
| `actor` | string | No | audit_log: actor id or part of the actor email |
| `target_type` | string | No | audit_log |
| `created_after` | string | No | audit_log: same as on GET /audit-logs (from is accepted too) |
| `created_before` | string | No | audit_log: same as on GET /audit-logs (to is accepted too) |

## Responses

| Status | Meaning | Body |
| --- | --- | --- |
| 200 | CSV body | CSV (`text/csv`) |
| 400 | Unknown kind or invalid filter | `Error` |
| 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` |

## Errors

| Status | When |
| --- | --- |
| 400 | Unknown kind or invalid filter |
| 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/exports/messages" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY"
```

### Node.js

The Node.js SDK does not wrap this endpoint yet; call it with `fetch`.

```javascript
const res = await fetch('https://api.joinsimplesms.com/v1/exports/messages', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SIMPLESMS_API_KEY}`,
  },
});

if (!res.ok) throw new Error((await res.json()).error.message);
const data = await res.text();
```

### Python

The Python SDK does not wrap this endpoint yet; call it over HTTP.

```python
import json, os, urllib.request

req = urllib.request.Request(
    "https://api.joinsimplesms.com/v1/exports/messages",
    method="GET",
    headers={
        "Authorization": f"Bearer {os.environ['SIMPLESMS_API_KEY']}",
    },
)
with urllib.request.urlopen(req) as res:
    data = res.read().decode()
```

## Related

- [All exports endpoints](/docs/api#exports)
- [API reference](/docs/api)
