{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Automate.ax","description":"Write TypeScript automations that Automate.ax plans, deploys, and runs with managed integration accounts.","colors":{"primary":"#FACC15","light":"#FACC15","dark":"#EAB308"},"logo":{"light":"https://mintcdn.com/automate-ax/Kbupy0J0lZ6zMvqQ/logo-light.svg?fit=max\u0026auto=format\u0026n=Kbupy0J0lZ6zMvqQ\u0026q=85\u0026s=7fdce824369bd4a351297f363868fb6f","dark":"https://mintcdn.com/automate-ax/Kbupy0J0lZ6zMvqQ/logo-dark.svg?fit=max\u0026auto=format\u0026n=Kbupy0J0lZ6zMvqQ\u0026q=85\u0026s=3b96bcb0c1407d8f06845b65c9f134fd","href":"https://automate.ax"},"favicon":"https://mintcdn.com/automate-ax/Kbupy0J0lZ6zMvqQ/favicon.svg?fit=max\u0026auto=format\u0026n=Kbupy0J0lZ6zMvqQ\u0026q=85\u0026s=405a46617d068828c8ddb62e1136a5a5","navbar":{"primary":{"type":"button","label":"Go to app","href":"https://automate.ax/app"}},"seo":{"metatags":{"canonical":"https://docs.automate.ax"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"interaction":{"drilldown":false},"markdown":{"instructions":["Automate.ax automations are TypeScript programs.","Use Bun for installation and command examples.","Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.","Treat documented public APIs as current; do not invent transitional or deprecated names."]},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Home","icon":"house","href":"https://automate.ax"},{"anchor":"Go to app","href":"https://automate.ax/app"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"automate-ax","hasAudioNarration":false,"actualSubdomain":"automate-ax","customDomains":["docs.automate.ax"],"gitSource":{"type":"github","owner":"sentsco","repo":"automate.ax","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae232f33ab6e77040ca7735","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"Reference","count":3874},{"language":"default","tag":"Integrations","count":3859},{"language":"default","tag":"Actions","count":2679},{"language":"default","tag":"Triggers","count":1116},{"language":"default","tag":"Square","count":430},{"language":"default","tag":"GitHub","count":249},{"language":"default","tag":"Vercel","count":167},{"language":"default","tag":"Brevo","count":146},{"language":"default","tag":"Linear","count":141},{"language":"default","tag":"Webflow","count":122}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"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":"llms-txt-v2","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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/automations/get-automation","slug":"/api-reference/automations/get-automation","pageMetadata":{"title":"Get automation","description":"Returns an active automation with its triggers and integration account bindings.","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /automations/{automation}","href":"/api-reference/automations/get-automation","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: \"Returns an active automation with its triggers and integration account bindings.\"\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","description":"Returns an active automation with its triggers and integration account bindings.","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /automations/{automation}","href":"/api-reference/automations/get-automation","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getAutomation","summary":"Get automation","description":"Returns an active automation with its triggers and integration account bindings.","tags":["Automations"],"parameters":["2c8839e1-be6a-4ab8-a0ee-af68e1558354"],"responses":{"200":"6de048aa-d9f0-436f-819b-d4d9879bb549"},"method":"get","type":"path","servers":["768eb79c-62db-4e16-ac15-0d78b896da49"],"security":["0cfe0365-ade9-4ae2-998c-309b349f2a67"],"path":"/automations/{automation}","baseUrlOptions":["https://automate.ax/api/v1"],"title":"Get automation","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2c8839e1-be6a-4ab8-a0ee-af68e1558354":{"name":"automation","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"Exact automation ID or unique active deployed description. IDs take precedence.","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"6de048aa-d9f0-436f-819b-d4d9879bb549":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"accountBindings":{"type":"array","items":{"type":"object","properties":{"account":{"oneOf":[{"type":"object","required":["checkedAt","connectionMethodId","error","id","label","scopes","serviceId","serviceSub"],"properties":{"checkedAt":{"oneOf":[{"type":"string","format":"date-time","x-native-type":"date","isRequired":true,"uniqueKey":"accountBindings.items.[INDEX].account.oneOf.0.checkedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"accountBindings.items.[INDEX].account.oneOf.0.checkedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"accountBindings.items.[INDEX].account.oneOf.0.checkedAt","typeLabel":"string\u003cdate-time> | null"},"connectionMethodId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"accountBindings.items.[INDEX].account.oneOf.0.connectionMethodId","typeLabel":"string"},"error":{"oneOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"accountBindings.items.[INDEX].account.oneOf.0.error.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"accountBindings.items.[INDEX].account.oneOf.0.error.oneOf.0.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"accountBindings.items.[INDEX].account.oneOf.0.error.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"accountBindings.items.[INDEX].account.oneOf.0.error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"accountBindings.items.[INDEX].account.oneOf.0.error","typeLabel":"object | null"},"id":{"type":"string","isRequired":true,"uniqueKey":"accountBindings.items.[INDEX].account.oneOf.0.id","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"accountBindings.items.[INDEX].account.oneOf.0.label","typeLabel":"string"},"scopes":{"type":"array","items":{"type":"string","uniqueKey":"accountBindings.items.[INDEX].account.oneOf.0.scopes.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"accountBindings.items.[INDEX].account.oneOf.0.scopes","typeLabel":"string[]"},"serviceId":{"type":"string","isRequired":true,"uniqueKey":"accountBindings.items.[INDEX].account.oneOf.0.serviceId","typeLabel":"string"},"serviceSub":{"type":"string","isRequired":true,"uniqueKey":"accountBindings.items.[INDEX].account.oneOf.0.serviceSub","typeLabel":"string"}},"isRequired":true,"uniqueKey":"accountBindings.items.[INDEX].account.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"accountBindings.items.[INDEX].account.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"accountBindings.items.[INDEX].account","typeLabel":"object | null"},"binding":{"type":"string","isRequired":true,"uniqueKey":"accountBindings.items.[INDEX].binding","typeLabel":"string"},"serviceId":{"type":"string","isRequired":true,"uniqueKey":"accountBindings.items.[INDEX].serviceId","typeLabel":"string"}},"required":["account","binding","serviceId"],"uniqueKey":"accountBindings.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"accountBindings","typeLabel":"object[]"},"activeDeploymentId":{"type":"string","isRequired":true,"uniqueKey":"activeDeploymentId","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","x-native-type":"date","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"description":{"type":"string","isRequired":true,"uniqueKey":"description","typeLabel":"string"},"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"enabled","typeLabel":"boolean"},"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"identityKey":{"type":"string","isRequired":true,"uniqueKey":"identityKey","typeLabel":"string"},"project":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"project.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"project.name","typeLabel":"string"},"organization":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"project.organization.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"project.organization.name","typeLabel":"string"}},"required":["id","name"],"isRequired":true,"uniqueKey":"project.organization","typeLabel":"object"}},"required":["id","name","organization"],"isRequired":true,"uniqueKey":"project","typeLabel":"object"},"triggers":{"type":"array","items":{"type":"object","properties":{"details":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","isRequired":true,"uniqueKey":"triggers.items.[INDEX].details.items.[INDEX].value","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"triggers.items.[INDEX].details.items.[INDEX].label","typeLabel":"string"},"copyable":{"type":"boolean","uniqueKey":"triggers.items.[INDEX].details.items.[INDEX].copyable","typeLabel":"boolean"}},"required":["value","label"],"uniqueKey":"triggers.items.[INDEX].details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"triggers.items.[INDEX].details","typeLabel":"object[]"},"hookSlot":{"type":"integer","minimum":0,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"triggers.items.[INDEX].hookSlot","typeLabel":"integer"},"id":{"type":"string","isRequired":true,"uniqueKey":"triggers.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"triggers.items.[INDEX].name","typeLabel":"string"},"scopePath":{"type":"array","items":{"type":"integer","minimum":0,"maximum":9007199254740991,"uniqueKey":"triggers.items.[INDEX].scopePath.items.[INDEX]","typeLabel":"integer"},"isRequired":true,"uniqueKey":"triggers.items.[INDEX].scopePath","typeLabel":"integer[]"},"type":{"type":"string","isRequired":true,"uniqueKey":"triggers.items.[INDEX].type","typeLabel":"string"},"primary":{"type":"object","properties":{"value":{"type":"string","isRequired":true,"uniqueKey":"triggers.items.[INDEX].primary.value","typeLabel":"string"},"copyable":{"type":"boolean","uniqueKey":"triggers.items.[INDEX].primary.copyable","typeLabel":"boolean"}},"required":["value"],"uniqueKey":"triggers.items.[INDEX].primary","typeLabel":"object"}},"required":["details","hookSlot","id","name","scopePath","type"],"uniqueKey":"triggers.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"triggers","typeLabel":"object[]"},"updatedAt":{"type":"string","format":"date-time","x-native-type":"date","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"}},"required":["accountBindings","activeDeploymentId","createdAt","description","enabled","id","identityKey","project","triggers","updatedAt"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"accountBindings":[{"account":{"checkedAt":"2023-11-07T05:31:56Z","connectionMethodId":"\u003cstring>","error":{"code":"\u003cstring>","message":"\u003cstring>"},"id":"\u003cstring>","label":"\u003cstring>","scopes":["\u003cstring>"],"serviceId":"\u003cstring>","serviceSub":"\u003cstring>"},"binding":"\u003cstring>","serviceId":"\u003cstring>"}],"activeDeploymentId":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","description":"\u003cstring>","enabled":true,"id":"\u003cstring>","identityKey":"\u003cstring>","project":{"id":"\u003cstring>","name":"\u003cstring>","organization":{"id":"\u003cstring>","name":"\u003cstring>"}},"triggers":[{"details":[{"value":"\u003cstring>","label":"\u003cstring>","copyable":true}],"hookSlot":4503599627370495,"id":"\u003cstring>","name":"\u003cstring>","scopePath":[4503599627370495],"type":"\u003cstring>","primary":{"value":"\u003cstring>","copyable":true}}],"updatedAt":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"0cfe0365-ade9-4ae2-998c-309b349f2a67":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Automate.ax user session bearer token.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"768eb79c-62db-4e16-ac15-0d78b896da49":{"url":"https://automate.ax/api/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Automate.ax user session bearer token.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Automate.ax user session bearer token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"https://automate.ax/api/v1/openapi.json"},"subdomain":"automate-ax","siteName":"Automate.ax","title":"Get automation - Automate.ax","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T17:38:05.829Z","originalFileLocation":"api-reference/automations/get-automation.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=\"Returns an active automation with its triggers and integration account bindings.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Automate.ax\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/automate-ax/-fHpnQtqmmne46cU/_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/automate-ax/-fHpnQtqmmne46cU/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/automate-ax/-fHpnQtqmmne46cU/_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/automate-ax/-fHpnQtqmmne46cU/_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/automate-ax/-fHpnQtqmmne46cU/_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/automate-ax/-fHpnQtqmmne46cU/_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/automate-ax/-fHpnQtqmmne46cU/_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/automate-ax/-fHpnQtqmmne46cU/_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/automate-ax/-fHpnQtqmmne46cU/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get automation - Automate.ax\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns an active automation with its triggers and integration account bindings.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Automate.ax\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.automate.ax/api-reference/automations/get-automation\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://automate-ax.mintlify.site/_mintlify/api/og/v2?division=Automations\u0026amp;title=Get+automation\u0026amp;description=Returns+an+active+automation+with+its+triggers+and+integration+account+bindings.\u0026amp;theme=4f35fb3c3c85083befcabdbf\u0026amp;signature=7b27aa41a17b9a64de77178ef564eda1477effe7b18376838f72865604f51cbf\">\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 - Automate.ax\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns an active automation with its triggers and integration account bindings.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://automate-ax.mintlify.site/_mintlify/api/og/v2?division=Automations\u0026amp;title=Get+automation\u0026amp;description=Returns+an+active+automation+with+its+triggers+and+integration+account+bindings.\u0026amp;theme=4f35fb3c3c85083befcabdbf\u0026amp;signature=7b27aa41a17b9a64de77178ef564eda1477effe7b18376838f72865604f51cbf\">\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/automate-ax/-fHpnQtqmmne46cU/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Automate.ax\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FACC15\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.automate.ax/api-reference/automations/get-automation\">\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.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.automate.ax/#organization\",\"name\":\"Automate.ax\",\"url\":\"https://docs.automate.ax\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/automate-ax/Kbupy0J0lZ6zMvqQ/logo-light.svg?fit=max\u0026auto=format\u0026n=Kbupy0J0lZ6zMvqQ\u0026q=85\u0026s=7fdce824369bd4a351297f363868fb6f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.automate.ax#website\",\"name\":\"Automate.ax\",\"url\":\"https://docs.automate.ax\",\"publisher\":{\"@id\":\"https://docs.automate.ax/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.automate.ax/api-reference/automations/get-automation#webpage\",\"url\":\"https://docs.automate.ax/api-reference/automations/get-automation\",\"name\":\"Get automation\",\"description\":\"Returns an active automation with its triggers and integration account bindings.\",\"dateModified\":\"2026-10-28T17:38:05.829Z\",\"isPartOf\":{\"@id\":\"https://docs.automate.ax#website\"},\"breadcrumb\":{\"@id\":\"https://docs.automate.ax/api-reference/automations/get-automation#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.automate.ax/api-reference/automations/get-automation#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Automate.ax\",\"item\":\"https://docs.automate.ax\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get automation\",\"item\":\"https://docs.automate.ax/api-reference/automations/get-automation\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.automate.ax/api-reference/automations/get-automation#apireference\",\"headline\":\"Get automation\",\"name\":\"Get automation\",\"description\":\"Returns an active automation with its triggers and integration account bindings.\",\"url\":\"https://docs.automate.ax/api-reference/automations/get-automation\",\"mainEntityOfPage\":{\"@id\":\"https://docs.automate.ax/api-reference/automations/get-automation#webpage\"},\"dateModified\":\"2026-10-28T17:38:05.829Z\",\"publisher\":{\"@id\":\"https://docs.automate.ax/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.automate.ax#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Automate.ax\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Automate.ax","nav":{"global":{"anchors":[{"anchor":"Home","icon":"house","href":"https://automate.ax"},{"anchor":"Go to app","href":"https://automate.ax/app"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/start/with-agent"}]},{"tab":"Reference","pages":[{"title":"Reference","href":"/reference/triggers/on-dashboard-run"}]},{"tab":"REST API","groups":[{"group":"Integration Accounts","pages":[{"title":"Get pending integration installation","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /integration-installs/{token}","href":"/api-reference/integration-accounts/get-pending-integration-installation"},{"title":"Connect installed integration account","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json post /organizations/{organizationId}/integration-installs/{token}/claim","href":"/api-reference/integration-accounts/connect-installed-integration-account"},{"title":"Begin integration account connection","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json post /organizations/{organizationId}/integration-account-connections","href":"/api-reference/integration-accounts/begin-integration-account-connection"},{"title":"Get integration account connection","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /organizations/{organizationId}/integration-account-connections/{flowId}","href":"/api-reference/integration-accounts/get-integration-account-connection"},{"title":"Get integration account","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /organizations/{organizationId}/integration-accounts/{accountId}","href":"/api-reference/integration-accounts/get-integration-account"},{"title":"Disconnect integration account","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json delete /organizations/{organizationId}/integration-accounts/{accountId}","href":"/api-reference/integration-accounts/disconnect-integration-account"},{"title":"List integration accounts","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /organizations/{organizationId}/integration-accounts","href":"/api-reference/integration-accounts/list-integration-accounts"},{"title":"List integration services","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /integration-services","href":"/api-reference/integration-accounts/list-integration-services"},{"title":"Preview integration account revocation","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /organizations/{organizationId}/integration-accounts/{accountId}/revocation-impact","href":"/api-reference/integration-accounts/preview-integration-account-revocation"},{"title":"Revoke integration account","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json post /organizations/{organizationId}/integration-accounts/{accountId}/revoke","href":"/api-reference/integration-accounts/revoke-integration-account"},{"title":"Connect integration account credentials","description":"Validates secret form credentials and links the resulting account.","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json post /organizations/{organizationId}/integration-account-credentials","href":"/api-reference/integration-accounts/connect-integration-account-credentials"}]},{"group":"Automations","pages":[{"title":"Get automation","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /automations/{automation}","href":"/api-reference/automations/get-automation"},{"title":"Update automation","description":"Enables or disables an automation. Requires project:update.","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json patch /automations/{automation}","href":"/api-reference/automations/update-automation"},{"title":"Get automation execution","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /automations/{automation}/executions/{executionId}","href":"/api-reference/automations/get-automation-execution"},{"title":"Invoke automation","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json post /automations/{automation}/invocations","href":"/api-reference/automations/invoke-automation"},{"title":"List automations","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /automations","href":"/api-reference/automations/list-automations"},{"title":"List automation executions","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /automations/{automation}/executions","href":"/api-reference/automations/list-automation-executions"}]},{"group":"API Keys","pages":[{"title":"List organization API keys","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /organizations/{organizationId}/api-keys","href":"/api-reference/api-keys/list-organization-api-keys"},{"title":"Create organization API key","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json post /organizations/{organizationId}/api-keys","href":"/api-reference/api-keys/create-organization-api-key"},{"title":"Delete organization API key","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json delete /api-keys/{keyId}","href":"/api-reference/api-keys/delete-organization-api-key"},{"title":"Update organization API key","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json patch /api-keys/{keyId}","href":"/api-reference/api-keys/update-organization-api-key"}]},{"group":"Deployments","pages":[{"title":"Get deployment authorization","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /deployments/{deploymentId}/authorization","href":"/api-reference/deployments/get-deployment-authorization"},{"title":"Proceed with deployment authorization","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json post /deployments/{deploymentId}/authorization/proceed","href":"/api-reference/deployments/proceed-with-deployment-authorization"},{"title":"Get deployment","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /deployments/{deploymentId}","href":"/api-reference/deployments/get-deployment"},{"title":"Cancel deployment","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json delete /deployments/{deploymentId}","href":"/api-reference/deployments/cancel-deployment"},{"title":"Configure automation parameters","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json put /deployments/{deploymentId}/parameters","href":"/api-reference/deployments/configure-automation-parameters"},{"title":"List deployments","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /deployments","href":"/api-reference/deployments/list-deployments"},{"title":"Redeploy project","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json post /projects/{projectId}/deployments/redeploy","href":"/api-reference/deployments/redeploy-project"}]},{"group":"Execution data","pages":[{"title":"Get execution data manifest","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /execution-data/manifest","href":"/api-reference/execution-data/get-execution-data-manifest"}]},{"group":"Organizations","pages":[{"title":"List organizations","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /organizations","href":"/api-reference/organizations/list-organizations"},{"title":"Create organization","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json post /organizations","href":"/api-reference/organizations/create-organization"},{"title":"Get organization","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /organizations/{organizationId}","href":"/api-reference/organizations/get-organization"},{"title":"Delete organization","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json delete /organizations/{organizationId}","href":"/api-reference/organizations/delete-organization"},{"title":"Update organization","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json patch /organizations/{organizationId}","href":"/api-reference/organizations/update-organization"},{"title":"Invite organization member","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json post /organizations/{organizationId}/invitations","href":"/api-reference/organizations/invite-organization-member"},{"title":"Leave organization","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json delete /organizations/{organizationId}/membership","href":"/api-reference/organizations/leave-organization"},{"title":"Remove organization member","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json delete /organizations/{organizationId}/members/{memberIdOrEmail}","href":"/api-reference/organizations/remove-organization-member"}]},{"group":"Projects","pages":[{"title":"Create project","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json post /organizations/{organizationId}/projects","href":"/api-reference/projects/create-project"},{"title":"Get project","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /projects/{projectId}","href":"/api-reference/projects/get-project"},{"title":"Delete project","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json delete /projects/{projectId}","href":"/api-reference/projects/delete-project"},{"title":"Update project","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json patch /projects/{projectId}","href":"/api-reference/projects/update-project"},{"title":"List projects","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /projects","href":"/api-reference/projects/list-projects"}]},{"group":"Session","pages":[{"title":"Get current user","deprecated":null,"version":null,"openapi":"https://automate.ax/api/v1/openapi.json get /me","href":"/api-reference/session/get-current-user"}]}]}]},"basePath":"","title":"Get automation - Automate.ax","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}