Skip to main content
GET
List Recipients
Returns a mailing list’s recipients oldest first, 100 per page by default. Each recipient carries the fields your sync wrote (name, external_id, attributes) plus its lifecycle status. Recipient statuses:

Authentication

This endpoint requires an API token passed as a Bearer token in the Authorization header.

Path Parameters

string
required
The mailing list’s unique identifier (UUID).

Query Parameters

string
Only recipients in this status: active, removed or unsubscribed.
string
Case-insensitive search across email, name and external_id.
integer
default:"100"
Page size, 1–500.
string
The next_cursor from the previous page. Omit for the first page.

Request

Response

object[]
required
Recipients in this page.
string
Opaque cursor for the next page; null on the last page.
200

Errors

Rate Limits

This endpoint is limited to 100 requests per minute per IP.