CampaignsVersion: v3New
Get Email Campaign by ID
GET/emails/locations/{locationId}/campaigns/emails/{campaignId}
Get a single email campaign by its ID
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
Scope:
emails/Auth methods:
OAuthPrivate IntegrationToken type:
Sub-Account TokenRequest
Headers
Versionstringrequired
API Version
Available options
v3Example:
v3Path Parameters
locationIdstringrequired
Location ID
Example:
ve9EPM428h8vShlRW1KTcampaignIdstringrequired
Campaign ID
Example:
67f15c2ae99226d5bcccb8f3Response
Success
idstringrequired
Campaign ID
Example:
67f15c2ae99226d5bcccb8f3sourcestring
Source of the campaign
Example:
email-campaignsourceIdstring
Source ID of the campaign
Example:
bulkRequest_abc123namestring
Campaign name
Example:
February Newsletterstatusstring
Campaign status
Available options
allsentfailedarchiveddraftprocessingscheduledcancelledpausedExample:
sentcampaignTypestring
Campaign delivery type
Example:
bulk-emailcampaignCategorystring
Campaign category
Example:
normalvariationsobject[]
AB test variation identifiers (available only for AB test campaigns)
editorTypestring
Original editor type the campaign was created with
Available options
htmlbuildertextExample:
htmlisPlainTextboolean
Whether the campaign uses plain text
Example:
falseeditorContentUrlstring
URL to fetch the rendered campaign content as HTML. Issue a GET against this URL to retrieve the body.
Example:
https://storage.googleapis.com/email-templates/abc123.htmlfromNamestring
Sender name
Example:
John Doesubjectstring
Email subject line
Example:
Welcome to our newsletterpreviewTextstring
Preview text
Example:
Check out our latest updatesdeletedbooleanrequired
Whether the campaign is deleted
Example:
falsecreatedAtstringrequired
Created at timestamp
Example:
2025-07-24T11:55:43.598ZupdatedAtstringrequired
Last updated timestamp
Example:
2026-02-09T04:49:12.322ZtraceIdstring
Trace ID of the request
Example:
019e4ef5-a65e-4198-8cf9-8e93dca9bda4