List Subscribers

GET

/newsletters/{newsletter_id}/subscribers

• Production
• QA

Paginated subscriber list for a newsletter.

Authorizations

• BearerAuth

Parameters

Path Parameters

newsletter_id

required

Newsletter UUID

string format: uuid

Newsletter UUID

Query Parameters

page

integer

default: 1 >= 1

page_size

integer

default: 25 >= 1 <= 100

search

Any of:

string

string

null

null

Free-text search over email/name

status

Any of:

string

string

null

null

Comma-separated status filter (e.g. ‘subscribed,bounced’)

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Responses

200

Successful Response

object

data

required

GET /{newsletter_id}/subscribers — preserves the internal {items, total, page, page_size} shape verbatim.

object

items

Array<object>

A single newsletter subscriber row.

object

created_at

Any of:

string

string

null

null

email

Any of:

string

string

null

null

first_name

Any of:

string

string

null

null

id

Any of:

integer

integer

null

null

last_name

Any of:

string

string

null

null

status

Any of:

string

string

null

null

verification_status

Any of:

string

string

null

null

key

additional properties

any

page

integer

default: 1

page_size

integer

default: 25

total

integer

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string