Skip to main content
CampaignsVersion: v3New

Get Workflow Campaign by ID

GET/emails/locations/{locationId}/campaigns/workflows/{campaignId}

Get a single workflow campaign by its ID

Authorizations

Authorizationstringheaderrequired

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

Scope:emails/campaigns.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

locationIdstringrequired

Location ID

Example:ve9EPM428h8vShlRW1KT
campaignIdstringrequired

Campaign ID

Example:693bd14ea6b50a8df0180e9a

Response

Success

idstringrequired

Campaign ID

Example:693bd14ea6b50a8df0180e9a
namestring

Campaign name

Example:sorting workflow
statusstring

Campaign status

Available optionspublisheddraft
Example:published
sourcestring

Source of the campaign

Example:workflow
sourceIdstring

Source ID of the campaign

Example:115b9030-907c-474c-90a5-2debd838a024
subSourcesobject[]

Sub-sources (email-sending steps) within this workflow. Each entry's id can be passed as the subSourceId query parameter to the campaign stats endpoint to retrieve per-step stats.

deletedboolean

Whether the campaign is deleted

Example:false
createdAtstringrequired

Created at timestamp

Example:2025-12-12T08:24:46.700Z
updatedAtstringrequired

Updated at timestamp

Example:2026-01-23T05:58:48.453Z
traceIdstring

Trace ID of the request

Example:019e4ef5-a65e-4198-8cf9-8e93dca9bda4