Skip to main content
POST
Batch retrieve campaigns

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

endDate
string

The end date for filtering campaigns, formatted as a string.

properties
string[]

A comma-separated list of property names to include in the response.

startDate
string

The start date for filtering campaigns, formatted as a string.

Body

application/json
inputs
object[]
required

An array of PublicCampaignReadInput objects, each containing the ID of a campaign to be read. This property is required.

Response

successful operation

completedAt
string<date-time>
required

The date and time when the batch operation was completed, in ISO 8601 format.

results
object[]
required

An array of PublicCampaignWithAssets objects, representing the campaigns involved in the batch operation.

startedAt
string<date-time>
required

The date and time when the batch operation started, in ISO 8601 format.

status
enum<string>
required

The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'.

Available options:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

A map of link names to associated URIs, providing additional resources or documentation related to the batch operation.

requestedAt
string<date-time>

The date and time when the batch operation was requested, in ISO 8601 format.

Last modified on August 3, 2026