List a batch’s recipients

GET /v1/batches/{id}/recipients

Send your API key as a bearer token: Authorization: Bearer ssms_sk_.... Test keys run this endpoint against the sandbox; see Authentication for key modes and scopes.

Path parameters

Name	Type	Required	Description
`id`	string	Yes

Query parameters

Name	Type	Required	Description
`status`	`queued`, `paused`, `sent`, `failed`, `skipped`, `canceled`	No
`limit`	integer	No	Default 100. Maximum 500.
`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	Recipients in upload order	Page of `BatchRecipient`
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` (BatchRecipient)

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

Field	Type	Description
`id`	string	Example: `r00042`.
`object`	`batch_recipient`
`to`	string
`status`	`queued`, `paused`, `sent`, `failed`, `skipped`, `canceled`
`error`	string	Nullable. Example: `carrier_error`.
`detail`	string	Nullable.
`retryable`	boolean
`attempts`	integer
`message_id`	string	Nullable.
`variables`	object

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 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/batches/bc_a1B2c3D4e5F6/recipients?limit=10" \
  -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/batches/bc_a1B2c3D4e5F6/recipients?limit=10', {
  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.json();

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/batches/bc_a1B2c3D4e5F6/recipients?limit=10",
    method="GET",
    headers={
        "Authorization": f"Bearer {os.environ['SIMPLESMS_API_KEY']}",
    },
)
with urllib.request.urlopen(req) as res:
    data = json.load(res)