Skip to main content
GET
List Mailing Lists
Returns an array of the mailing lists belonging to the project your API token is scoped to, with recipient counts by status. Use the returned id values with Upsert Recipients and the other recipient endpoints, or create a list with Create Mailing List.

Authentication

This endpoint requires an API token passed as a Bearer token in the Authorization header.
API tokens are created in the Dashboard under API Keys.

Request

Response

Returns an array of mailing list objects.
string
required
The mailing list’s unique identifier (UUID)
string
required
The mailing list’s name
integer
required
Total number of recipients on the list in every status
integer
required
Recipients who will receive the next release email
integer
required
Recipients you removed (an upsert or add reactivates them)
integer
required
Recipients who unsubscribed themselves (never reactivated by the API)
string
required
When the list was created (ISO 8601 timestamp)

Example Response

200

Errors

Rate Limits

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