HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Get Campaign

🚧

This endpoint is in beta and will be released in GA in our 2026-07-15 revision.

A beta revision header (2026-04-15.pre) is required to use our beta APIs.

Get a campaign by ID.

Rate limits:
Burst: 10/s
Steady: 150/m

Scopes:
campaigns:read

Path Params
string
required

The campaign ID to be retrieved

Query Params
fields[campaign-audience]
array of strings
fields[campaign-audience]
fields[campaign-message]
array of strings
fields[campaign-message]
fields[campaign]
array of strings
fields[campaign]
include
array of strings
include
Headers
string
required
Defaults to 2026-04-15.pre

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/vnd.api+json