Skip to main content
GET
Get a campaign

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaignId
string
required

The ID of the campaign.

Example:

"clc4m6n8p0q2r4s6t8u0v2x4"

Response

Successful.

id
string
required

The ID of the campaign.

Example:

"clc4m6n8p0q2r4s6t8u0v2x4"

name
string
required

The name of the campaign.

Example:

"Spring announcement"

status
enum<string>
required

The status of the campaign.

Available options:
Draft,
Scheduled,
Sending,
Sent
Example:

"Draft"

createdAt
string<date-time>
required

ISO 8601 timestamp for when the campaign was created.

Example:

"2025-06-29T07:47:39.370Z"

updatedAt
string<date-time>
required

ISO 8601 timestamp for when the campaign was last updated.

Example:

"2025-06-29T07:47:39.370Z"

emailMessageId
string | null
required

The associated email message ID.

Example:

"cle5f7g9h1i3j5k7l9m1n3p5"

campaignGroupId
string | null
required

The ID of the campaign group this campaign belongs to.

Example:

"clg7n5p3q1r9s7t5u3v1w9y7"

mailingListId
string | null
required

The ID of the mailing list this campaign sends to, if set.

Example:

"clm2k8j4h6g0f8d6s4a2b0z8"

audienceSegmentId
string | null
required

The ID of the audience segment this campaign targets, if set.

Example:

"cls6e8g0i2k4m6o8q0s2u4w6"

audienceFilter
object | null
required

The filter rules that define the audience for this campaign, if set.

scheduling
object
required

When the campaign is scheduled to send.

Example:
Last modified on July 20, 2026