ITiterable
campaigns

Get a campaign

Get a campaign by ID. <b>Rate limit</b>: 100 requests/second, per project.

get/api/campaigns/{id}

Request

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

Path parameters

idinteger required

Campaign ID

Response

successful operation

campaignState'Draft' | 'Ready' | 'Scheduled' | 'Running' | 'Finished' | 'Starting' | 'Aborted' | 'Recurring' | 'Archived' required
createdAtinteger required

Creation timestamp as epoch time in milliseconds

createdByUserIdstring required
endedAtinteger

Ended timestamp as epoch time in milliseconds

idnumber required
labelIdsinteger[]

Label IDs associated with this campaign.

labelsstring[]

Label names associated with this campaign.

listIdsinteger[]
messageMediumstring required
namestring required
recurringCampaignIdnumber
sendSizenumber
startAtinteger

Start timestamp as epoch time in milliseconds

suppressionListIdsinteger[]
templateIdnumber
type'Blast' | 'Triggered' required
updatedAtinteger required

Last update timestamp as epoch time in milliseconds

updatedByUserIdstring
workflowIdnumber

Changes

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