Sign in

v1

latestOpenAPI 3.0.32026-07-26737274.2 KB
Subscribers

List subscribers

Returns a cursor-paginated list of subscribers in the account. By default only active subscribers are returned — use status (active, inactive, bounced, complained, cancelled, or all) to widen the search. Look a subscriber up by exact email_address, filter by created_after/created_before and updated_after/updated_before, and sort with sort_field (id, updated_at, or cancelled_at) and sort_order.

Use include (comma-separated: attribution, tags, location, canceled_at) to embed extra fields on each subscriber — including canceled_at without status=cancelled returns a 422. Set slim=true to omit the fields object (custom field values) for a faster, smaller response.

For engagement-based searches (opens, clicks, sends), use Filter subscribers by engagement instead.

get/v4/subscribers

Query parameters

afterstring nullable

To fetch next page of results, use ?after=<end_cursor>

beforestring nullable

To fetch previous page of results, use ?before=<start_cursor>

created_afterstring

Filter subscribers who have been created after this date (format yyyy-mm-dd)

created_beforestring

Filter subscribers who have been created before this date (format yyyy-mm-dd)

email_addressstring
includestring

Comma-separated list of additional fields to include on each subscriber. Valid options: attribution, tags, location, canceled_at. canceled_at may only be used together with status=cancelled.

include_total_countboolean

Set to true to include the total_count in the response. This option can cause slow responses; if paging through results, request it only on the first page and reuse the value for subsequent pages.

per_pagenumber nullable

Number of results per page. Default 500, maximum 1000.

slimboolean

When true, omits expensive optional fields from the response. Produces a faster, smaller response — useful when extra fields are not needed.

sort_fieldstring
sort_order'asc' | 'desc'
status'active' | 'inactive' | 'bounced' | 'complained' | 'cancelled' | 'all'

Filter subscribers who have this status (active, inactive, bounced, complained, cancelled or all). Defaults to active.

updated_afterstring

Filter subscribers who have been updated after this date (format yyyy-mm-dd)

updated_beforestring

Filter subscribers who have been updated before this date (format yyyy-mm-dd)

Response

Returns subscriber attribution, tags, and primary location when requested via the include param