`list_subscribers`

Lists a list’s subscribers, ordered by id, at most 100 per call, with an optional status filter.

Call it: to page through a list’s subscribers.
Needs: the list’s id and an admin key with project_id, or a project key with scope read (its own project; the argument is ignored).
Returns: items (subscribers as get_subscriber returns them) and next_cursor: pass it as cursor for the next page; null on the last page. The same as GET /api/v1/projects/{project_id}/lists/{list_id}/subscribers.

Arguments

object
list_idstring · uuidrequired

The list whose subscribers to list.
cursorstring | null

next_cursor of the previous page; leave it out for the first.
limitinteger · int64 | null

Page size, 1 to 100; default 50.

1–100
project_idstring · uuid | null

The subscribers’ project. An admin key must pass it; a project key’s own project is used and this is ignored.
statusstring | null

Only this status: pending, active, unsubscribed, bounced or complained.

No other arguments are accepted.

The result comes back as structuredContent, with the same JSON as a text block.

object · all fields required
itemsarray of Subscriber

Ordered by id.
12 fields
- Subscriber object · all fields required
- attributesmap of string → string | number | boolean
  
  The subscriber’s attributes: a map of string, number or boolean values.
- confirmed_atstring · date-time | null
  
  When the subscriber confirmed a double opt-in; null otherwise.
- created_atstring · date-time
- emailstring · email
- idstring · uuid
- list_idstring · uuid
  
  The list the subscriber is on.
- project_idstring · uuid
  
  The subscriber’s project.
- soft_bounce_streakinteger · uint32
  
  Soft bounces in a row; reset by a delivery (P4+).
  
  ≥ 0
- sourcestring
  
  How the subscriber was added: api, import or confirm.
- statusstring
  
  pending, active, unsubscribed, bounced or complained.
- unsubscribed_atstring · date-time | null
  
  When the subscriber unsubscribed; null otherwise.
- updated_atstring · date-time
  
  The latest change: creation, an attribute merge.
next_cursorstring | null

Pass as cursor for the next page; null on the last page.

object · all fields required
attributesmap of string → string | number | boolean

The subscriber’s attributes: a map of string, number or boolean values.
confirmed_atstring · date-time | null

When the subscriber confirmed a double opt-in; null otherwise.
created_atstring · date-time
emailstring · email
idstring · uuid
list_idstring · uuid

The list the subscriber is on.
project_idstring · uuid

The subscriber’s project.
soft_bounce_streakinteger · uint32

Soft bounces in a row; reset by a delivery (P4+).

≥ 0
sourcestring

How the subscriber was added: api, import or confirm.
statusstring

pending, active, unsubscribed, bounced or complained.
unsubscribed_atstring · date-time | null

When the subscriber unsubscribed; null otherwise.
updated_atstring · date-time

The latest change: creation, an attribute merge.

A failed call answers isError: true with a code from the same table as the HTTP API, and detail. How tools report errors