This calls enables you to export all campaigns, or only a subset of them.

Log in to see full request history

Search and list campaigns. This calls enables you to export all campaigns, or only a subset of them. You can filter by user and restrict results from a given time window. For efficient deep pagination, you must use sort=none, using a large offset is highly discouraged.

The result is comprised of a data array, and a pagination object containing previous and next, two complete URLs for navigating through the result set. Always use the URLs as is and do not add or remove parameters. When doing efficient deep pagination, only the pagination.next page is available. See Pagination for more help on how to iterate over all results.

Query Params
array of strings

Comma separated list of fields to return.

fields
int32
Defaults to 0

The number of first results to skip. Ignored when no sorting is provided. For an efficient deep pagination, always start at 0.

int32
Defaults to 50

The number of results to return, or 0 for counting only the results. This number may be adjusted for efficient deep paginations. The actual number of results may be less for the last few pages of an efficient deep pagination.

string

The cursor identifier for fetching the next result page. You should always use the whole URL provided in the pagination.next field of the previous request response. Do not try to reuse this identifier if changing the other parameters, as it is bound to them.

string
Defaults to none

How to sort the results. You can sort on multiple fields. For efficient deep pagination, you should use "none". Eg.: "-creationDate" will give you the most recent notifications.

array of strings

Comma separated list of viewIds to filter. Omit the parameter not to filter.

viewIds
array of strings

Comma separated list of channels to filter. Omit the parameter not to filter.

channels
string

The minimum creationDate of the campaigns to list.

string

The maximum creationDate of the campaigns to list.

string

The minimum updateDate of the campaigns to list.

string

The maximum updateDate of the campaigns to list.

string

The minimum editionDate of the campaigns to list.

string

The maximum editionDate of the campaigns to list.

array of strings

Only list campaigns with the given scheduling types. You can prefix them with a - to exclude a value. This corresponds to the scheduling.type field. Valid values are api, asap, event, onceDate, onceNow, recurrently, url

schedulingTypes
array of strings

Only list campaigns in the given state. Corresponds to the state field. Valid values are on, off, template.

states
Response

Language
Credentials
Request
Click Try It! to start a request and see the response here! Or choose an example:
application/json