Retrieve Subscriptions

get

https://{APP_DOMAIN}/api/3.2/subscriptions

Returns a paginated list of subscriptions — the relationship between a subscriber's email and a publication. Supports advanced query filtering for subscriber search. Includes related email, publication, addons, tags, subscriber tags, and segments.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

active

string

enum

Filter subscriptions by status. Accepts 'true' (active), 'false' (inactive), or 'lead'.

Allowed:

ids

array of integers

Filter the subscriptions by the requested subscription IDs.

ids

page

integer

The page to return.

per_page

integer

The total results to return per page.

columns[]

array of strings

The field names to be included in the JSON response. You can have multiple columns[] query params included in the request URL (e.g. columns[]=id&columns[]=name).

columns[]

sort

string

The field to sort the request by. column_name|asc OR desc

publication_id

array of integers

Filters the results by publication ID. Can be repeated as publication_id[]=1&publication_id[]=2 to filter by multiple publications, or passed as a single integer.

publication_id

sign_up_operator

string

The condition to use when filtering by sign_up_date. Valid operators: <,<=,=,>=,>

sign_up_value

integer

The value to use when filtering by sign_up_date.

sign_up_period

string

The period of time to use when filtering by sign_up_date. Valid inputs: days,months

click_count

integer

The number of clicks for the subscription

click_count_operator

string

The condition to use when filtering by click_count. Valid operators: <,<=,=,>=,>

click_time_value

integer

The number of days/months defined in the click_time_period to filter by.

click_time_period

string

The period of time to use when filtering by click_time_value. Valid inputs: days,months

click_time_operator

string

The condition to use when filtering by click_time_value and click_time_period. Valid operators: <,<=,=,>=,>

open_count

integer

The number of opens for the subscription

open_count_operator

string

The condition to use when filtering by open_count. Valid operators: <,<=,=,>=,>

open_time_value

integer

The number of days/months defined in the open_time_period to filter by.

open_time_period

string

The period of time to use when filtering by open_time_value. Valid inputs: days,months

open_time_operator

string

The condition to use when filtering by open_time_value and open_time_period. Valid operators: <,<=,=,>=,>

Response

200The retrieved Subscriptions