ITiterable
campaigns

List campaign metadata

Get metadata about campaigns in a project. Use <code>page</code> and <code>pageSize</code> parameters to paginate results. If the unpaginated campaigns API is allowed for your project, then all campaigns are returned if no pagination parameters are provided. The unpaginated behavior is deprecated and may be removed in the future. <b>Rate limit</b>: 100 requests/second, per project.

get/api/campaigns

Request

  • Base URL
    https://api.iterable.com
  • Auth
    API key in header Api-Key

Query parameters

pageinteger

Page number (starting at 1).

pageSizeinteger

Number of results to return per page (defaults to 20, maximum of 1000).

sortstring

Field to sort campaigns by, with optional direction prefix. Use - for descending, + or no prefix for ascending. Campaigns can be sorted by id, name, createdAt, updatedAt, or startAt. Examples: -createdAt, +name, id

campaignStatestring[]

Filter campaigns by state. Can be specified multiple times to filter by multiple states. Valid states: Draft, Ready, Scheduled, Running, Finished, Starting, Aborted, Recurring, Archived. Example: ?campaignState=Ready&campaignState=Running

Response

successful operation

nextPageUrlstring

The URL to the next page of campaigns, if applicable.

previousPageUrlstring

The URL to the previous page of campaigns, if applicable.

totalCampaignsCountobject

The total count of campaigns across all pages for the supplied query. Only present when using pagination.

Changes

No recorded changes to this operation across all 4 revisions of this API.