Get a campaign
https://email.growthdept.ai/api/campaigns/{id}Rate limits
Scopes
campaigns:read
Operation id
get_campaign The same operation as in Klaviyo's API. OpenAPI document
Path parameters
stringrequired
Query parameters
Pick values to add them to the request:
Pick values to add them to the request:
Pick values to add them to the request:
Pick values to add them to the request:
Pick values to add them to the request:
Headers
stringrequireddefault 2026-10-15
API revision, YYYY-MM-DD. This server implements 2026-10-15.
Responses
200Success
Response body
object
dataobjectrequired
data: 5 fields
typestringrequired
campaignidstringrequired
attributesobjectrequired
attributes: 3 fields
created_atstring (date-time)can be null
updated_atstring (date-time)can be null
definitionobjectrequired
definition: 6 fields
namestringcan be null
builderstringcan be null
archivedbooleancan be null
colorstringcan be null
descriptionstringcan be null
send_settingsobjectcan be null
send_settings: 5 fields
send_timezonestringcan be null
send_strategystringcan be null
content_variationcontent_variation_local_timezonepersonalized_send_time_optimizationsend_time_optimizationsimplethrottledtimezonevariationvariation_per_second_throttledvariation_send_timesend_passed_rltz_immediatelybooleancan be null
exit_condition_enabledbooleancan be null
exit_condition_conversion_metric_idstringcan be null
relationshipsobject
relationships: 3 fields
campaign-audiencesobject
campaign-audiences: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
campaign-audienceidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
campaign-messagesobject
campaign-messages: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
campaign-messageidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
tagsobject
tags: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
tagidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
linksobjectrequired
links: 1 field
selfstring (uri)required
includedarray of objects
One option: TagResponseObjectResource
typestringrequired
tagidstringrequired
attributesobjectrequired
attributes: 1 field
namestringrequired
relationshipsobject
relationships: 5 fields
tag-groupobject
tag-group: 2 fields
dataobject
data: 2 fields
typestringrequired
tag-groupidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
listsobject
lists: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
listidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
segmentsobject
segments: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
segmentidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
campaignsobject
campaigns: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
campaignidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
flowsobject
flows: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
flowidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
linksobjectrequired
links: 1 field
selfstring (uri)required
One option: MessageResponseObjectResource
typestringrequired
campaign-messageidstringrequired
attributesobjectrequired
attributes: 3 fields
createdstring (date-time)required
updatedstring (date-time)required
definitionobjectrequired
definition: 5 fields
namestringcan be null
statusstringcan be null
cancelleddraftscheduledsendingsenttracking_optionsobjectcan be null
tracking_options: 4 fields
is_add_utmbooleancan be null
is_tracking_clicksbooleancan be null
is_tracking_opensbooleancan be null
tracking_paramsarray of objectscan be null
One option: StaticMessageTrackingParam
typestring
staticnamestringrequired
valuestringrequired
One option: DynamicMessageTrackingParam
typestring
dynamicnamestringrequired
valuestringrequired
send_optionsobjectcan be null
send_options: 7 fields
send_timestring (date-time)can be null
send_timesobjectcan be null
send_strategystringcan be null
ab_send_time_testcontent_variationcontent_variation_local_timezonelocal_timezonepersonalized_send_time_optimizationsend_time_optimizationstaticthrottledvariation_per_second_throttledrecipient_percentageintegercan be null
throttling_typestringcan be null
nonethrottle-for-campaignsthrottle-for-campaigns-and-flowsthrottle-for-flowsthrottle_unitstringcan be null
hourminuteis_ignoring_unsubscribesbooleancan be null
ab_testobjectcan be null
ab_test: 3 fields
winner_metricstringcan be null
clicks_uniqueopens_uniqueplaced_orders_uniquewinner_percentageintegercan be null
winner_wait_hoursintegercan be null
relationshipsobject
relationships: 3 fields
campaignobject
campaign: 2 fields
dataobject
data: 2 fields
typestringrequired
campaignidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
campaign-audienceobject
campaign-audience: 2 fields
dataobject
data: 2 fields
typestringrequired
campaign-audienceidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
campaign-variationsobject
campaign-variations: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
campaign-variationidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
linksobjectrequired
links: 1 field
selfstring (uri)required
One option: AudienceResponseObjectResource
typestringrequired
campaign-audienceidstringrequired
attributesobjectrequired
attributes: 3 fields
createdstring (date-time)required
updatedstring (date-time)required
definitionobjectrequired
definition: 4 fields
namestringcan be null
includedarray of stringscan be null
excludedarray of stringscan be null
priorityintegercan be null
relationshipsobject
relationships: 2 fields
campaignobject
campaign: 2 fields
dataobject
data: 2 fields
typestringrequired
campaignidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
campaign-messagesobject
campaign-messages: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
campaign-messageidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
linksobjectrequired
links: 1 field
selfstring (uri)required
linksobject
links: 1 field
selfstring (uri)required
metaobject
4XXClient error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject
See status codes for each code.
5XXServer error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject