{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Mailercloud API","description":"Send campaigns, manage contacts, and automate email with the Mailercloud API.","colors":{"primary":"#1B7CFF","light":"#4D9AFF","dark":"#0F62D8"},"logo":{"light":"https://mintcdn.com/mailercloud/i1yaE0mG2KZobCyB/logo/light.svg?fit=max\u0026auto=format\u0026n=i1yaE0mG2KZobCyB\u0026q=85\u0026s=ee63a470243c3c865ec9248b577f2a20","dark":"https://mintcdn.com/mailercloud/141gVSRGKgQdCHEd/logo/dark.svg?fit=max\u0026auto=format\u0026n=141gVSRGKgQdCHEd\u0026q=85\u0026s=cc781b737536e3755238b1d9eaf979c3","href":"https://www.mailercloud.com"},"favicon":"https://mintcdn.com/mailercloud/i1yaE0mG2KZobCyB/favicon.png?fit=max\u0026auto=format\u0026n=i1yaE0mG2KZobCyB\u0026q=85\u0026s=00200874c6abcc324677e5a8fb5505c0","api":{"playground":{"display":"interactive"},"examples":{"defaults":"all","languages":["curl","python","javascript","php","go"]}},"background":{"color":{"dark":"#0A1220"}},"navbar":{"links":[{"href":"https://app.mailercloud.com/login","label":"Sign In"}],"primary":{"type":"button","label":"Get Started","href":"https://app.mailercloud.com/register?source=apidoc"}},"footer":{"socials":{"website":"https://www.mailercloud.com","x":"https://twitter.com/mailercloud","linkedin":"https://www.linkedin.com/company/mailercloud","facebook":"https://www.facebook.com/mailercloud","youtube":"https://www.youtube.com/channel/UCslSwv-TECN8rLvFM8wRlog"}},"fonts":{"heading":{"family":"Hanken Grotesk","weight":600},"body":{"family":"Inter","weight":400}},"styling":{"eyebrows":"breadcrumbs","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","mcp","cursor"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"mailercloud","hasAudioNarration":false,"actualSubdomain":"mailercloud","customDomains":["apidoc.mailercloud.com"],"gitSource":{"type":"github","owner":"mailercloud-com","repo":"mailercloud-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae1cccc201cdb70a521d146","collectionId":"631a1394-a3ec-4363-965d-624bbb36882a","liveDeploymentHistoryId":"6ae1cccc201cdb70a521d146","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae1cccc201cdb70a521d146","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Marketing API","count":71},{"language":"default","tag":"Documentation","count":13},{"language":"default","tag":"Campaigns","count":12},{"language":"default","tag":"Guides","count":8},{"language":"default","tag":"Contacts","count":8},{"language":"default","tag":"Domains","count":7},{"language":"default","tag":"Inbox Tracker","count":7},{"language":"default","tag":"Webhooks","count":7},{"language":"default","tag":"Email API","count":6},{"language":"default","tag":"Email","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@mailercloud.com"}},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"editor-v7-file-tree","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"#content-area .prose.text-lg{font-size:1rem;line-height:1.7}#pagination .pagination-title{font-size:.875rem;line-height:1.45}#navbar,#navbar-transition{background:linear-gradient(90deg,#0f62d8 0,#1b7cff 65%,#3d8bff 100%)!important;border-bottom:none!important;backdrop-filter:none!important}#navbar a,#navbar button,#navbar p,#navbar span,#navbar svg{color:#fff}#navbar a:hover{opacity:.85}#navbar img[src*=\"logo/light\"]{display:none!important}#navbar img[src*=\"logo/dark\"]{display:block!important}#topbar-cta-button a>span.absolute{background:#fff!important}#assistant-entry,#assistant-entry *,#topbar-cta-button,#topbar-cta-button *{color:#0f62d8!important}#search-bar-entry{background:rgba(255,255,255,.15);border-color:rgba(255,255,255,.3)}.dark #navbar,.dark #navbar-transition{background:linear-gradient(90deg,#0b2a55 0,#10408a 65%,#164fa5 100%)!important}.dark #assistant-entry,.dark #assistant-entry *{color:#7eb3ff!important}.dark #topbar-cta-button,.dark #topbar-cta-button *{color:#0f62d8!important}.tryit-button{background:#1b7cff!important;color:#fff!important}.tryit-button:hover{background:#0f62d8!important;opacity:1!important}#content-area h1{font-size:1.9375rem}#content-area h2{font-size:1.5625rem}#content-area h3{font-size:1.25rem}"}],"page":{"pagePath":"api-reference/automations/get-automation-details","slug":"/api-reference/automations/get-automation-details","pageMetadata":{"title":"Get Automation Details","description":"Retrieve details and node-level campaign report data for an advanced automation by its ID. The request body filters which node types are included.","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /automations/{id}","href":"/api-reference/automations/get-automation-details","autogeneratedByOpenApi":true},"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 details and node-level campaign report data for an advanced automation by its ID. The request body filters which node types are included.\"\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 Automation Details","description":"Retrieve details and node-level campaign report data for an advanced automation by its ID. The request body filters which node types are included.","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /automations/{id}","href":"/api-reference/automations/get-automation-details","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get Automation Details","operationId":"get-single-automatoin-details","tags":["Automations"],"parameters":["cef0bd9f-8285-4f09-bed7-6cfd938d2c9c"],"requestBody":"2b78246b-c737-4089-a91c-f6e863feb0b4","responses":{"200":"e271825e-2fa6-4343-ba52-09be8abcf631","400":"050b06a1-bf76-480b-93cd-2d4b928e532e","401":"348ab7ed-d3df-4be6-9e6b-0d8c07f99b4a"},"description":"Retrieve details and node-level campaign report data for an advanced automation by its ID. The request body filters which node types are included.","method":"post","type":"path","servers":["525ccd40-acd0-4c1f-b45f-645a2ccc048d"],"security":["797e1cf7-8b79-49d7-8256-e509d254deea"],"path":"/automations/{id}","baseUrlOptions":["https://cloudapi.mailercloud.com/v1"],"title":"Get Automation Details","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","php","go"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"cef0bd9f-8285-4f09-bed7-6cfd938d2c9c":{"name":"id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"node_type":{"type":"string","description":"Filter nodes by type\n\nTypes: \"delay\",\"wait_for_trigger\",\"if/else\",\"split\",\"goto\",\"email\",\"list\",\"contact_update\",\"tag_actions\"","uniqueKey":"node_type","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"node_type":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"e271825e-2fa6-4343-ba52-09be8abcf631":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"automation":{"type":"object","properties":{"automation_id":{"type":"string","uniqueKey":"automation.automation_id","typeLabel":"string"},"automation_name":{"type":"string","uniqueKey":"automation.automation_name","typeLabel":"string"},"created_date":{"type":"string","uniqueKey":"automation.created_date","typeLabel":"string"},"updated_date":{"type":"string","uniqueKey":"automation.updated_date","typeLabel":"string"},"start_time":{"type":"string","uniqueKey":"automation.start_time","typeLabel":"string"},"finish_time":{"type":"string","uniqueKey":"automation.finish_time","typeLabel":"string"},"timezone":{"type":"string","uniqueKey":"automation.timezone","typeLabel":"string"},"status":{"type":"string","uniqueKey":"automation.status","typeLabel":"string"},"total_contacts":{"type":"integer","uniqueKey":"automation.total_contacts","typeLabel":"integer"},"total_triggers":{"type":"integer","uniqueKey":"automation.total_triggers","typeLabel":"integer"},"total_nodes":{"type":"integer","uniqueKey":"automation.total_nodes","typeLabel":"integer"},"skipped_contacts":{"type":"integer","uniqueKey":"automation.skipped_contacts","typeLabel":"integer"},"completed_contacts":{"type":"integer","uniqueKey":"automation.completed_contacts","typeLabel":"integer"},"campaigns":{"type":"array","items":{"type":"object","properties":{"blacklisted_domains":{"type":"object","properties":{},"uniqueKey":"automation.campaigns.items.[INDEX].blacklisted_domains","typeLabel":"object"},"broken_links":{"type":"object","properties":{},"uniqueKey":"automation.campaigns.items.[INDEX].broken_links","typeLabel":"object"},"conversion_tracking":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].conversion_tracking.name","typeLabel":"string"},"type":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].conversion_tracking.type","typeLabel":"string"}},"uniqueKey":"automation.campaigns.items.[INDEX].conversion_tracking","typeLabel":"object"},"created_date":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].created_date","typeLabel":"string"},"email_preheader":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].email_preheader","typeLabel":"string"},"modified_date":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].modified_date","typeLabel":"string"},"name":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].name","typeLabel":"string"},"permission_reminder":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].permission_reminder","typeLabel":"string"},"reply_email":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].reply_email","typeLabel":"string"},"report_abuse":{"type":"boolean","uniqueKey":"automation.campaigns.items.[INDEX].report_abuse","typeLabel":"boolean"},"report_summary":{"type":"object","properties":{"abuse":{"type":"integer","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.abuse","typeLabel":"integer"},"abuse_percentage":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.abuse_percentage","typeLabel":"string"},"clicks":{"type":"integer","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.clicks","typeLabel":"integer"},"clicks_percentage":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.clicks_percentage","typeLabel":"string"},"conversions":{"type":"integer","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.conversions","typeLabel":"integer"},"conversions_percentage":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.conversions_percentage","typeLabel":"string"},"delivered":{"type":"integer","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.delivered","typeLabel":"integer"},"delivered_percentage":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.delivered_percentage","typeLabel":"string"},"hard_bounce":{"type":"integer","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.hard_bounce","typeLabel":"integer"},"hard_bounce_percentage":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.hard_bounce_percentage","typeLabel":"string"},"open_percentage":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.open_percentage","typeLabel":"string"},"opens":{"type":"integer","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.opens","typeLabel":"integer"},"queue":{"type":"integer","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.queue","typeLabel":"integer"},"queue_percentage":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.queue_percentage","typeLabel":"string"},"queued_total":{"type":"integer","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.queued_total","typeLabel":"integer"},"sent":{"type":"integer","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.sent","typeLabel":"integer"},"sent_percentage":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.sent_percentage","typeLabel":"string"},"soft_bounce":{"type":"integer","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.soft_bounce","typeLabel":"integer"},"soft_bounce_percentage":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.soft_bounce_percentage","typeLabel":"string"},"spam_complaints_count":{"type":"integer","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.spam_complaints_count","typeLabel":"integer"},"spam_complaints_percentage":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.spam_complaints_percentage","typeLabel":"string"},"unsubscribe":{"type":"integer","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.unsubscribe","typeLabel":"integer"},"unsubscribe_percentage":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].report_summary.unsubscribe_percentage","typeLabel":"string"}},"uniqueKey":"automation.campaigns.items.[INDEX].report_summary","typeLabel":"object"},"sender":{"type":"object","properties":{"sender_email":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].sender.sender_email","typeLabel":"string"},"sender_name":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].sender.sender_name","typeLabel":"string"}},"uniqueKey":"automation.campaigns.items.[INDEX].sender","typeLabel":"object"},"status":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].status","typeLabel":"string"},"subject":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].subject","typeLabel":"string"},"tag":{"type":"string","uniqueKey":"automation.campaigns.items.[INDEX].tag","typeLabel":"string"}},"uniqueKey":"automation.campaigns.items.[INDEX]","typeLabel":"object"},"uniqueKey":"automation.campaigns","typeLabel":"object[]"},"triggers":{"type":"array","items":{"type":"object","properties":{"activity":{"type":"string","uniqueKey":"automation.triggers.items.[INDEX].activity","typeLabel":"string"},"activity_id":{"type":"string","uniqueKey":"automation.triggers.items.[INDEX].activity_id","typeLabel":"string"},"description":{"type":"string","uniqueKey":"automation.triggers.items.[INDEX].description","typeLabel":"string"},"filters":{"type":"object","properties":{"group_joiner":{"type":"string","uniqueKey":"automation.triggers.items.[INDEX].filters.group_joiner","typeLabel":"string"},"groups":{"type":"array","items":{"type":"object","properties":{},"uniqueKey":"automation.triggers.items.[INDEX].filters.groups.items.[INDEX]","typeLabel":"object"},"uniqueKey":"automation.triggers.items.[INDEX].filters.groups","typeLabel":"object[]"}},"uniqueKey":"automation.triggers.items.[INDEX].filters","typeLabel":"object"},"included_import":{"type":"boolean","uniqueKey":"automation.triggers.items.[INDEX].included_import","typeLabel":"boolean"},"list_id":{"type":"string","uniqueKey":"automation.triggers.items.[INDEX].list_id","typeLabel":"string"},"list_name":{"type":"string","uniqueKey":"automation.triggers.items.[INDEX].list_name","typeLabel":"string"}},"uniqueKey":"automation.triggers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"automation.triggers","typeLabel":"object[]"},"steps":{"type":"array","items":{"type":"object","properties":{"active_contacts":{"type":"integer","uniqueKey":"automation.steps.items.[INDEX].active_contacts","typeLabel":"integer"},"campaign_details":{"type":"object","properties":{"created_date":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].campaign_details.created_date","typeLabel":"string"},"email_preheader":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].campaign_details.email_preheader","typeLabel":"string"},"modified_date":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].campaign_details.modified_date","typeLabel":"string"},"name":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].campaign_details.name","typeLabel":"string"},"reply_email":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].campaign_details.reply_email","typeLabel":"string"},"report_summary":{"type":"object","properties":{"abuse":{"type":"integer","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.abuse","typeLabel":"integer"},"abuse_percentage":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.abuse_percentage","typeLabel":"string"},"clicks":{"type":"integer","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.clicks","typeLabel":"integer"},"clicks_percentage":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.clicks_percentage","typeLabel":"string"},"conversions":{"type":"integer","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.conversions","typeLabel":"integer"},"conversions_percentage":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.conversions_percentage","typeLabel":"string"},"delivered":{"type":"integer","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.delivered","typeLabel":"integer"},"delivered_percentage":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.delivered_percentage","typeLabel":"string"},"hard_bounce":{"type":"integer","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.hard_bounce","typeLabel":"integer"},"hard_bounce_percentage":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.hard_bounce_percentage","typeLabel":"string"},"open_percentage":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.open_percentage","typeLabel":"string"},"opens":{"type":"integer","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.opens","typeLabel":"integer"},"queue":{"type":"integer","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.queue","typeLabel":"integer"},"queue_percentage":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.queue_percentage","typeLabel":"string"},"queued_total":{"type":"integer","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.queued_total","typeLabel":"integer"},"sent":{"type":"integer","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.sent","typeLabel":"integer"},"sent_percentage":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.sent_percentage","typeLabel":"string"},"soft_bounce":{"type":"integer","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.soft_bounce","typeLabel":"integer"},"soft_bounce_percentage":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.soft_bounce_percentage","typeLabel":"string"},"spam_complaints_count":{"type":"integer","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.spam_complaints_count","typeLabel":"integer"},"spam_complaints_percentage":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.spam_complaints_percentage","typeLabel":"string"},"unsubscribe":{"type":"integer","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.unsubscribe","typeLabel":"integer"},"unsubscribe_percentage":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary.unsubscribe_percentage","typeLabel":"string"}},"uniqueKey":"automation.steps.items.[INDEX].campaign_details.report_summary","typeLabel":"object"},"sender":{"type":"object","properties":{"sender_email":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].campaign_details.sender.sender_email","typeLabel":"string"},"sender_name":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].campaign_details.sender.sender_name","typeLabel":"string"}},"uniqueKey":"automation.steps.items.[INDEX].campaign_details.sender","typeLabel":"object"},"status":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].campaign_details.status","typeLabel":"string"},"subject":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].campaign_details.subject","typeLabel":"string"},"tag":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].campaign_details.tag","typeLabel":"string"}},"uniqueKey":"automation.steps.items.[INDEX].campaign_details","typeLabel":"object"},"completed_contacts":{"type":"integer","uniqueKey":"automation.steps.items.[INDEX].completed_contacts","typeLabel":"integer"},"name":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].name","typeLabel":"string"},"skipped_contacts":{"type":"integer","uniqueKey":"automation.steps.items.[INDEX].skipped_contacts","typeLabel":"integer"},"step_id":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].step_id","typeLabel":"string"},"type":{"type":"string","uniqueKey":"automation.steps.items.[INDEX].type","typeLabel":"string"}},"uniqueKey":"automation.steps.items.[INDEX]","typeLabel":"object"},"uniqueKey":"automation.steps","typeLabel":"object[]"}},"uniqueKey":"automation","typeLabel":"object"}},"x-examples":{"Example 1":{"automation":{"automation_id":"EZZ","automation_name":"Draft","created_date":"2025-01-23 18:31:10","updated_date":"2025-01-24 09:59:50","start_time":"","finish_time":"","timezone":"","status":"Draft","total_contacts":0,"total_triggers":1,"total_nodes":1,"skipped_contacts":0,"completed_contacts":0,"campaigns":[{"blacklisted_domains":{},"broken_links":{},"conversion_tracking":{"name":"ew p","type":"Iframe"},"created_date":"2025-01-24 09:59:47","email_preheader":"","modified_date":"2025-01-24 09:59:47","name":"Html - 1","permission_reminder":"","reply_email":"test@regalwork.com","report_abuse":false,"report_summary":{"abuse":0,"abuse_percentage":"0.00","clicks":0,"clicks_percentage":"0.00","conversions":0,"conversions_percentage":"0.00","delivered":0,"delivered_percentage":"0.00","hard_bounce":0,"hard_bounce_percentage":"0.00","open_percentage":"0.00","opens":0,"queue":0,"queue_percentage":"0.00","queued_total":0,"sent":0,"sent_percentage":"0.00","soft_bounce":0,"soft_bounce_percentage":"0.00","spam_complaints_count":0,"spam_complaints_percentage":"0.00","unsubscribe":0,"unsubscribe_percentage":"0.00"},"sender":{"sender_email":"test@regalwork.com","sender_name":"Html - 1"},"status":"Draft","subject":"Html - 1","tag":"Improvements"}],"triggers":[{"activity":"Contact Activity","activity_id":"uSK","description":"Contact joins to a particular list","filters":{"group_joiner":"OR","groups":[]},"included_import":true,"list_id":"Ewy","list_name":"List Deletion - 1"}],"steps":[{"active_contacts":0,"campaign_details":{"created_date":"2025-01-24 09:59:47","email_preheader":"","modified_date":"2025-01-24 09:59:47","name":"Html - 1","reply_email":"test@regalwork.com","report_summary":{"abuse":0,"abuse_percentage":"0.00","clicks":0,"clicks_percentage":"0.00","conversions":0,"conversions_percentage":"0.00","delivered":0,"delivered_percentage":"0.00","hard_bounce":0,"hard_bounce_percentage":"0.00","open_percentage":"0.00","opens":0,"queue":0,"queue_percentage":"0.00","queued_total":0,"sent":0,"sent_percentage":"0.00","soft_bounce":0,"soft_bounce_percentage":"0.00","spam_complaints_count":0,"spam_complaints_percentage":"0.00","unsubscribe":0,"unsubscribe_percentage":"0.00"},"sender":{"sender_email":"test@regalwork.com","sender_name":"Html - 1"},"status":"Draft","subject":"Html - 1","tag":"Improvements"},"completed_contacts":0,"name":"Send Email","skipped_contacts":0,"step_id":"uSS","type":"email"}]}}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example-1":{"title":"Example-1","value":{"automation":{"automation_id":"EZZ","automation_name":"Draft","created_date":"2025-01-23 18:31:10","updated_date":"2025-01-24 09:59:50","start_time":"","finish_time":"","timezone":"","status":"Draft","total_contacts":0,"total_triggers":1,"total_nodes":1,"skipped_contacts":0,"completed_contacts":0,"campaigns":[{"blacklisted_domains":{},"broken_links":{},"conversion_tracking":{"name":"ew p","type":"Iframe"},"created_date":"2025-01-24 09:59:47","email_preheader":"","id":"HZy","modified_date":"2025-01-24 09:59:47","name":"Html - 1","permission_reminder":"","reply_email":"test@regalwork.com","report_abuse":false,"report_summary":{"abuse":0,"abuse_percentage":"0.00","clicks":0,"clicks_percentage":"0.00","conversions":0,"conversions_percentage":"0.00","delivered":0,"delivered_percentage":"0.00","hard_bounce":0,"hard_bounce_percentage":"0.00","open_percentage":"0.00","opens":0,"queue":0,"queue_percentage":"0.00","queued_total":0,"sent":0,"sent_percentage":"0.00","soft_bounce":0,"soft_bounce_percentage":"0.00","spam_complaints_count":0,"spam_complaints_percentage":"0.00","unsubscribe":0,"unsubscribe_percentage":"0.00"},"sender":{"sender_email":"test@regalwork.com","sender_name":"Html - 1"},"status":"Draft","subject":"Html - 1","tag":"Improvements"}],"triggers":[{"activity":"Contact Activity","activity_id":"uSK","description":"Contact joins to a particular list","filters":{"group_joiner":"OR","groups":[]},"included_import":true,"list_id":"Ewy","list_name":"List Deletion - 1"}],"steps":[{"active_contacts":0,"campaign_details":{"created_date":"2025-01-24 09:59:47","email_preheader":"","id":"HZy","modified_date":"2025-01-24 09:59:47","name":"Html - 1","reply_email":"test@regalwork.com","report_summary":{"abuse":0,"abuse_percentage":"0.00","clicks":0,"clicks_percentage":"0.00","conversions":0,"conversions_percentage":"0.00","delivered":0,"delivered_percentage":"0.00","hard_bounce":0,"hard_bounce_percentage":"0.00","open_percentage":"0.00","opens":0,"queue":0,"queue_percentage":"0.00","queued_total":0,"sent":0,"sent_percentage":"0.00","soft_bounce":0,"soft_bounce_percentage":"0.00","spam_complaints_count":0,"spam_complaints_percentage":"0.00","unsubscribe":0,"unsubscribe_percentage":"0.00"},"sender":{"sender_email":"test@regalwork.com","sender_name":"Html - 1"},"status":"Draft","subject":"Html - 1","tag":"Improvements"},"completed_contacts":0,"name":"Send Email","skipped_contacts":0,"step_id":"uSS","type":"email"}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"050b06a1-bf76-480b-93cd-2d4b928e532e":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"x-examples":{"Example 1":{"errors":[{"field":"node_type","message":"invalid value"}]}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example-1":{"title":"Example-1","value":{"errors":[{"field":"node_type","message":"invalid value"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"348ab7ed-d3df-4be6-9e6b-0d8c07f99b4a":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"x-examples":{"Example 1":{"errors":[{"field":"","message":"Authorization failed"}]}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example-1":{"title":"Example-1","value":{"errors":[{"field":"","message":"Authorization failed"}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"797e1cf7-8b79-49d7-8256-e509d254deea":{"apiKey":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Mailercloud API key (plain text, no Bearer prefix). Create keys in Settings → API.","scopes":[],"schemeName":"apiKey"}}},"servers":{"525ccd40-acd0-4c1f-b45f-645a2ccc048d":{"url":"https://cloudapi.mailercloud.com/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Your Mailercloud API key (plain text, no Bearer prefix). Create keys in Settings → API.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Authorization","type":"string","description":"Your Mailercloud API key (plain text, no Bearer prefix). Create keys in Settings → API.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"openapi-v1.json"},"subdomain":"mailercloud","siteName":"Mailercloud API","title":"Get Automation Details - Mailercloud API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T11:58:41.475Z","originalFileLocation":"api-reference/automations/get-automation-details.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 details and node-level campaign report data for an advanced automation by its ID. The request body filters which node types are included.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Mailercloud API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/mailercloud/xGtgtsD6i5MXTEn-/_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/mailercloud/xGtgtsD6i5MXTEn-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mailercloud/xGtgtsD6i5MXTEn-/_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/mailercloud/xGtgtsD6i5MXTEn-/_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/mailercloud/xGtgtsD6i5MXTEn-/_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/mailercloud/xGtgtsD6i5MXTEn-/_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/mailercloud/xGtgtsD6i5MXTEn-/_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/mailercloud/xGtgtsD6i5MXTEn-/_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/mailercloud/xGtgtsD6i5MXTEn-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Automation Details - Mailercloud API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve details and node-level campaign report data for an advanced automation by its ID. The request body filters which node types are included.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Mailercloud API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://apidoc.mailercloud.com/api-reference/automations/get-automation-details\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://mailercloud.mintlify.app/_mintlify/api/og/v2?division=Automations\u0026amp;title=Get+Automation+Details\u0026amp;description=Retrieve+details+and+node-level+campaign+report+data+for+an+advanced+automation+by+its+ID.+The+request+body+filters+which+node+types+are+included.\u0026amp;theme=936b6c78a22bbcb175702a1d\u0026amp;signature=95bcdafea66d4e1572f6248317370ed1d740c1ac11f8f5f4b99f66a085cba5c9\">\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 Automation Details - Mailercloud API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve details and node-level campaign report data for an advanced automation by its ID. The request body filters which node types are included.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://mailercloud.mintlify.app/_mintlify/api/og/v2?division=Automations\u0026amp;title=Get+Automation+Details\u0026amp;description=Retrieve+details+and+node-level+campaign+report+data+for+an+advanced+automation+by+its+ID.+The+request+body+filters+which+node+types+are+included.\u0026amp;theme=936b6c78a22bbcb175702a1d\u0026amp;signature=95bcdafea66d4e1572f6248317370ed1d740c1ac11f8f5f4b99f66a085cba5c9\">\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/mailercloud/xGtgtsD6i5MXTEn-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Mailercloud API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1B7CFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://apidoc.mailercloud.com/api-reference/automations/get-automation-details\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/automations/get-automation-details.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://apidoc.mailercloud.com/#organization\",\"name\":\"Mailercloud API\",\"url\":\"https://apidoc.mailercloud.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/mailercloud/i1yaE0mG2KZobCyB/logo/light.svg?fit=max\u0026auto=format\u0026n=i1yaE0mG2KZobCyB\u0026q=85\u0026s=ee63a470243c3c865ec9248b577f2a20\"}},{\"@type\":\"WebSite\",\"@id\":\"https://apidoc.mailercloud.com#website\",\"name\":\"Mailercloud API\",\"url\":\"https://apidoc.mailercloud.com\",\"publisher\":{\"@id\":\"https://apidoc.mailercloud.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://apidoc.mailercloud.com/api-reference/automations/get-automation-details#webpage\",\"url\":\"https://apidoc.mailercloud.com/api-reference/automations/get-automation-details\",\"name\":\"Get Automation Details\",\"description\":\"Retrieve details and node-level campaign report data for an advanced automation by its ID. The request body filters which node types are included.\",\"dateModified\":\"2026-10-27T11:58:41.475Z\",\"isPartOf\":{\"@id\":\"https://apidoc.mailercloud.com#website\"},\"breadcrumb\":{\"@id\":\"https://apidoc.mailercloud.com/api-reference/automations/get-automation-details#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://apidoc.mailercloud.com/api-reference/automations/get-automation-details#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Mailercloud API\",\"item\":\"https://apidoc.mailercloud.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Automation Details\",\"item\":\"https://apidoc.mailercloud.com/api-reference/automations/get-automation-details\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://apidoc.mailercloud.com/api-reference/automations/get-automation-details#apireference\",\"headline\":\"Get Automation Details\",\"name\":\"Get Automation Details\",\"description\":\"Retrieve details and node-level campaign report data for an advanced automation by its ID. The request body filters which node types are included.\",\"url\":\"https://apidoc.mailercloud.com/api-reference/automations/get-automation-details\",\"mainEntityOfPage\":{\"@id\":\"https://apidoc.mailercloud.com/api-reference/automations/get-automation-details#webpage\"},\"dateModified\":\"2026-10-27T11:58:41.475Z\",\"publisher\":{\"@id\":\"https://apidoc.mailercloud.com/#organization\"},\"isPartOf\":{\"@id\":\"https://apidoc.mailercloud.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Mailercloud API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Mailercloud API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Marketing API","icon":"envelopes-bulk","groups":[{"group":"Campaigns","pages":[{"title":"Create Campaign","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /campaign","href":"/api-reference/campaigns/create-campaign"},{"title":"Create Campaign (v2)","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /campaign/save","href":"/api-reference/campaigns/create-campaign-v2"},{"title":"Campaign Domain Report","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /campaign/domain/report/{id}","href":"/api-reference/campaigns/campaign-domain-report"},{"title":"Campaign List","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /campaign/list","href":"/api-reference/campaigns/campaign-list"},{"title":"Testmail Group List","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /campaign/testmail-groups/list","href":"/api-reference/campaigns/testmail-group-list"},{"title":"Schedule Campaign","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /campaign/schedule/{id}","href":"/api-reference/campaigns/schedule-campaign"},{"title":"Send a Test Email","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /campaign/testmail/{id}","href":"/api-reference/campaigns/send-a-test-email"},{"title":"Get Single Campaign Details","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /campaign/{id}","href":"/api-reference/campaigns/get-single-campaign-details"},{"title":"Update Campaign","deprecated":null,"version":null,"openapi":"/openapi-v1.json put /campaign/{id}","href":"/api-reference/campaigns/update-campaign"},{"title":"List Campaign Opens","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /campaign/{id}/opens","href":"/api-reference/campaigns/list-campaign-opens"},{"title":"List Campaign Clicks","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /campaign/{id}/clicks","href":"/api-reference/campaigns/list-campaign-clicks"},{"title":"List Campaign Unsubscribes","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /campaign/{id}/unsubs","href":"/api-reference/campaigns/list-campaign-unsubscribes"}]},{"group":"Custom Properties","pages":[{"title":"Create Property","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /contact/property","href":"/api-reference/custom-properties/create-property"},{"title":"Delete Property","deprecated":null,"version":null,"openapi":"/openapi-v1.json delete /contact/property/{id}","href":"/api-reference/custom-properties/delete-property"},{"title":"Update Property","deprecated":null,"version":null,"openapi":"/openapi-v1.json patch /contact/property/{id}","href":"/api-reference/custom-properties/update-property"},{"title":"List Property","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /contact/property/search","href":"/api-reference/custom-properties/list-property"}]},{"group":"Contacts","pages":[{"title":"Create Contact","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /contacts","href":"/api-reference/contacts/create-contact"},{"title":"Create or Update Contact","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /contacts/upsert","href":"/api-reference/contacts/create-or-update-contact"},{"title":"Get Contact Details","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /contacts/{id}","href":"/api-reference/contacts/get-contact-details"},{"title":"Update Contact","deprecated":null,"version":null,"openapi":"/openapi-v1.json put /contacts/{id}","href":"/api-reference/contacts/update-contact"},{"title":"Delete Contact","deprecated":null,"version":null,"openapi":"/openapi-v1.json delete /contacts/{id}","href":"/api-reference/contacts/delete-contact"},{"title":"Remove Contact Tag","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /contact/tag/remove","href":"/api-reference/contacts/remove-contact-tag"},{"title":"Get Contacts in a List","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /contact/search/{id}","href":"/api-reference/contacts/get-contacts-in-a-list"},{"title":"Create Batch Contact","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /contacts/batch","href":"/api-reference/contacts/create-batch-contact"}]},{"group":"Lists","pages":[{"title":"Create a New List","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /list","href":"/api-reference/lists/create-a-new-list"},{"title":"Get Single List Details","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /list/{id}","href":"/api-reference/lists/get-single-list-details"},{"title":"Delete a List","deprecated":null,"version":null,"openapi":"/openapi-v1.json delete /list/{id}","href":"/api-reference/lists/delete-a-list"},{"title":"Update a List","deprecated":null,"version":null,"openapi":"/openapi-v1.json patch /list/{id}","href":"/api-reference/lists/update-a-list"},{"title":"List Lists","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /lists/search","href":"/api-reference/lists/list-lists"}]},{"group":"Segments","pages":[{"title":"List Segment","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /segment/search","href":"/api-reference/segments/list-segment"},{"title":"Create Segment","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /segments","href":"/api-reference/segments/create-segment"},{"title":"Update a Segment","deprecated":null,"version":null,"openapi":"/openapi-v1.json put /segments/{id}","href":"/api-reference/segments/update-a-segment"}]},{"group":"Senders","pages":[{"title":"List Senders","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /senders/search","href":"/api-reference/senders/list-senders"},{"title":"List Reply Emails","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /reply-emails/search","href":"/api-reference/senders/list-reply-emails"},{"title":"Add a Sender","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /senders","href":"/api-reference/senders/add-a-sender"},{"title":"Delete a Sender","deprecated":null,"version":null,"openapi":"/openapi-v1.json delete /senders/{id}","href":"/api-reference/senders/delete-a-sender"}]},{"group":"Account","pages":[{"title":"Client Details","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /client/plan","href":"/api-reference/account/client-details"}]},{"group":"Webforms","pages":[{"title":"Webform List","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /webform/search","href":"/api-reference/webforms/webform-list"}]},{"group":"Tags","pages":[{"title":"Create Tag","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /tags","href":"/api-reference/tags/create-tag"},{"title":"List Tags","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /tags/search","href":"/api-reference/tags/list-tags"},{"title":"Update Tag","deprecated":null,"version":null,"openapi":"/openapi-v1.json put /tags/{id}","href":"/api-reference/tags/update-tag"},{"title":"Delete Tag","deprecated":null,"version":null,"openapi":"/openapi-v1.json delete /tags/{id}","href":"/api-reference/tags/delete-tag"}]},{"group":"Webhooks","pages":[{"title":"Create a New Webhook","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /webhooks","href":"/api-reference/webhooks/create-a-new-webhook"},{"title":"Update a Webhook","deprecated":null,"version":null,"openapi":"/openapi-v1.json put /webhooks/{id}","href":"/api-reference/webhooks/update-a-webhook"},{"title":"Delete a Webhook","deprecated":null,"version":null,"openapi":"/openapi-v1.json delete /webhooks/{id}","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"Get Webhook Details","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /webhooks/detail/{id}","href":"/api-reference/webhooks/get-webhook-details"},{"title":"Search and List Webhooks","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /webhooks/search","href":"/api-reference/webhooks/search-and-list-webhooks"},{"title":"Test Webhook","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /webhooks/test","href":"/api-reference/webhooks/test-webhook"},{"title":"Toggle Webhook Status","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /webhooks/toggle/{id}","href":"/api-reference/webhooks/toggle-webhook-status"}]},{"group":"Templates","pages":[{"title":"Create Template","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /templates/create","href":"/api-reference/templates/create-template"},{"title":"Update Template","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /templates/update","href":"/api-reference/templates/update-template"},{"title":"Get Template Details","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /templates/details/{id}","href":"/api-reference/templates/get-template-details"},{"title":"List Templates","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /templates/list","href":"/api-reference/templates/list-templates"},{"title":"Get Template Categories","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /templates/categories/list","href":"/api-reference/templates/get-template-categories"},{"title":"Get Template by Name or ID","description":"This endpoint retrieves the full details of an email template in mailercloud. You can fetch a template either by passing the template name or its ID in the query parameters.\n\n```Name\ncurl --request GET \\\n --url https://cloudapi.mailercloud.com/v1/templates/details?name=example \\\n --header 'Authorization: Your API Key here'\n\n```\n```ID\ncurl --request GET \\\n --url https://cloudapi.mailercloud.com/v1/templates/details?id=abc \\\n --header 'Authorization: Your API Key here'\n\n```","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /templates/details","href":"/api-reference/templates/get-template-by-name-or-id"}]},{"group":"Automations","pages":[{"title":"Get Automation Details","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /automations/{id}","href":"/api-reference/automations/get-automation-details"},{"title":"Create Automation","description":"API to create an advanced automation in a single request. `name` and `nodes` are required. `auto_publish` is optional (defaults to `false` = draft). `timezone`, `start_time`, `end_time`, `allow_re_enrollment`, `re_enroll_interval`, `re_enroll_unit` are optional.\n\nThe automation is declared as a directed graph of nodes: exactly one trigger node, plus any number of action / wait / condition nodes wired via `parent_id`. Caller-supplied node ids (`id`, `parent_id`, `target_id`) are short strings used only to wire the graph in the request; they are not stored.\n\n**Plan gate:** the caller's plan must include advanced automation, otherwise a `403` is returned.","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /automations","href":"/api-reference/automations/create-automation"}]},{"group":"Domains","pages":[{"title":"Add a Domain","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /domains","href":"/api-reference/domains/add-a-domain"},{"title":"List Domains","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /domains/search","href":"/api-reference/domains/list-domains"},{"title":"Get a Domain","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /domains/{id}","href":"/api-reference/domains/get-a-domain"},{"title":"Update a Domain","deprecated":null,"version":null,"openapi":"/openapi-v1.json put /domains/{id}","href":"/api-reference/domains/update-a-domain"},{"title":"Delete a Domain","deprecated":null,"version":null,"openapi":"/openapi-v1.json delete /domains/{id}","href":"/api-reference/domains/delete-a-domain"},{"title":"Verify a Domain","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /domains/{id}/verify","href":"/api-reference/domains/verify-a-domain"},{"title":"Share DNS Records","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /domains/{id}/share","href":"/api-reference/domains/share-dns-records"}]},{"group":"Inbox Tracker","pages":[{"title":"Inbox-tracking","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /inbox-tracking","href":"/api-reference/inbox-tracker/inbox-tracking"},{"title":"List placement providers","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /v2/placement/providers","href":"/api-reference/inbox-tracker/list-placement-providers"},{"title":"Start a placement test","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /v2/placement/tests","href":"/api-reference/inbox-tracker/start-a-placement-test"},{"title":"Get a placement test","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /v2/placement/tests/{test_id}","href":"/api-reference/inbox-tracker/get-a-placement-test"},{"title":"Get a campaign's latest placement test","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /v2/placement/campaigns/{campaign_id}/latest","href":"/api-reference/inbox-tracker/get-a-campaigns-latest-placement-test"},{"title":"List a campaign's placement tests","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /v2/placement/campaigns/{campaign_id}/tests","href":"/api-reference/inbox-tracker/list-a-campaigns-placement-tests"},{"title":"Get placement test quota","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /v2/placement/quota","href":"/api-reference/inbox-tracker/get-placement-test-quota"}]}]},{"tab":"Email API","icon":"paper-plane","pages":[{"title":"Email API","href":"/api-reference/email/send-email"}]},{"tab":"Email Verifier","icon":"circle-check","pages":[{"title":"Email Verifier","href":"/api-reference/verification/verify-emails"}]}]},"title":"Get Automation Details - Mailercloud API","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}