List a list's subscribers

The list’s subscribers, ordered by id, a page at a time; an optional status filter. Needs scope read; an admin key may list any project’s.

Parameters

Name	In	Type	Description
`project_id`required	path	string · uuid	The project’s id
`list_id`required	path	string · uuid	The list’s id
`status`	query	string	Only this status: pending, active, unsubscribed, bounced, complained
`limit`	query	integer · int64 1–500	Page size, 1 to 500; default 50
`cursor`	query	string	`next_cursor` of the previous page

Request body

None.

Responses

200

One page

SubscriberList object · all fields required
itemsarray of Subscriber

Ordered by id.
12 fields
- Subscriber object · all fields required
- attributesobject
  
  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
  
  example ann@example.com
- idstring · uuid
  
  example 01900000-0000-7000-8000-000000000001
- list_idstring · uuid
  
  The list the subscriber is on.
- project_idstring · uuid
  
  The subscriber’s project.
- soft_bounce_streakinteger · int32
  
  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.
  
  example active
- unsubscribed_atstring · date-time | null
  
  When the subscriber unsubscribed; null otherwise.
- updated_atstring · date-time
  
  The latest change: creation, an attribute merge, a status change.
next_cursorstring | null

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

401

No valid key

Problem (application/problem+json)

403

A project key without scope read (forbidden)

Problem (application/problem+json)

404

No such project or list, or another project’s (not_found)

Problem (application/problem+json)

422

A parameter is invalid (validation_failed)

Problem (application/problem+json)

429

The key is over its rate limit, api.rate_limit_per_minute requests a minute on this node (rate_limited)

Header	Type	Description
`Retry-After`	integer	Seconds until the key’s next request passes; rounded up.

Problem (application/problem+json)

504

Postwind’s storage did not answer within its time limit (storage_timeout). A change the request makes may still take effect: check before repeating it. A repeat with the same Idempotency-Key never runs it twice: it is 409 idempotency_key_in_progress until the key’s 24 h end

Problem (application/problem+json)