# Export the suppression list, or the full consent ledger with opt-in proof, as CSV

Source: https://joinsimplesms.com/docs/api/consent/export
Index: https://joinsimplesms.com/llms.txt

`GET /v1/consent/export`

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.

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | `suppressions`, `ledger` | No | Default "suppressions". |

## Responses

| Status | Meaning | Body |
| --- | --- | --- |
| 200 | suppressions: phone,status,updated_at,via,method,detected. ledger: phone,at,type,via,method,detected,note,proof_source,proof_collected_at,proof_page_url,proof_disclosure,proof_ip,proof_user_agent,proof_registration_id,proof_campaign_id | CSV (`text/csv`) |
| 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 |
| --- | --- |
| 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/consent/export" \
  -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 csv = await sms.consent.export();
```

### Python

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

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

csv = client.consent.export()
```

## Related

- Guide: [Opt-out, consent & TCPA](/docs/opt-out)
- [All consent endpoints](/docs/api#consent)
- [API reference](/docs/api)