List contact subscriptions to lists

One row per contact-to-list subscription, carrying the contact id, the list id, the subscription status and its dates. Filter with contact to see every list one contact is on, with status to see the subscriptions in one state, or with sourceIds to see the subscriptions created through given sources, for example imports. There is no filter by list: a listid parameter is ignored and the unfiltered rows come back. There is no filter by date. Order parameters are ignored too: rows come back in table order whatever orders[...] is sent. meta.total is the number of subscription rows that match, as a string, not a number of contacts. To list or count the contacts on a list, use GET /contacts with listid, adding status for one membership status and meta=only for a count without records. 20 rows per request by default and at most 100; page with offset.

Query Params
int32

Return only the subscriptions of this contact id.

int32
enum

Return only subscriptions in this state: 0 unconfirmed, 1 active, 2 unsubscribed, 3 bounced.

Allowed:
sourceIds
array of int32s

Return only subscriptions created through these sources. Repeat the key for several values: sourceIds[]=1&sourceIds[]=5. A comma-separated value is not split: only its first number is used. Values: 0 unknown, 1 import, 2 sync, 3 account user, 4 API, 5 form, 6 form opt-in, 7 trigger, 8 SMS, 9 automation, 10 bulk edit, 11 email, 12 Gmail.

sourceIds
integer
≤ 100
Defaults to 20

Number of subscription rows to return per request. Defaults to 20; the maximum is 100, and asking for more is capped at 100.

integer
Defaults to 0

Number of subscription rows to skip before returning results. Use with limit to page.

Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json