Sign in

v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB
Campaigns

List campaign summaries

Returns lightweight read-only summaries of campaigns, including id, name, state, and dates. Supports filtering via query parameters.

get/v2/campaign-summaries

Query parameters

versionstring
program_typestring
tagsstring[]
labelsstring[]
program_labelstring
statesstring[]
include_archivedboolean

Response

Successful response

campaign_idstring required
campaign_locksstring[] required
campaign_type'CONFIGURATION' | 'EXTENSION' | 'INTEGRATION' | 'MARKETING' required
descriptionstring required
end_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

is_publishedboolean required
last_published_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

namestring required
pause_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

program_labelstring required
program_typestring required
root_component_typestring required
start_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

state'ARCHIVED' | 'ENDED' | 'LIVE' | 'NOT_LAUNCHED' | 'PAUSED' | 'STOPPED' required
stop_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

tagsstring[] required
theme_namestring required
updated_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

variantsstring[] required

Example response

[
  {
    "end_date": "2025-10-24T02:00:00-07:00",
    "last_published_date": "2025-10-24T02:00:00-07:00",
    "pause_date": "2025-10-24T02:00:00-07:00",
    "start_date": "2025-10-24T02:00:00-07:00",
    "stop_date": "2025-10-24T02:00:00-07:00",
    "updated_date": "2025-10-24T02:00:00-07:00"
  }
]