Skip to main content
GET
List Subscribers

Authorizations

Authorization
string
header
default:your-api-key
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status
enum<string>

Subscriber status.

Available options:
subscribed,
unsubscribed,
bounced,
complained,
blocked
query
string

Search text.

segmentId
string

Filter by segment.

limit
integer

Maximum rows.

Required range: 1 <= x <= 500
offset
integer

Pagination offset.

Required range: x >= 0

Response

Successful response.

ok
enum<boolean>
required
Available options:
true
data
object[]
required