Get campaign by id

Get one campaign, including its channels, follow-up template, email and SMS requests, and file-header mapping — all in a single response, so you do not need follow-up calls to assemble the full picture.

Despite the path name, this endpoint takes the campaign's numeric id, not a code. A separate public endpoint accepts the alphanumeric campaign code.

Auth

  • The campaign must belong to a location inside your own account. If it does not, the call returns 400 rather than revealing anything about the campaign.

Rate limit

  • No rate limit.

Path params

ParameterTypeRequiredNotes
campaignIdintegerRequiredThe campaign's numeric id. Digits only — a non-numeric value does not match this route.

Behaviour

  • 200 returns the campaign under data, with channels, email_requests, sms_requests and file_header included. Each channel carries the id of the campaign it belongs to.
  • 400 when the campaign belongs to a location outside your account.
  • 404 when no campaign exists with that id.
  • If the campaign resolves but has since disappeared, data comes back as an empty array rather than an error.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json