List the members of a List

Search Documentation

Search across all developer documentation

lists

List the members of a List

GET /v1/lists/{id}/members
Auth required api.lists.view

Returns one page of a List's current members (contact id, email and external_id), newest-added first. external_id is null for a contact that has none; match members to your own users by it, not by email, so an address change is not mistaken for a leaver. 404 not_found when the List does not exist. Member emails are returned in full — api.lists.view is the PII gate.

Path parameters

id string required

The List's UUID or, when the value does not parse as a UUID, its org-unique key. Unknown handles read as 404 not_found. Accepted on every List route, read and write alike.

Query parameters

limit integer optional

Page size (1–200). Default 50.

cursor string optional

Opaque cursor returned from the previous page.

Responses

Errors follow the RFC 7807 problem format — see the error reference.

200 Cursor-paginated list of members application/json
data array<object> required

Each entry in data:

contact_id string<uuid> required
email string<email> required

The contact's current email address — the one it has now, not the one it was added to the List under. A contact whose address changed after it joined is listed under the new address, so PATCH /v1/contacts/{email} with this value reaches that contact.

external_id string | null required

The contact's external_id — your own identifier for it, as set by PUT /v1/contacts/by-external-id/{external_id} or an upsert that carried one. Always present; null when the contact has none. Diff a List against your own user ids with this rather than with email: a user who changed address keeps their external_id.

added_at string<date-time> required

When the contact was added to the List.

pagination object required

Fields of pagination:

has_more boolean required
next_cursor string | null optional
401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
404 Resource not found application/problem+json
422 A query parameter, path value or body field failed validation. The body is a validation_failed Problem. When the refusal is about a reference — a segment key, template slug, topic or attribute name the organization does not have — it additionally carries validation_code, field, line/column, missing, candidates and next_step, so a client can correct the call without a second round of guessing. See ValidationProblem. application/problem+json
429 Per-org rate limit exceeded application/problem+json
500 Unexpected server-side failure. The code is internal_error. The request_id field can be quoted to SendOps support to investigate. application/problem+json