List members

Scope

• lists:read Read lists – the person behind the key must be all members.
• contacts:read Read contacts – the person behind the key must be all members.

Path parameters

idstringrequired

The list's ID.

Query parameters

limitinteger

The maximum number of items in the response (1–500, default 100).at least 1 · at most 500 · default 100

cursorstring

next_cursor from the previous response, for the next page. Omit for the first page.

statusstring

subscribed: receives mailings · pending: awaiting confirmation · unsubscribed: has left · blocked: on the list but cannot be reached.subscribedpendingunsubscribedblocked

Response

200 A page of members.

dataarray<object>required

data[].contact_idstringrequired

data[].emailstringrequired

data[].first_namestring | nullrequired

data[].last_namestring | nullrequired

data[].statusstringrequired

subscribedpendingunsubscribed

data[].contact_statusstringrequired

activeunsubscribedbouncedcomplaineddeleted

data[].sendablebooleanrequired

Currently receives mailings to the list (on the list, active and not suppressed).

data[].subscribed_atstring (time, ISO 8601) | nullrequired

When the person joined.

data[].unsubscribed_atstring (time, ISO 8601) | nullrequired

When the person left the list.

data[].created_atstring (time, ISO 8601)required

When the membership was created.

has_morebooleanrequired

There are more: fetch the next page with cursor=next_cursor.

next_cursorstring | nullrequired

Send as cursor for the next page. null on the last page.

Errors

401

unauthenticatedinvalid_keykey_revokedkey_expiredkey_inactive

402

payment_required

403

insufficient_scopeforbiddenworkspace_suspended

404

not_found

422

validation_failed

429

rate_limited

500

internal_error