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

id
string<uuid>
required
Example:

"a7d4e2f1-08b3-4c65-9e7a-1b2c3d4e5f60"

Response

id
string<uuid>
required
Example:

"123e4567-e89b-12d3-a456-426614174000"

name
string
required
Example:

"Q4 Product Launch Outreach"

status
enum<string>
required
Available options:
draft,
scheduled,
active,
paused,
stopped,
completed,
failed
Example:

"draft"

schedule
object
required
settings
object
required
metrics
object
required
tags
object[]
required

Tags on this campaign - the same ones the list returns, and the same ids ?tags= filters by. Create and delete them in the dashboard. Campaign tags are a separate dictionary from mailbox tags, so the ids do not cross over.

createdAt
string<date-time>
required
Example:

"2026-07-11T08:00:00.000Z"

updatedAt
string<date-time>
required
Example:

"2026-07-11T10:30:00.000Z"

sequence
object[]

The email sequence steps - included on the detail view (GET /v1/campaigns/:id).

accounts
string[]

Attached SMTP account ids - included on the detail view.

Example: