Skip to main content
GET
List Subscribers

Authorizations

Authorization
string
header
required

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

Query Parameters

per_page
integer
default:15

How many items to show per page.

page
integer

Which page to show.

filter[meta]
string
sort
enum<string>[]
Available options:
email,
-email,
id,
-id
filter[email]
string

Filter by email address.

filter[global]
boolean

Filter by global subscription status.

include
enum<string>[]

Include related data (components, meta).

Available options:
components,
componentsCount,
componentsExists,
meta,
metaCount,
metaExists

Response

Paginated set of Subscriber

data
Subscriber · object[]
required
meta
object
required
included
Component · object[]