Retrieve one campaign with its results (reach, responses, conversions and revenue) and the performance of each send step. Use Get campaign recipients for the per-recipient detail.
GET
/
api
/
public
/
outreach-campaign
/
{campaignId}
Get campaign
curl --request GET \ --url https://api.vambe.me/api/public/outreach-campaign/{campaignId} \ --header 'x-api-key: <x-api-key>'
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Welcome 👋","colors":{"primary":"#2563EB","light":"#93C5FD","dark":"#1E3A8A"},"logo":"https://mintcdn.com/vambe-f69d5806/_YFOlf0qgMJ8Che1/images/fb1a23e-small-Vambe_Logo_Panda-White4x.png?fit=max\u0026auto=format\u0026n=_YFOlf0qgMJ8Che1\u0026q=85\u0026s=c84b8be7abfa14dd8e1674a247b9cc0b","favicon":"https://mintcdn.com/vambe-f69d5806/_YFOlf0qgMJ8Che1/df9628f-small-2NorthAm_Ops.png?fit=max\u0026auto=format\u0026n=_YFOlf0qgMJ8Che1\u0026q=85\u0026s=5d02cd83d033a951fa6d8bce17f58e33","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","javascript","python"]}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vambe-f69d5806","hasAudioNarration":false,"actualSubdomain":"vambe-f69d5806","customDomains":["docs.vambe.me"],"gitSource":{"type":"github","owner":"vambeai","repo":"vambeai-backend","deployBranch":"main","contentDirectory":"public/documentation","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af62e1d015ac6c4e84aff07","clientVersion":"0.0.4124","searchFilterCounts":[{"language":"default","tag":"Messaging API","count":44},{"language":"default","tag":"CRM \u0026 Contacts","count":24},{"language":"default","tag":"Custom Ecommerce Apps","count":22},{"language":"default","tag":"Contact Management","count":16},{"language":"default","tag":"Webhooks","count":16},{"language":"default","tag":"Guides","count":12},{"language":"default","tag":"App management API","count":11},{"language":"default","tag":"Instagram Comment Automations","count":9},{"language":"default","tag":"Appointments","count":8},{"language":"default","tag":"Booking API","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"img.sidebar-group-icon[src$=\"/icons/notepad-text-dashed.svg\"]{background-color:currentColor!important;object-position:-9999px 0;-webkit-mask:url(\"/images/icons/notepad-text-dashed.svg\") center / contain no-repeat;mask:url(\"/images/icons/notepad-text-dashed.svg\") center / contain no-repeat}"}],"page":{"pagePath":"reference/campaigns/get-campaign","slug":"/reference/campaigns/get-campaign","pageMetadata":{"title":"Get campaign","openapi":"get /api/public/outreach-campaign/{campaignId}","description":"Retrieve one campaign with its results (reach, responses, conversions and revenue) and the performance of each send step. Use Get campaign recipients for the per-recipient detail.","href":"/reference/campaigns/get-campaign"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve one campaign with its results (reach, responses, conversions and revenue) and the performance of each send step. Use Get campaign recipients for the per-recipient detail.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get campaign","openapi":"get /api/public/outreach-campaign/{campaignId}","description":"Retrieve one campaign with its results (reach, responses, conversions and revenue) and the performance of each send step. Use Get campaign recipients for the per-recipient detail.","href":"/reference/campaigns/get-campaign"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"PublicCampaignController_getCampaign","summary":"Get campaign","description":"Retrieve one campaign with its results (reach, responses, conversions and revenue) and the performance of each send step. Use Get campaign recipients for the per-recipient detail.","parameters":["53b0b2c9-8863-4e5b-b1a4-ad0f0bbb4fbb","b09f6fc0-0caa-4915-bbc7-fc6c3006a554"],"responses":{"200":"4022c988-b35b-4a46-97b0-e91f45ca8b19","404":"fc38053a-a586-4c01-98fc-15b83026e346"},"tags":["Campaigns"],"method":"get","type":"path","servers":["02ff634b-bead-4bab-a088-7dd8b9769625"],"security":[],"path":"/api/public/outreach-campaign/{campaignId}","baseUrlOptions":["https://api.vambe.me"],"title":"Get campaign","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"53b0b2c9-8863-4e5b-b1a4-ad0f0bbb4fbb":{"name":"x-api-key","in":"header","description":"API key needed to authorize the request","required":true,"schema":{"type":"string","isRequired":true,"description":"API key needed to authorize the request","uniqueKey":"","typeLabel":"string"}},"b09f6fc0-0caa-4915-bbc7-fc6c3006a554":{"name":"campaignId","required":true,"in":"path","description":"The ID of the campaign, from List campaigns","schema":{"format":"uuid","type":"string","isRequired":true,"description":"The ID of the campaign, from List campaigns","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"4022c988-b35b-4a46-97b0-e91f45ca8b19":{"description":"Campaign retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"format":"uuid","type":"string","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","example":"Autocash Septiembre","uniqueKey":"name","typeLabel":"string"},"status":{"type":"string","enum":["draft","active","paused","archived","awaiting_approval","failed"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"campaign_type":{"type":"string","enum":["one_time"],"uniqueKey":"campaign_type","typeLabel":"enum\u003cstring>"},"kpi_event":{"oneOf":[{"type":"object","description":"The conversion goal of the campaign","properties":{"key":{"type":"string","example":"order_created","uniqueKey":"kpi_event.oneOf.0.key","typeLabel":"string"},"stage_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"kpi_event.oneOf.0.stage_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"kpi_event.oneOf.0.stage_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"kpi_event.oneOf.0.stage_id","typeLabel":"string\u003cuuid> | null"}},"uniqueKey":"kpi_event.oneOf.0","typeLabel":"object"},{"type":"null","description":"The conversion goal of the campaign","properties":{"key":{"type":"string","example":"order_created"},"stage_id":{"oneOf":[{"type":"string","format":"uuid"},{"type":"null","format":"uuid"}]}},"uniqueKey":"kpi_event.oneOf.1","typeLabel":"null"}],"uniqueKey":"kpi_event","typeLabel":"object | null"},"audience":{"type":"object","properties":{"status":{"type":"string","uniqueKey":"audience.status","typeLabel":"string"},"source":{"oneOf":[{"type":"string","uniqueKey":"audience.source.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"audience.source.oneOf.1","typeLabel":"null"}],"uniqueKey":"audience.source","typeLabel":"string | null"},"segment":{"oneOf":[{"type":"object","properties":{"id":{"format":"uuid","type":"string","uniqueKey":"audience.segment.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","uniqueKey":"audience.segment.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"audience.segment.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"format":"uuid","type":"string"},"name":{"type":"string"}},"uniqueKey":"audience.segment.oneOf.1","typeLabel":"null"}],"uniqueKey":"audience.segment","typeLabel":"object | null"},"size":{"type":"integer","description":"Number of recipients","uniqueKey":"audience.size","typeLabel":"integer"}},"uniqueKey":"audience","typeLabel":"object"},"lifecycle":{"type":"string","enum":["notSent","inProcess","finished"],"uniqueKey":"lifecycle","typeLabel":"enum\u003cstring>"},"delivery":{"type":"object","properties":{"not_started":{"type":"integer","uniqueKey":"delivery.not_started","typeLabel":"integer"},"running":{"type":"integer","uniqueKey":"delivery.running","typeLabel":"integer"},"finished":{"type":"integer","uniqueKey":"delivery.finished","typeLabel":"integer"},"last_batch_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"delivery.last_batch_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"delivery.last_batch_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"delivery.last_batch_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"delivery","typeLabel":"object"},"created_at":{"format":"date-time","type":"string","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"front_url":{"type":"string","description":"Link to the campaign in Vambe","uniqueKey":"front_url","typeLabel":"string"},"first_batch_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"first_batch_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"first_batch_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"first_batch_at","typeLabel":"string\u003cdate-time> | null"},"results":{"type":"object","properties":{"audience":{"type":"integer","description":"Number of recipients","uniqueKey":"results.audience","typeLabel":"integer"},"dispatched":{"type":"integer","uniqueKey":"results.dispatched","typeLabel":"integer"},"reached":{"type":"integer","description":"Recipients at least one step reached","uniqueKey":"results.reached","typeLabel":"integer"},"failed":{"type":"integer","uniqueKey":"results.failed","typeLabel":"integer"},"system_errors":{"type":"integer","uniqueKey":"results.system_errors","typeLabel":"integer"},"reach_breakdown":{"type":"object","properties":{"full":{"type":"integer","uniqueKey":"results.reach_breakdown.full","typeLabel":"integer"},"partial":{"type":"integer","uniqueKey":"results.reach_breakdown.partial","typeLabel":"integer"},"none":{"type":"integer","uniqueKey":"results.reach_breakdown.none","typeLabel":"integer"},"stopped":{"type":"integer","uniqueKey":"results.reach_breakdown.stopped","typeLabel":"integer"}},"uniqueKey":"results.reach_breakdown","typeLabel":"object"},"responded":{"type":"object","properties":{"count":{"type":"integer","uniqueKey":"results.responded.count","typeLabel":"integer"},"rate":{"oneOf":[{"type":"number","description":"Over reached recipients","uniqueKey":"results.responded.rate.oneOf.0","typeLabel":"number"},{"type":"null","description":"Over reached recipients","uniqueKey":"results.responded.rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.responded.rate","typeLabel":"number | null"},"median_seconds":{"oneOf":[{"type":"number","description":"Median time from the send to the first response","uniqueKey":"results.responded.median_seconds.oneOf.0","typeLabel":"number"},{"type":"null","description":"Median time from the send to the first response","uniqueKey":"results.responded.median_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.responded.median_seconds","typeLabel":"number | null"},"by_channel":{"type":"array","items":{"type":"object","properties":{"channel":{"type":"string","uniqueKey":"results.responded.by_channel.items.[INDEX].channel","typeLabel":"string"},"count":{"type":"integer","uniqueKey":"results.responded.by_channel.items.[INDEX].count","typeLabel":"integer"}},"uniqueKey":"results.responded.by_channel.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results.responded.by_channel","typeLabel":"object[]"}},"uniqueKey":"results.responded","typeLabel":"object"},"converted":{"oneOf":[{"type":"object","description":"Null when the campaign has no conversion goal","properties":{"event":{"type":"object","properties":{"key":{"type":"string","example":"order_created","uniqueKey":"results.converted.oneOf.0.event.key","typeLabel":"string"},"stage_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"results.converted.oneOf.0.event.stage_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"results.converted.oneOf.0.event.stage_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.converted.oneOf.0.event.stage_id","typeLabel":"string\u003cuuid> | null"}},"uniqueKey":"results.converted.oneOf.0.event","typeLabel":"object"},"count":{"type":"integer","uniqueKey":"results.converted.oneOf.0.count","typeLabel":"integer"},"rate":{"oneOf":[{"type":"number","description":"Over reached recipients","uniqueKey":"results.converted.oneOf.0.rate.oneOf.0","typeLabel":"number"},{"type":"null","description":"Over reached recipients","uniqueKey":"results.converted.oneOf.0.rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.converted.oneOf.0.rate","typeLabel":"number | null"},"median_seconds":{"oneOf":[{"type":"number","uniqueKey":"results.converted.oneOf.0.median_seconds.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"results.converted.oneOf.0.median_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.converted.oneOf.0.median_seconds","typeLabel":"number | null"},"revenue":{"oneOf":[{"type":"object","properties":{"value":{"type":"number","uniqueKey":"results.converted.oneOf.0.revenue.oneOf.0.value","typeLabel":"number"},"currency":{"oneOf":[{"type":"string","uniqueKey":"results.converted.oneOf.0.revenue.oneOf.0.currency.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"results.converted.oneOf.0.revenue.oneOf.0.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.converted.oneOf.0.revenue.oneOf.0.currency","typeLabel":"string | null"},"average_order_value":{"type":"number","uniqueKey":"results.converted.oneOf.0.revenue.oneOf.0.average_order_value","typeLabel":"number"}},"uniqueKey":"results.converted.oneOf.0.revenue.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"value":{"type":"number"},"currency":{"oneOf":[{"type":"string"},{"type":"null"}]},"average_order_value":{"type":"number"}},"uniqueKey":"results.converted.oneOf.0.revenue.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.converted.oneOf.0.revenue","typeLabel":"object | null"},"direct":{"type":"object","description":"Conversions attributed directly to the campaign","properties":{"count":{"type":"integer","uniqueKey":"results.converted.oneOf.0.direct.count","typeLabel":"integer"},"revenue":{"type":"number","uniqueKey":"results.converted.oneOf.0.direct.revenue","typeLabel":"number"}},"uniqueKey":"results.converted.oneOf.0.direct","typeLabel":"object"}},"uniqueKey":"results.converted.oneOf.0","typeLabel":"object"},{"type":"null","description":"Null when the campaign has no conversion goal","properties":{"event":{"type":"object","properties":{"key":{"type":"string","example":"order_created"},"stage_id":{"oneOf":[{"type":"string","format":"uuid"},{"type":"null","format":"uuid"}]}}},"count":{"type":"integer"},"rate":{"oneOf":[{"type":"number","description":"Over reached recipients"},{"type":"null","description":"Over reached recipients"}]},"median_seconds":{"oneOf":[{"type":"number"},{"type":"null"}]},"revenue":{"oneOf":[{"type":"object","properties":{"value":{"type":"number"},"currency":{"oneOf":[{"type":"string"},{"type":"null"}]},"average_order_value":{"type":"number"}}},{"type":"null","properties":{"value":{"type":"number"},"currency":{"oneOf":[{"type":"string"},{"type":"null"}]},"average_order_value":{"type":"number"}}}]},"direct":{"type":"object","description":"Conversions attributed directly to the campaign","properties":{"count":{"type":"integer"},"revenue":{"type":"number"}}}},"uniqueKey":"results.converted.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.converted","typeLabel":"object | null"}},"uniqueKey":"results","typeLabel":"object"},"steps":{"type":"array","description":"Performance of each send step, in campaign order","items":{"type":"object","properties":{"node_id":{"format":"uuid","type":"string","uniqueKey":"steps.items.[INDEX].node_id","typeLabel":"string\u003cuuid>"},"step_number":{"type":"integer","description":"Position among the campaign send steps","uniqueKey":"steps.items.[INDEX].step_number","typeLabel":"integer"},"kind":{"type":"string","example":"send-template","uniqueKey":"steps.items.[INDEX].kind","typeLabel":"string"},"name":{"oneOf":[{"type":"string","uniqueKey":"steps.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"steps.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].name","typeLabel":"string | null"},"channel":{"oneOf":[{"type":"string","enum":["whatsapp","email","voice"],"uniqueKey":"steps.items.[INDEX].channel.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["whatsapp","email","voice"],"uniqueKey":"steps.items.[INDEX].channel.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].channel","typeLabel":"enum\u003cstring> | null"},"counts":{"type":"object","description":"Recipients per step status","properties":{"pending":{"type":"integer","uniqueKey":"steps.items.[INDEX].counts.pending","typeLabel":"integer"},"ongoing":{"type":"integer","uniqueKey":"steps.items.[INDEX].counts.ongoing","typeLabel":"integer"},"succeeded":{"type":"integer","uniqueKey":"steps.items.[INDEX].counts.succeeded","typeLabel":"integer"},"skipped":{"type":"integer","uniqueKey":"steps.items.[INDEX].counts.skipped","typeLabel":"integer"},"failed":{"type":"integer","uniqueKey":"steps.items.[INDEX].counts.failed","typeLabel":"integer"}},"uniqueKey":"steps.items.[INDEX].counts","typeLabel":"object"},"reached":{"type":"integer","description":"Recipients this step reached","uniqueKey":"steps.items.[INDEX].reached","typeLabel":"integer"},"responded_after":{"type":"integer","description":"Recipients who responded between this step and the next one, counted on every step they responded after","uniqueKey":"steps.items.[INDEX].responded_after","typeLabel":"integer"},"converted_after":{"type":"integer","description":"Recipients whose conversion followed this step","uniqueKey":"steps.items.[INDEX].converted_after","typeLabel":"integer"},"opted_out":{"oneOf":[{"type":"integer","description":"Null when the step has no opt-out button","uniqueKey":"steps.items.[INDEX].opted_out.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Null when the step has no opt-out button","uniqueKey":"steps.items.[INDEX].opted_out.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].opted_out","typeLabel":"integer | null"},"failures":{"type":"array","items":{"type":"object","properties":{"reason":{"oneOf":[{"type":"string","uniqueKey":"steps.items.[INDEX].failures.items.[INDEX].reason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"steps.items.[INDEX].failures.items.[INDEX].reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].failures.items.[INDEX].reason","typeLabel":"string | null"},"recipients":{"type":"integer","uniqueKey":"steps.items.[INDEX].failures.items.[INDEX].recipients","typeLabel":"integer"},"level":{"oneOf":[{"type":"string","enum":["system","delivery"],"uniqueKey":"steps.items.[INDEX].failures.items.[INDEX].level.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["system","delivery"],"uniqueKey":"steps.items.[INDEX].failures.items.[INDEX].level.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].failures.items.[INDEX].level","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"steps.items.[INDEX].failures.items.[INDEX]","typeLabel":"object"},"uniqueKey":"steps.items.[INDEX].failures","typeLabel":"object[]"},"skips":{"type":"array","items":{"type":"object","properties":{"reason":{"oneOf":[{"type":"string","uniqueKey":"steps.items.[INDEX].skips.items.[INDEX].reason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"steps.items.[INDEX].skips.items.[INDEX].reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].skips.items.[INDEX].reason","typeLabel":"string | null"},"recipients":{"type":"integer","uniqueKey":"steps.items.[INDEX].skips.items.[INDEX].recipients","typeLabel":"integer"}},"uniqueKey":"steps.items.[INDEX].skips.items.[INDEX]","typeLabel":"object"},"uniqueKey":"steps.items.[INDEX].skips","typeLabel":"object[]"},"email":{"type":"object","description":"Email steps only","properties":{"sent":{"type":"integer","uniqueKey":"steps.items.[INDEX].email.sent","typeLabel":"integer"},"delivered":{"type":"integer","uniqueKey":"steps.items.[INDEX].email.delivered","typeLabel":"integer"},"opened":{"type":"integer","uniqueKey":"steps.items.[INDEX].email.opened","typeLabel":"integer"},"clicked":{"type":"integer","uniqueKey":"steps.items.[INDEX].email.clicked","typeLabel":"integer"},"bounced":{"type":"integer","uniqueKey":"steps.items.[INDEX].email.bounced","typeLabel":"integer"},"dropped":{"type":"integer","uniqueKey":"steps.items.[INDEX].email.dropped","typeLabel":"integer"},"spam_reported":{"type":"integer","uniqueKey":"steps.items.[INDEX].email.spam_reported","typeLabel":"integer"},"unsubscribed":{"type":"integer","uniqueKey":"steps.items.[INDEX].email.unsubscribed","typeLabel":"integer"}},"uniqueKey":"steps.items.[INDEX].email","typeLabel":"object"},"voice":{"type":"object","description":"Voice steps only","properties":{"calls_made":{"type":"integer","uniqueKey":"steps.items.[INDEX].voice.calls_made","typeLabel":"integer"},"answered":{"type":"integer","uniqueKey":"steps.items.[INDEX].voice.answered","typeLabel":"integer"},"reached_human":{"type":"integer","uniqueKey":"steps.items.[INDEX].voice.reached_human","typeLabel":"integer"},"objective_achieved":{"type":"integer","uniqueKey":"steps.items.[INDEX].voice.objective_achieved","typeLabel":"integer"},"average_duration_seconds":{"oneOf":[{"type":"number","uniqueKey":"steps.items.[INDEX].voice.average_duration_seconds.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"steps.items.[INDEX].voice.average_duration_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].voice.average_duration_seconds","typeLabel":"number | null"},"total_duration_seconds":{"type":"number","uniqueKey":"steps.items.[INDEX].voice.total_duration_seconds","typeLabel":"number"},"status_breakdown":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","uniqueKey":"steps.items.[INDEX].voice.status_breakdown.items.[INDEX].status","typeLabel":"string"},"count":{"type":"integer","uniqueKey":"steps.items.[INDEX].voice.status_breakdown.items.[INDEX].count","typeLabel":"integer"}},"uniqueKey":"steps.items.[INDEX].voice.status_breakdown.items.[INDEX]","typeLabel":"object"},"uniqueKey":"steps.items.[INDEX].voice.status_breakdown","typeLabel":"object[]"},"goal":{"type":"object","properties":{"yes":{"type":"integer","uniqueKey":"steps.items.[INDEX].voice.goal.yes","typeLabel":"integer"},"no":{"type":"integer","uniqueKey":"steps.items.[INDEX].voice.goal.no","typeLabel":"integer"},"partial":{"type":"integer","uniqueKey":"steps.items.[INDEX].voice.goal.partial","typeLabel":"integer"}},"uniqueKey":"steps.items.[INDEX].voice.goal","typeLabel":"object"}},"uniqueKey":"steps.items.[INDEX].voice","typeLabel":"object"}},"uniqueKey":"steps.items.[INDEX]","typeLabel":"object"},"uniqueKey":"steps","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"Autocash Septiembre","status":"draft","campaign_type":"one_time","kpi_event":{"key":"order_created","stage_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"audience":{"status":"\u003cstring>","source":"\u003cstring>","segment":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>"},"size":123},"lifecycle":"notSent","delivery":{"not_started":123,"running":123,"finished":123,"last_batch_at":"2023-11-07T05:31:56Z"},"created_at":"2023-11-07T05:31:56Z","front_url":"\u003cstring>","first_batch_at":"2023-11-07T05:31:56Z","results":{"audience":123,"dispatched":123,"reached":123,"failed":123,"system_errors":123,"reach_breakdown":{"full":123,"partial":123,"none":123,"stopped":123},"responded":{"count":123,"rate":123,"median_seconds":123,"by_channel":[{"channel":"\u003cstring>","count":123}]},"converted":{"event":{"key":"order_created","stage_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"count":123,"rate":123,"median_seconds":123,"revenue":{"value":123,"currency":"\u003cstring>","average_order_value":123},"direct":{"count":123,"revenue":123}}},"steps":[{"node_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","step_number":123,"kind":"send-template","name":"\u003cstring>","channel":"whatsapp","counts":{"pending":123,"ongoing":123,"succeeded":123,"skipped":123,"failed":123},"reached":123,"responded_after":123,"converted_after":123,"opted_out":123,"failures":[{"reason":"\u003cstring>","recipients":123,"level":"system"}],"skips":[{"reason":"\u003cstring>","recipients":123}],"email":{"sent":123,"delivered":123,"opened":123,"clicked":123,"bounced":123,"dropped":123,"spam_reported":123,"unsubscribed":123},"voice":{"calls_made":123,"answered":123,"reached_human":123,"objective_achieved":123,"average_duration_seconds":123,"total_duration_seconds":123,"status_breakdown":[{"status":"\u003cstring>","count":123}],"goal":{"yes":123,"no":123,"partial":123}}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"fc38053a-a586-4c01-98fc-15b83026e346":{"description":"Campaign not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{},"servers":{"02ff634b-bead-4bab-a088-7dd8b9769625":{"url":"https://api.vambe.me","description":"Production Server"}}},"originalFileLocation":"openapi.json"},"subdomain":"vambe-f69d5806","siteName":"Welcome 👋","title":"Get campaign - Welcome 👋","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-14T19:14:07.630Z","originalFileLocation":"reference/campaigns/get-campaign.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve one campaign with its results (reach, responses, conversions and revenue) and the performance of each send step. Use Get campaign recipients for the per-recipient detail.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Welcome 👋\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vambe-f69d5806/FNR-14vKPkm5-pk-/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/vambe-f69d5806/FNR-14vKPkm5-pk-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vambe-f69d5806/FNR-14vKPkm5-pk-/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/vambe-f69d5806/FNR-14vKPkm5-pk-/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/vambe-f69d5806/FNR-14vKPkm5-pk-/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vambe-f69d5806/FNR-14vKPkm5-pk-/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vambe-f69d5806/FNR-14vKPkm5-pk-/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/vambe-f69d5806/FNR-14vKPkm5-pk-/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/vambe-f69d5806/FNR-14vKPkm5-pk-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get campaign - Welcome 👋\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve one campaign with its results (reach, responses, conversions and revenue) and the performance of each send step. Use Get campaign recipients for the per-recipient detail.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Welcome 👋\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.vambe.me/reference/campaigns/get-campaign\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vambe-f69d5806.mintlify.site/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=Get+campaign\u0026amp;description=Retrieve+one+campaign+with+its+results+%28reach%2C+responses%2C+conversions+and+revenue%29+and+the+performance+of+each+send+step.+Use+Get+campaign+recipients+for+the+pe\u0026amp;theme=9b7d6b35278e9470f56611a6\u0026amp;signature=0b0f0cd3e8f64562fadb48d47d1eaaa95fff271fe5532e3b4fe9c6dba9b6f463\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get campaign - Welcome 👋\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve one campaign with its results (reach, responses, conversions and revenue) and the performance of each send step. Use Get campaign recipients for the per-recipient detail.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vambe-f69d5806.mintlify.site/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=Get+campaign\u0026amp;description=Retrieve+one+campaign+with+its+results+%28reach%2C+responses%2C+conversions+and+revenue%29+and+the+performance+of+each+send+step.+Use+Get+campaign+recipients+for+the+pe\u0026amp;theme=9b7d6b35278e9470f56611a6\u0026amp;signature=0b0f0cd3e8f64562fadb48d47d1eaaa95fff271fe5532e3b4fe9c6dba9b6f463\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/vambe-f69d5806/FNR-14vKPkm5-pk-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Welcome 👋\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.vambe.me/reference/campaigns/get-campaign\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/campaigns/get-campaign.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.vambe.me/#organization\",\"name\":\"Welcome 👋\",\"url\":\"https://docs.vambe.me\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vambe-f69d5806/_YFOlf0qgMJ8Che1/images/fb1a23e-small-Vambe_Logo_Panda-White4x.png?fit=max\u0026auto=format\u0026n=_YFOlf0qgMJ8Che1\u0026q=85\u0026s=c84b8be7abfa14dd8e1674a247b9cc0b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.vambe.me#website\",\"name\":\"Welcome 👋\",\"url\":\"https://docs.vambe.me\",\"publisher\":{\"@id\":\"https://docs.vambe.me/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.vambe.me/reference/campaigns/get-campaign#webpage\",\"url\":\"https://docs.vambe.me/reference/campaigns/get-campaign\",\"name\":\"Get campaign\",\"description\":\"Retrieve one campaign with its results (reach, responses, conversions and revenue) and the performance of each send step. Use Get campaign recipients for the per-recipient detail.\",\"dateModified\":\"2026-10-14T19:14:07.630Z\",\"isPartOf\":{\"@id\":\"https://docs.vambe.me#website\"},\"breadcrumb\":{\"@id\":\"https://docs.vambe.me/reference/campaigns/get-campaign#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.vambe.me/reference/campaigns/get-campaign#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Campaigns\",\"item\":\"https://docs.vambe.me/reference/campaigns/create-campaign\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get campaign\",\"item\":\"https://docs.vambe.me/reference/campaigns/get-campaign\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.vambe.me/reference/campaigns/get-campaign#apireference\",\"headline\":\"Get campaign\",\"name\":\"Get campaign\",\"description\":\"Retrieve one campaign with its results (reach, responses, conversions and revenue) and the performance of each send step. Use Get campaign recipients for the per-recipient detail.\",\"url\":\"https://docs.vambe.me/reference/campaigns/get-campaign\",\"mainEntityOfPage\":{\"@id\":\"https://docs.vambe.me/reference/campaigns/get-campaign#webpage\"},\"dateModified\":\"2026-10-14T19:14:07.630Z\",\"publisher\":{\"@id\":\"https://docs.vambe.me/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.vambe.me#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Welcome 👋\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Welcome 👋\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/reference/campaigns/get-campaign.md","siteName":"Welcome 👋","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":"/docs/quickstart"}]},{"tab":"Messaging API","icon":"messages","groups":[{"group":"Campaigns","icon":"bullhorn","expanded":false,"pages":[{"title":"Create campaign","openapi":"post /api/public/outreach-campaign","href":"/reference/campaigns/create-campaign"},{"title":"List campaigns","openapi":"get /api/public/outreach-campaign","description":"List your one-time campaigns, newest first, with their status, audience and delivery progress.","href":"/reference/campaigns/get-campaigns"},{"title":"Get campaign","openapi":"get /api/public/outreach-campaign/{campaignId}","href":"/reference/campaigns/get-campaign"},{"title":"Get campaign recipients","openapi":"get /api/public/outreach-campaign/{campaignId}/recipients","description":"Retrieve a campaign's recipients a page at a time: who was reached, who responded or converted and, for every send step, the per-message outcome (delivered, read, failed and why, buttons pressed, email status, call result).","href":"/reference/campaigns/get-campaign-recipients"},{"title":"List a contact's campaigns","openapi":"get /api/public/outreach-campaign/by-contact/{contactId}","href":"/reference/campaigns/list-contact-campaigns"}]},{"group":"Meta Templates","icon":"https://mintlify.s3.us-west-1.amazonaws.com/vambe-f69d5806/images/icons/notepad-text-dashed.svg","expanded":false,"pages":[{"title":"List Meta templates","openapi":"get /api/public/templates","href":"/reference/templates/get-whatsapp-templates"}]},{"group":"WhatsApp Messages","icon":"whatsapp","expanded":false,"pages":[{"title":"Schedule a WhatsApp Template Message","openapi":"post /api/public/whatsapp/message/programmed/create","href":"/reference/whatsapp-message/send-a-program-a-template-message-to-send-at-a-specific-time"},{"title":"Send WhatsApp Template (Body-based v2)","openapi":"post /api/public/whatsapp/message/send","href":"/reference/whatsapp-message/send-a-template-message-1"},{"title":"Send a free-form WhatsApp session message","openapi":"post /api/public/whatsapp/message/session","href":"/reference/whatsapp-message/send-a-free-form-whatsapp-session-message"},{"title":"Send WhatsApp Smart Template (Unstructured Data, Single Recipient)","openapi":"post /api/public/whatsapp/message/send/template/{templateId}","href":"/reference/whatsapp-message/send-a-template-message-with-unstructured-data"},{"title":"Send WhatsApp Smart Template to Many (Bulk, Unstructured Data)","openapi":"post /api/public/whatsapp/message/send/template/{templateId}/many","href":"/reference/whatsapp-message/send-a-template-message-with-unstructured-data-1"},{"title":"Get WhatsApp Message Delivery Status","openapi":"get /api/public/whatsapp/message/status/{messageId}","href":"/reference/whatsapp-message/get-the-delivery-status-of-a-sent-message"},{"title":"Cancel Scheduled WhatsApp Message","openapi":"delete /api/public/whatsapp/message/programmed/{scheduleMessageId}/cancel","href":"/reference/whatsapp-message/cancel-a-programmed-message-by-scheduled-message-id"},{"title":"Send WhatsApp Template by Phone and Template ID","openapi":"post /api/public/whatsapp/message/send/{phone}/template/{templateId}","href":"/reference/whatsapp-message/send-a-template-message"}]},{"group":"WhatsApp Flows","icon":"diagram-project","expanded":false,"pages":[{"title":"List WhatsApp Flows","openapi":"get /api/public/whatsapp-flows","href":"/reference/whatsapp-flows/list-whatsapp-flows"},{"title":"List responses of a WhatsApp Flow","openapi":"get /api/public/whatsapp-flows/{flowId}/responses","href":"/reference/whatsapp-flows/list-responses-of-a-whatsapp-flow"}]},{"group":"WhatsApp QR Messages","icon":"qrcode","expanded":false,"pages":[{"title":"Send Web WhatsApp Message (Unstructured)","openapi":"post /api/public/web-whatsapp-message/send/{phoneId}/message","href":"/reference/publicweb-whatsapp-message/send-a-message"}]},{"group":"Email","icon":"envelope","expanded":false,"pages":[{"title":"List email channels","openapi":"get /api/public/email-channel","href":"/reference/email-channel/list-email-channels"},{"title":"Create an email channel","openapi":"post /api/public/email-channel","href":"/reference/email-channel/create-an-email-channel"},{"title":"Get DNS records for a channel","openapi":"get /api/public/email-channel/dns-records/{id}","href":"/reference/email-channel/get-dns-records-for-a-channel"},{"title":"Get a single email channel","openapi":"get /api/public/email-channel/{id}","href":"/reference/email-channel/get-a-single-email-channel"},{"title":"Verify domain DNS","openapi":"post /api/public/email-channel/verify/{id}","href":"/reference/email-channel/verify-domain-dns"},{"title":"Delete an email channel","openapi":"delete /api/public/email-channel/{id}","href":"/reference/email-channel/delete-an-email-channel"},{"openapi":"post /api/public/email/send","title":"Send an email","href":"/reference/email/send-an-email"}]},{"group":"Instagram Comment Automations","icon":"instagram","expanded":false,"pages":[{"title":"List connected Instagram accounts","openapi":"get /api/public/instagram/accounts","href":"/reference/instagram-comment-automations/list-connected-instagram-accounts"},{"title":"List pipeline stages","openapi":"get /api/public/instagram/stages","href":"/reference/instagram-comment-automations/list-pipeline-stages"},{"title":"List comment automations","openapi":"get /api/public/instagram/accounts/{instagramAccountId}/automations","href":"/reference/instagram-comment-automations/list-comment-automations"},{"title":"List posts of an Instagram account","openapi":"get /api/public/instagram/accounts/{instagramAccountId}/posts","href":"/reference/instagram-comment-automations/list-posts-of-an-instagram-account"},{"title":"Get a comment automation by id","openapi":"get /api/public/instagram/automations/{id}","href":"/reference/instagram-comment-automations/get-a-comment-automation-by-id"},{"title":"Create a comment automation","openapi":"post /api/public/instagram/accounts/{instagramAccountId}/automations","href":"/reference/instagram-comment-automations/create-a-comment-automation"},{"title":"Update a comment automation","openapi":"put /api/public/instagram/automations/{id}","href":"/reference/instagram-comment-automations/update-a-comment-automation"},{"title":"Delete a comment automation","openapi":"delete /api/public/instagram/automations/{id}","href":"/reference/instagram-comment-automations/delete-a-comment-automation"},{"title":"List execution history for a post","openapi":"get /api/public/instagram/accounts/{instagramAccountId}/posts/{postId}/history","href":"/reference/instagram-comment-automations/list-execution-history-for-a-post"}]},{"group":"Tickets","icon":"ticket","expanded":false,"pages":[{"openapi":"post /api/public/ticket/amount","title":"Update the amount of a ticket","href":"/reference/ticket/update-ticket-amount"},{"openapi":"post /api/public/ticket/metadata","title":"Update metadata of a ticket","href":"/reference/ticket/update-ticket-metadata"},{"openapi":"post /api/public/ticket/close/contact/{contactId}","title":"Close a ticket","href":"/reference/ticket/close-a-ticket"},{"openapi":"post /api/public/ticket/open/web-whatsapp/{phoneId}","title":"Open a new ticket for web whatsapp","href":"/reference/ticket/open-ticket-web-whatsapp"},{"openapi":"post /api/public/ticket/open/whatsapp/{phoneId}","title":"Open a new ticket for whatsapp","href":"/reference/ticket/open-ticket-whatsapp"}]},{"group":"Channels Management","icon":"globe","expanded":false,"pages":[{"openapi":"get /api/public/channels/{channelType}","title":"Retrieve channel by type","href":"/reference/channels/retrieve-channel-by-type"},{"openapi":"post /api/public/channels/{channelType}/{platformIdentifier}/tags","title":"Create tags for a contact","href":"/reference/tags/create-tags-by-channel"}]},{"group":"Deprecated","icon":"clock","expanded":false,"pages":[{"title":"Send WhatsApp Note Message (Deprecated)","openapi":"post /api/public/whatsapp/message/note/send","href":"/reference/whatsapp-message/send-a-note-message"},{"title":"Get outreach campaign fields for a contact (Deprecated)","openapi":"get /api/public/outreach-campaign/recipients/by-contact/{contactId}","href":"/reference/outreach-campaigns/get-outreach-campaign-fields-for-a-contact"}]},{"group":"Removed","icon":"ban","expanded":false,"pages":[{"title":"List campaigns (Removed)","openapi":"get /api/public/campaign","href":"/reference/campaigns/legacy-list-campaigns"},{"title":"Get contacts sent in a campaign (Removed)","openapi":"get /api/public/campaign/contacts/{campaignId}","href":"/reference/campaigns/legacy-get-campaign-contacts"}]}]},{"tab":"CRM \u0026 Contacts","icon":"users","pages":[{"title":"CRM \u0026 Contacts","href":"/reference/contact/get-contacts-by-days"}]},{"tab":"Analytics \u0026 Reports","icon":"chart-line","pages":[{"title":"Analytics \u0026 Reports","href":"/reference/utm-events/create-custom-utm-event"}]},{"tab":"Knowledge Base","icon":"book-open","pages":[{"title":"Knowledge Base","href":"/reference/knowledge-base/get-folders"}]},{"tab":"Ecommerce","icon":"box","pages":[{"title":"Ecommerce","href":"/reference/product/get-product-blocks"}]},{"tab":"Appointments","icon":"calendar","pages":[{"title":"Appointments","href":"/reference/booking-url/get-api-public-booking-url-urlname"}]},{"tab":"Events","icon":"bolt","pages":[{"title":"Events","href":"/reference/events-api/ingest-a-customer-event"}]},{"tab":"Webhooks","icon":"webhook","pages":[{"title":"Webhooks","href":"/reference/webhooks/get-all-webhooks-for-the-authenticated-user"}]},{"tab":"Tasks","icon":"list-check","pages":[{"title":"Tasks","href":"/reference/tasks/get-tasks"}]},{"tab":"Custom Ecommerce Apps","icon":"puzzle-piece","pages":[{"title":"Custom Ecommerce Apps","href":"/docs/app-platform/introduction"}]}]},"basePath":"","title":"Get campaign - Welcome 👋","buildId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","deploymentId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CDiBsYGW.js","utils-KF9rPlmF.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C26urKTX.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BdjmJAC1.js","snippetPresets-3IpDBjt3.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-D4x_2vvo.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BIWdc5Pa.js","shallow-LQqfiMNd.js","getApiPlaygroundDisplay-DryzlOZG.js","CodeSnippet-tcJujU4r.js","CodeSnippets-BHp0nVLL.js","Page-1CZdsdAn.js","getPastedJson-DU-1ayUv.js","icon-CZK2hPr4.js","MethodPill-DOaqmTFC.js","DuplicateIcon-B5-nUxxl.js","createIcon-CDP_U77G.js","DynamicMarkdown-GHvayGOn.js","SectionHeading-BYvpkmUD.js","axios-vUo_bRtp.js","Markdown-uxhlayGT.js","clsx-B35qUV0p.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BvrGG8gU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CAf0yVYe.js"]}