Present when this flow was created for your account from a managed template, naming that template, the version it was created at and a digest of the content it started with. null for a flow you built yourself. Read-only — it is stamped when the flow is created and is not accepted when you create or update one.
Which of this flow's inputs a run can be found by. Name up to 5 inputs — or dotted paths into one, such as customer.phone — and each run of this flow records those values so you can look the run up by them later with attr.<key> on the executions list. The key is the path lowercased with dots replaced by underscores, so customer.phone is searched as attr.customer_phone. Values are captured when the run starts and never change afterwards, phone-shaped values are stored in international format, and anything longer than 256 characters is shortened. Naming an input this flow does not declare is rejected.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"GetDialed Docs","colors":{"primary":"#4F46E5","light":"#818CF8","dark":"#3730A3"},"logo":{"light":"https://mintcdn.com/getdialed/aL0yqdSUKnvM2urY/logo/light.svg?fit=max\u0026auto=format\u0026n=aL0yqdSUKnvM2urY\u0026q=85\u0026s=f6bd462ed94234572b2ef5546432f2e6","dark":"https://mintcdn.com/getdialed/aL0yqdSUKnvM2urY/logo/dark.svg?fit=max\u0026auto=format\u0026n=aL0yqdSUKnvM2urY\u0026q=85\u0026s=d1c6a3c7e0c6c51c197026d4f6e5828b","href":"https://getdialed.ai"},"favicon":"https://mintcdn.com/getdialed/hCWbIPF0pnvtMb9m/favicon.ico?fit=max\u0026auto=format\u0026n=hCWbIPF0pnvtMb9m\u0026q=85\u0026s=f2bdd6a91d61e358c1f0958dfa3a7ba6","footer":{"socials":{"website":"https://getdialed.ai"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"getdialed","hasAudioNarration":false,"actualSubdomain":"getdialed","customDomains":["docs.getdialed.ai"],"gitSource":{"type":"gitlab","owner":"getdialed","repo":"gdf","deployBranch":"master","contentDirectory":"docs-site","isPrivate":true,"projectId":79547483,"mountPath":"","label":""},"chroma":{"collectionId":"e7cf6d55-9268-46be-aa47-d76035f822d6","liveDeploymentHistoryId":"6accf41d5f90b4d42c2fc095","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6accf41d5f90b4d42c2fc095"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ada2fd916a91434b90658d1","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"API Reference","count":114},{"language":"default","tag":"Flows — /v1/flows","count":56},{"language":"default","tag":"Documentation","count":42},{"language":"default","tag":"Core Concepts","count":28},{"language":"default","tag":"Data — /v1/data","count":13},{"language":"default","tag":"Five9 Domains — /v1/platforms/five9","count":13},{"language":"default","tag":"Batches","count":10},{"language":"default","tag":"Webhooks","count":9},{"language":"default","tag":"Variables","count":8},{"language":"default","tag":"Admin — /v1/admin","count":7}]},"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":"vite-origin","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":"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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#navbar a[href=\"https://getdialed.ai\"] img,#navbar .nav-logo img,#navbar .nav-logo{height:2.75rem!important;max-height:2.75rem!important}#navbar a[href=\"https://getdialed.ai\"]{display:flex;align-items:center;gap:0.6rem}#navbar a[href=\"https://getdialed.ai\"]::after{content:\"Docs\";font-size:0.875rem;font-weight:500;color:#64748b;line-height:1}html.dark #navbar a[href=\"https://getdialed.ai\"]::after{color:#94a3b8}"}],"page":{"pagePath":"api-reference/definitions/get-a-definition","slug":"/api-reference/definitions/get-a-definition","pageMetadata":{"title":"Get a definition","description":"Fetch a single flow definition by id. Cross-tenant access returns 404.","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/definitions/{definition_id}","href":"/api-reference/definitions/get-a-definition","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: \"Fetch a single flow definition by id. Cross-tenant access returns 404.\"\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 a definition","description":"Fetch a single flow definition by id. Cross-tenant access returns 404.","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/definitions/{definition_id}","href":"/api-reference/definitions/get-a-definition","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["definitions"],"summary":"Get a definition","description":"Fetch a single flow definition by id. Cross-tenant access returns 404.","operationId":"get_definition_flows_definitions__definition_id__get","security":["22272e7e-efa3-4bc1-88b2-17265d63a68c","3d2a8525-449e-441e-8159-84ee1c969f89"],"parameters":["6a45fea7-1509-4d66-9afd-126ad9870903"],"responses":{"200":"73faad40-bb94-47db-aac3-14dc5950d42a","401":"2a48d522-37ae-48d8-a0b2-643c8e984656","404":"668fcb97-f432-4757-beec-0439e9e287a5","422":"bff7b318-e239-4883-87cf-81c5ced8621d","429":"c8b179ae-96f6-41d2-87c0-8bf857b8cb36"},"method":"get","type":"path","servers":["46b27330-8729-49f8-bc01-5b7026690c37"],"path":"/flows/definitions/{definition_id}","baseUrlOptions":["https://api.getdialed.ai/v1"],"title":"Get a definition","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6a45fea7-1509-4d66-9afd-126ad9870903":{"name":"definition_id","in":"path","required":true,"schema":{"type":"string","title":"Definition Id","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"73faad40-bb94-47db-aac3-14dc5950d42a":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"org_id":{"type":"string","title":"Org Id","isRequired":true,"uniqueKey":"org_id","typeLabel":"string"},"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"version":{"type":"integer","title":"Version","isRequired":true,"uniqueKey":"version","typeLabel":"integer"},"status":{"type":"string","title":"Status","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"inputs":{"items":{"properties":{"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"inputs.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","enum":["string","number","boolean","object","array","datetime"],"title":"Type","isRequired":true,"uniqueKey":"inputs.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"required":{"type":"boolean","title":"Required","default":true,"uniqueKey":"inputs.items.[INDEX].required","typeLabel":"boolean"},"description":{"type":"string","title":"Description","default":"","uniqueKey":"inputs.items.[INDEX].description","typeLabel":"string"}},"type":"object","required":["name","type"],"title":"DefinitionInput","uniqueKey":"inputs.items.[INDEX]","typeLabel":"DefinitionInput · object"},"type":"array","title":"Inputs","isRequired":true,"uniqueKey":"inputs","typeLabel":"DefinitionInput · object[]"},"variables":{"items":{"properties":{"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"variables.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","enum":["string","number","boolean","object","array","datetime"],"title":"Type","isRequired":true,"uniqueKey":"variables.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"title":"Value","isRequired":true}],"isRequired":true,"uniqueKey":"variables.items.[INDEX].value","typeLabel":"any"}},"type":"object","required":["name","type","value"],"title":"DefinitionVariable","uniqueKey":"variables.items.[INDEX]","typeLabel":"DefinitionVariable · object"},"type":"array","title":"Variables","isRequired":true,"uniqueKey":"variables","typeLabel":"DefinitionVariable · object[]"},"steps":{"items":{"properties":{"step_id":{"type":"string","title":"Step Id","isRequired":true,"uniqueKey":"steps.items.[INDEX].step_id","typeLabel":"string"},"name":{"type":"string","title":"Name","default":"","uniqueKey":"steps.items.[INDEX].name","typeLabel":"string"},"tasks":{"items":{"properties":{"task_id":{"type":"string","title":"Task Id","isRequired":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].task_id","typeLabel":"string"},"task_name":{"type":"string","title":"Task Name","isRequired":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].task_name","typeLabel":"string"},"platform_id":{"type":"string","title":"Platform Id","isRequired":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].platform_id","typeLabel":"string"},"service_id":{"type":"string","title":"Service Id","isRequired":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].service_id","typeLabel":"string"},"action_id":{"type":"string","title":"Action Id","isRequired":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].action_id","typeLabel":"string"},"action_version":{"type":"string","title":"Action Version","default":"1.0","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].action_version","typeLabel":"string"},"connection_id":{"oneOf":[{"type":"string","title":"Connection Id","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].connection_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Connection Id","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].connection_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].connection_id","typeLabel":"string | null"},"execution_type":{"type":"string","enum":["immediate","scheduled","windowed","signaled"],"title":"Execution Type","default":"immediate","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_type","typeLabel":"enum\u003cstring>"},"execution_config":{"oneOf":[{"type":"object","title":"DelayConfig","required":["delay"],"properties":{"delay":{"type":"string","title":"Delay","isRequired":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.0.delay","typeLabel":"string"},"schedule_type":{"type":"string","const":"delay","title":"Schedule Type","default":"delay","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.0.schedule_type","typeLabel":"string"}},"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.0","typeLabel":"DelayConfig · object"},{"type":"object","title":"FixedConfig","required":["run_at"],"properties":{"run_at":{"type":"string","format":"date-time","title":"Run At","isRequired":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.1.run_at","typeLabel":"string\u003cdate-time>"},"schedule_type":{"type":"string","const":"fixed","title":"Schedule Type","default":"fixed","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.1.schedule_type","typeLabel":"string"}},"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.1","typeLabel":"FixedConfig · object"},{"type":"object","title":"CronConfig","required":["cron"],"properties":{"cron":{"type":"string","title":"Cron","isRequired":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.2.cron","typeLabel":"string"},"schedule_type":{"type":"string","const":"cron","title":"Schedule Type","default":"cron","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.2.schedule_type","typeLabel":"string"}},"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.2","typeLabel":"CronConfig · object"},{"type":"object","title":"WindowedConfig","required":["timezone","window"],"properties":{"timezone":{"type":"string","title":"Timezone","description":"Which clock the window is measured against. Either an IANA time-zone name such as `America/Denver` — the flow's own clock, used for every record — or an expression such as `{{ input.record.timezone }}`, which resolves against each record so a fan-out's children each obey their own recipient's clock. A literal is checked when you save; an expression is not, because the value it produces does not exist yet. If an expression resolves to nothing, or to something that is not a time-zone name, the task is NOT failed and does NOT fall back to the flow's own zone: it runs only during hours that are inside the window in every US time zone. That window is narrower, so the task still runs — just later in the day.","isRequired":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.3.timezone","typeLabel":"string"},"window":{"properties":{"days":{"items":{"type":"string","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.3.window.days.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Days","isRequired":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.3.window.days","typeLabel":"string[]"},"start_time":{"type":"string","title":"Start Time","isRequired":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.3.window.start_time","typeLabel":"string"},"end_time":{"type":"string","title":"End Time","isRequired":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.3.window.end_time","typeLabel":"string"}},"type":"object","required":["days","start_time","end_time"],"title":"TimeWindow","isRequired":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.3.window","typeLabel":"TimeWindow · object"},"outside_window":{"type":"string","enum":["schedule_next","skip"],"title":"Outside Window","default":"schedule_next","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.3.outside_window","typeLabel":"enum\u003cstring>"}},"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.3","typeLabel":"WindowedConfig · object"},{"type":"object","title":"SignaledConfig","required":["timeout"],"properties":{"timeout":{"type":"string","title":"Timeout","isRequired":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.4.timeout","typeLabel":"string"},"signal_type":{"type":"string","enum":["webhook","polling"],"title":"Signal Type","default":"webhook","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.4.signal_type","typeLabel":"enum\u003cstring>"},"on_timeout":{"type":"string","enum":["continue","abort_step","abort_execution"],"title":"On Timeout","default":"continue","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.4.on_timeout","typeLabel":"enum\u003cstring>"},"on_timeout_output":{"oneOf":[{"type":"object","title":"On Timeout Output","additionalProperties":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.4.on_timeout_output.oneOf.0","typeLabel":"On Timeout Output · object"},{"type":"null","title":"On Timeout Output","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.4.on_timeout_output.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.4.on_timeout_output","typeLabel":"On Timeout Output · object | null"},"wait_for_reply":{"type":"boolean","title":"Wait For Reply","default":false,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.4.wait_for_reply","typeLabel":"boolean"},"sender_match":{"type":"boolean","title":"Sender Match","default":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.4.sender_match","typeLabel":"boolean"}},"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.4","typeLabel":"SignaledConfig · object"},{"type":"null","title":"Execution Config","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config.oneOf.5","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].execution_config","typeLabel":"DelayConfig · object | FixedConfig · object | CronConfig · object | WindowedConfig · object | SignaledConfig · object | null"},"delivery":{"type":"string","enum":["direct","batched"],"title":"Delivery","default":"direct","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].delivery","typeLabel":"enum\u003cstring>"},"batch_config":{"oneOf":[{"type":"object","title":"BatchConfig","required":["batch_group_key"],"properties":{"batch_group_key":{"type":"string","title":"Batch Group Key","isRequired":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.batch_group_key","typeLabel":"string"},"flush_strategy":{"type":"string","enum":["threshold_or_interval","threshold_only","interval_only"],"title":"Flush Strategy","default":"threshold_or_interval","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.flush_strategy","typeLabel":"enum\u003cstring>"},"max_batch_size":{"type":"integer","title":"Max Batch Size","default":1000,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.max_batch_size","typeLabel":"integer"},"flush_interval":{"type":"string","title":"Flush Interval","default":"60s","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.flush_interval","typeLabel":"string"},"min_batch_size":{"type":"integer","title":"Min Batch Size","default":1,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.min_batch_size","typeLabel":"integer"},"priority":{"type":"string","enum":["normal","high"],"title":"Priority","default":"normal","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.priority","typeLabel":"enum\u003cstring>"},"on_batch_failure":{"type":"string","enum":["retry_batch","abort_batch"],"title":"On Batch Failure","default":"retry_batch","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.on_batch_failure","typeLabel":"enum\u003cstring>"},"on_record_failure":{"type":"string","enum":["signal_failed","signal_and_retry"],"title":"On Record Failure","default":"signal_failed","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.on_record_failure","typeLabel":"enum\u003cstring>"},"pacing":{"oneOf":[{"type":"object","title":"PacingPolicy","description":"A ceiling on how fast a batch may be released: N records every M minutes.\n\nThe rate is a hard ceiling over any interval — there is no catch-up burst.\nAfter a pause, an exhausted provider quota or a closed delivery window,\ndelivery resumes at the configured rate from that moment; the time lost is\nnot made up.\n\n`period_minutes` is measured in whole minutes: pacing finer than a minute\ncannot be expressed. Add a `window` to confine delivery to particular local\nhours.","required":["records_per_period","period_minutes"],"properties":{"records_per_period":{"type":"integer","minimum":1,"title":"Records Per Period","isRequired":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.pacing.oneOf.0.records_per_period","typeLabel":"integer"},"period_minutes":{"type":"integer","minimum":1,"title":"Period Minutes","isRequired":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.pacing.oneOf.0.period_minutes","typeLabel":"integer"},"window":{"oneOf":[{"type":"object","title":"DeliveryWindow","description":"The hours of the day during which a paced batch may deliver.\n\n`timezone` is a required IANA name such as `America/Denver` — a fixed UTC\noffset is wrong for half the year, so there is no default and no fallback:\na window always states its own zone. `start_minute_of_day` and\n`end_minute_of_day` are minutes since local midnight, start inclusive and\nend exclusive; `end_minute_of_day` may be `1440` (local midnight ending the\nday). A window that would wrap past midnight is rejected. `days` limits the\nwindow to particular lowercase weekday names (`monday` … `sunday`); omit it\nfor every day.\n\nRecords left over when the window closes are not dropped and are not\nrushed: delivery resumes at the same local start time on the next allowed\nday.","required":["timezone","start_minute_of_day","end_minute_of_day"],"properties":{"timezone":{"type":"string","title":"Timezone","isRequired":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.pacing.oneOf.0.window.oneOf.0.timezone","typeLabel":"string"},"start_minute_of_day":{"type":"integer","exclusiveMaximum":1440,"minimum":0,"title":"Start Minute Of Day","isRequired":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.pacing.oneOf.0.window.oneOf.0.start_minute_of_day","typeLabel":"integer"},"end_minute_of_day":{"type":"integer","maximum":1440,"minimum":1,"title":"End Minute Of Day","isRequired":true,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.pacing.oneOf.0.window.oneOf.0.end_minute_of_day","typeLabel":"integer"},"days":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.pacing.oneOf.0.window.oneOf.0.days.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Days","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.pacing.oneOf.0.window.oneOf.0.days.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Days","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.pacing.oneOf.0.window.oneOf.0.days.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.pacing.oneOf.0.window.oneOf.0.days","typeLabel":"string[] | null"}},"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.pacing.oneOf.0.window.oneOf.0","typeLabel":"DeliveryWindow · object"},{"type":"null","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.pacing.oneOf.0.window.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.pacing.oneOf.0.window","typeLabel":"DeliveryWindow · object | null"}},"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.pacing.oneOf.0","typeLabel":"PacingPolicy · object"},{"type":"null","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.pacing.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0.pacing","typeLabel":"PacingPolicy · object | null"}},"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.0","typeLabel":"BatchConfig · object"},{"type":"null","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].batch_config","typeLabel":"BatchConfig · object | null"},"parameters":{"additionalProperties":true,"type":"object","title":"Parameters","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].parameters","typeLabel":"Parameters · object"},"on_success":{"type":"string","enum":["continue","skip_step","abort_execution"],"title":"On Success","default":"continue","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].on_success","typeLabel":"enum\u003cstring>"},"on_failure":{"type":"string","enum":["abort_step","abort_execution","log_and_continue","retry"],"title":"On Failure","default":"abort_step","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].on_failure","typeLabel":"enum\u003cstring>"},"template_id":{"oneOf":[{"type":"string","title":"Template Id","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].template_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Template Id","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].template_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].template_id","typeLabel":"string | null"},"notes":{"oneOf":[{"type":"string","title":"Notes","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].notes.oneOf.0","typeLabel":"string"},{"type":"null","title":"Notes","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].notes","typeLabel":"string | null"},"traffic_class":{"type":"string","enum":["marketing","transactional"],"title":"Traffic Class","description":"What kind of message this task sends, which decides whether quiet-hours restrictions apply to it. `marketing` (the default) is held until the recipient's local sending window is open. `transactional` sends immediately and is intended only for messages the recipient asked for and is waiting on — one-time passcodes, fraud alerts, appointment and delivery notifications. Declaring `transactional` requires an administrator, and the declaration is recorded on the flow.","default":"marketing","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].traffic_class","typeLabel":"enum\u003cstring>"},"quiet_hours":{"oneOf":[{"type":"object","title":"QuietHoursSource","description":"Which parts of your record say where the recipient is.\n\nText messaging is restricted to daytime hours in the recipient's own local\ntime, so before a message can be sent the platform has to work out which\ntime zone that is. It asks these three sources in order and uses the first\none that answers: the recipient's own time zone if your records carry one,\notherwise their ZIP code, otherwise their state.\n\nEach value is an expression evaluated against the flow's context, exactly\nlike a task parameter — for example `{{ input.record.timezone }}`. Supply as\nmany or as few as your records actually carry; each is optional and an\nunanswerable one simply falls through to the next.\n\nIf none of them resolves, the recipient's location is treated as unknown and\nthe message is sent only during hours that are legal in every US time zone.\nThat window is narrower than any single zone's, so messages still go out —\njust later in the day.\n\nThe recipient's phone number is deliberately not one of these sources. Phone\nnumbers are portable and mobile, so an area code indicates where a number was\nissued rather than where its owner is, and guessing wrong means sending in\nthe middle of someone's night.","properties":{"lead_timezone":{"oneOf":[{"type":"string","title":"Lead Timezone","description":"An expression resolving to an IANA time-zone name such as `America/Chicago`. Checked first, and used as-is when it names a zone the platform knows.","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].quiet_hours.oneOf.0.lead_timezone.oneOf.0","typeLabel":"string"},{"type":"null","title":"Lead Timezone","description":"An expression resolving to an IANA time-zone name such as `America/Chicago`. Checked first, and used as-is when it names a zone the platform knows.","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].quiet_hours.oneOf.0.lead_timezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].quiet_hours.oneOf.0.lead_timezone","typeLabel":"string | null"},"zip_code":{"oneOf":[{"type":"string","title":"Zip Code","description":"An expression resolving to a US ZIP code, either `#####` or `#####-####`. Checked when no usable time zone was supplied.","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].quiet_hours.oneOf.0.zip_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Zip Code","description":"An expression resolving to a US ZIP code, either `#####` or `#####-####`. Checked when no usable time zone was supplied.","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].quiet_hours.oneOf.0.zip_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].quiet_hours.oneOf.0.zip_code","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","title":"State","description":"An expression resolving to a two-letter US state abbreviation such as `TX`. Checked last. A state spanning more than one time zone is resolved conservatively across all of them.","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].quiet_hours.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","title":"State","description":"An expression resolving to a two-letter US state abbreviation such as `TX`. Checked last. A state spanning more than one time zone is resolved conservatively across all of them.","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].quiet_hours.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].quiet_hours.oneOf.0.state","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].quiet_hours.oneOf.0","typeLabel":"QuietHoursSource · object"},{"type":"null","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].quiet_hours.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].quiet_hours","typeLabel":"QuietHoursSource · object | null"},"skip_if":{"oneOf":[{"type":"string","title":"Skip If","description":"An optional condition that decides whether this task runs at all. It is evaluated immediately before the task would be dispatched, against the same context the task's `parameters` see, and uses the same comparison syntax as a step's exit conditions — including a bare expression, which passes when it resolves to a truthy value. When it passes, the task is not run and is recorded as skipped, and the rest of the step continues. Omit it and the task always runs.","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].skip_if.oneOf.0","typeLabel":"string"},{"type":"null","title":"Skip If","description":"An optional condition that decides whether this task runs at all. It is evaluated immediately before the task would be dispatched, against the same context the task's `parameters` see, and uses the same comparison syntax as a step's exit conditions — including a bare expression, which passes when it resolves to a truthy value. When it passes, the task is not run and is recorded as skipped, and the rest of the step continues. Omit it and the task always runs.","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].skip_if.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].skip_if","typeLabel":"string | null"},"retry_policy":{"oneOf":[{"type":"object","title":"TaskRetryPolicy","description":"How this task re-attempts itself after a failure. Honoured only when `on_failure` is `retry`, and accepted only for actions the catalog considers safe to repeat. Omit it and a failing task is not re-attempted.","properties":{"max_attempts":{"type":"integer","maximum":10,"minimum":1,"title":"Max Attempts","description":"How many times the task may run in total, counting the first attempt. Between 1 and 10.","default":3,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].retry_policy.oneOf.0.max_attempts","typeLabel":"integer"},"initial_delay":{"type":"string","title":"Initial Delay","description":"How long to wait before the second attempt, written as a duration such as `5s`, `30s` or `2m`. Between one second and one hour.","default":"5s","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].retry_policy.oneOf.0.initial_delay","typeLabel":"string"},"backoff":{"type":"string","enum":["fixed","exponential"],"title":"Backoff","description":"Whether the wait stays the same between attempts (`fixed`) or doubles each time (`exponential`, the default).","default":"exponential","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].retry_policy.oneOf.0.backoff","typeLabel":"enum\u003cstring>"},"retry_on":{"type":"string","enum":["transient","any"],"title":"Retry On","description":"Which failures are retried. `transient` (the default) retries only failures the action reported as temporary, such as a timeout reaching the provider. `any` also retries failures that were not classified. Actions that must not be repeated blindly accept only `transient`.","default":"transient","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].retry_policy.oneOf.0.retry_on","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].retry_policy.oneOf.0","typeLabel":"TaskRetryPolicy · object"},{"type":"null","description":"How this task re-attempts itself after a failure. Honoured only when `on_failure` is `retry`, and accepted only for actions the catalog considers safe to repeat. Omit it and a failing task is not re-attempted.","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].retry_policy.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX].retry_policy","typeLabel":"TaskRetryPolicy · object | null"}},"type":"object","required":["task_id","task_name","platform_id","service_id","action_id"],"title":"Task","uniqueKey":"steps.items.[INDEX].tasks.items.[INDEX]","typeLabel":"Task · object"},"type":"array","title":"Tasks","uniqueKey":"steps.items.[INDEX].tasks","typeLabel":"Task · object[]"},"exit_conditions":{"items":{"properties":{"condition":{"type":"string","title":"Condition","isRequired":true,"uniqueKey":"steps.items.[INDEX].exit_conditions.items.[INDEX].condition","typeLabel":"string"},"action":{"type":"string","enum":["continue","abort_execution","trigger_definition","skip_next_step"],"title":"Action","isRequired":true,"uniqueKey":"steps.items.[INDEX].exit_conditions.items.[INDEX].action","typeLabel":"enum\u003cstring>"},"reason":{"oneOf":[{"type":"string","title":"Reason","uniqueKey":"steps.items.[INDEX].exit_conditions.items.[INDEX].reason.oneOf.0","typeLabel":"string"},{"type":"null","title":"Reason","uniqueKey":"steps.items.[INDEX].exit_conditions.items.[INDEX].reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].exit_conditions.items.[INDEX].reason","typeLabel":"string | null"},"definition_id":{"oneOf":[{"type":"string","title":"Definition Id","uniqueKey":"steps.items.[INDEX].exit_conditions.items.[INDEX].definition_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Definition Id","uniqueKey":"steps.items.[INDEX].exit_conditions.items.[INDEX].definition_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].exit_conditions.items.[INDEX].definition_id","typeLabel":"string | null"},"inputs":{"oneOf":[{"type":"object","title":"Inputs","additionalProperties":true,"uniqueKey":"steps.items.[INDEX].exit_conditions.items.[INDEX].inputs.oneOf.0","typeLabel":"Inputs · object"},{"type":"null","title":"Inputs","uniqueKey":"steps.items.[INDEX].exit_conditions.items.[INDEX].inputs.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].exit_conditions.items.[INDEX].inputs","typeLabel":"Inputs · object | null"}},"type":"object","required":["condition","action"],"title":"ExitCondition","uniqueKey":"steps.items.[INDEX].exit_conditions.items.[INDEX]","typeLabel":"ExitCondition · object"},"type":"array","title":"Exit Conditions","uniqueKey":"steps.items.[INDEX].exit_conditions","typeLabel":"ExitCondition · object[]"}},"type":"object","required":["step_id"],"title":"Step","uniqueKey":"steps.items.[INDEX]","typeLabel":"Step · object"},"type":"array","title":"Steps","isRequired":true,"uniqueKey":"steps","typeLabel":"Step · object[]"},"webhooks":{"items":{"oneOf":[{}],"uniqueKey":"webhooks.items.[INDEX]","typeLabel":"any"},"type":"array","title":"Webhooks","isRequired":true,"uniqueKey":"webhooks","typeLabel":"any[]"},"variable_bindings":{"additionalProperties":{"type":"string","uniqueKey":"variable_bindings.additionalProperties","typeLabel":"string"},"type":"object","title":"Variable Bindings","uniqueKey":"variable_bindings","typeLabel":"Variable Bindings · object"},"template_ref":{"oneOf":[{"type":"object","title":"TemplateRef","description":"Present when this flow was created for your account from a managed template, naming that template, the version it was created at and a digest of the content it started with. `null` for a flow you built yourself. Read-only — it is stamped when the flow is created and is not accepted when you create or update one.","required":["template_id","template_version","template_hash","seeded_at"],"properties":{"template_id":{"type":"string","minLength":1,"title":"Template Id","isRequired":true,"uniqueKey":"template_ref.oneOf.0.template_id","typeLabel":"string"},"template_version":{"type":"integer","minimum":1,"title":"Template Version","isRequired":true,"uniqueKey":"template_ref.oneOf.0.template_version","typeLabel":"integer"},"template_hash":{"type":"string","minLength":1,"title":"Template Hash","isRequired":true,"uniqueKey":"template_ref.oneOf.0.template_hash","typeLabel":"string"},"seeded_at":{"type":"string","format":"date-time","title":"Seeded At","isRequired":true,"uniqueKey":"template_ref.oneOf.0.seeded_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"template_ref.oneOf.0","typeLabel":"TemplateRef · object"},{"type":"null","description":"Present when this flow was created for your account from a managed template, naming that template, the version it was created at and a digest of the content it started with. `null` for a flow you built yourself. Read-only — it is stamped when the flow is created and is not accepted when you create or update one.","uniqueKey":"template_ref.oneOf.1","typeLabel":"null"}],"uniqueKey":"template_ref","typeLabel":"TemplateRef · object | null"},"searchable_inputs":{"items":{"type":"string","uniqueKey":"searchable_inputs.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Searchable Inputs","description":"Which of this flow's inputs a run can be found by. Name up to 5 inputs — or dotted paths into one, such as `customer.phone` — and each run of this flow records those values so you can look the run up by them later with `attr.\u003ckey>` on the executions list. The key is the path lowercased with dots replaced by underscores, so `customer.phone` is searched as `attr.customer_phone`. Values are captured when the run starts and never change afterwards, phone-shaped values are stored in international format, and anything longer than 256 characters is shortened. Naming an input this flow does not declare is rejected.","uniqueKey":"searchable_inputs","typeLabel":"string[]"}},"type":"object","required":["id","org_id","name","version","status","inputs","variables","steps","webhooks"],"title":"DefinitionResponse","example":{"id":"def_a1b2c3d4","inputs":[],"name":"Nightly Five9 report sync","org_id":"org_a1b2c3d4","status":"active","steps":[],"variables":[],"version":1,"webhooks":[]},"uniqueKey":"","typeLabel":"DefinitionResponse · object"},"examples":{"Example":{"title":"Example","value":{"id":"def_a1b2c3d4","inputs":[],"name":"Nightly Five9 report sync","org_id":"org_a1b2c3d4","status":"active","steps":[],"variables":[],"version":1,"webhooks":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"2a48d522-37ae-48d8-a0b2-643c8e984656":{"description":"Missing or invalid authentication","content":{"application/json":{"example":{"detail":"Authentication required"},"examples":{"Example":{"title":"Example","value":{"detail":"Authentication required"}}},"exampleType":"examples"}},"exampleType":"examples"},"668fcb97-f432-4757-beec-0439e9e287a5":{"description":"No such definition for this organization (cross-tenant access also returns 404)","content":{"application/json":{"example":{"detail":"Definition not found"},"examples":{"Example":{"title":"Example","value":{"detail":"Definition not found"}}},"exampleType":"examples"}},"exampleType":"examples"},"bff7b318-e239-4883-87cf-81c5ced8621d":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"c8b179ae-96f6-41d2-87c0-8bf857b8cb36":{"description":"Rate limit exceeded — retry after the Retry-After header","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"content":{"application/json":{"example":{"detail":"Rate limit exceeded: 100 per 1 minute"},"examples":{"Example":{"title":"Example","value":{"detail":"Rate limit exceeded: 100 per 1 minute"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"22272e7e-efa3-4bc1-88b2-17265d63a68c":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[],"schemeName":"APIKeyHeader"}},"3d2a8525-449e-441e-8159-84ee1c969f89":{"HTTPBearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"HTTPBearer"}}},"servers":{"46b27330-8729-49f8-bc01-5b7026690c37":{"url":"https://api.getdialed.ai/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[],"schemeName":"APIKeyHeader"},"schema":{"title":"X-API-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"APIKeyHeader","name":"X-API-Key"}],"title":"APIKeyHeader"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"HTTPBearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"HTTPBearer","name":"Authorization"}],"title":"HTTPBearer"}]},"originalFileLocation":"openapi.json"},"subdomain":"getdialed","siteName":"GetDialed Docs","title":"Get a definition - GetDialed Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T15:46:43.075Z","originalFileLocation":"api-reference/definitions/get-a-definition.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=\"Fetch a single flow definition by id. Cross-tenant access returns 404.\">\u003cmeta data-mint-head name=\"application-name\" content=\"GetDialed Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/getdialed/W4q54Y-ijV9_76KA/_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/getdialed/W4q54Y-ijV9_76KA/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/getdialed/W4q54Y-ijV9_76KA/_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/getdialed/W4q54Y-ijV9_76KA/_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/getdialed/W4q54Y-ijV9_76KA/_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/getdialed/W4q54Y-ijV9_76KA/_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/getdialed/W4q54Y-ijV9_76KA/_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/getdialed/W4q54Y-ijV9_76KA/_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/getdialed/W4q54Y-ijV9_76KA/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a definition - GetDialed Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Fetch a single flow definition by id. Cross-tenant access returns 404.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"GetDialed Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.getdialed.ai/api-reference/definitions/get-a-definition\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://getdialed.mintlify.app/_mintlify/api/og/v2?division=Definitions\u0026amp;title=Get+a+definition\u0026amp;description=Fetch+a+single+flow+definition+by+id.+Cross-tenant+access+returns+404.\u0026amp;theme=b6a8f417cb6da704c51ca7d7\u0026amp;signature=93b300646dd5b2b32ef988da501692e4158a950bc5fb0117d52157cc4269726c\">\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 a definition - GetDialed Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Fetch a single flow definition by id. Cross-tenant access returns 404.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://getdialed.mintlify.app/_mintlify/api/og/v2?division=Definitions\u0026amp;title=Get+a+definition\u0026amp;description=Fetch+a+single+flow+definition+by+id.+Cross-tenant+access+returns+404.\u0026amp;theme=b6a8f417cb6da704c51ca7d7\u0026amp;signature=93b300646dd5b2b32ef988da501692e4158a950bc5fb0117d52157cc4269726c\">\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/getdialed/W4q54Y-ijV9_76KA/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"GetDialed Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4F46E5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.getdialed.ai/api-reference/definitions/get-a-definition\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/definitions/get-a-definition.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.getdialed.ai/#organization\",\"name\":\"GetDialed Docs\",\"url\":\"https://docs.getdialed.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/getdialed/aL0yqdSUKnvM2urY/logo/light.svg?fit=max\u0026auto=format\u0026n=aL0yqdSUKnvM2urY\u0026q=85\u0026s=f6bd462ed94234572b2ef5546432f2e6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.getdialed.ai#website\",\"name\":\"GetDialed Docs\",\"url\":\"https://docs.getdialed.ai\",\"publisher\":{\"@id\":\"https://docs.getdialed.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.getdialed.ai/api-reference/definitions/get-a-definition#webpage\",\"url\":\"https://docs.getdialed.ai/api-reference/definitions/get-a-definition\",\"name\":\"Get a definition\",\"description\":\"Fetch a single flow definition by id. Cross-tenant access returns 404.\",\"dateModified\":\"2026-10-22T15:46:43.075Z\",\"isPartOf\":{\"@id\":\"https://docs.getdialed.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.getdialed.ai/api-reference/definitions/get-a-definition#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.getdialed.ai/api-reference/definitions/get-a-definition#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Flows — /v1/flows\",\"item\":\"https://docs.getdialed.ai/api-reference/definitions/list-definitions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Definitions\",\"item\":\"https://docs.getdialed.ai/api-reference/definitions/list-definitions\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a definition\",\"item\":\"https://docs.getdialed.ai/api-reference/definitions/get-a-definition\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.getdialed.ai/api-reference/definitions/get-a-definition#apireference\",\"headline\":\"Get a definition\",\"name\":\"Get a definition\",\"description\":\"Fetch a single flow definition by id. Cross-tenant access returns 404.\",\"url\":\"https://docs.getdialed.ai/api-reference/definitions/get-a-definition\",\"mainEntityOfPage\":{\"@id\":\"https://docs.getdialed.ai/api-reference/definitions/get-a-definition#webpage\"},\"dateModified\":\"2026-10-22T15:46:43.075Z\",\"publisher\":{\"@id\":\"https://docs.getdialed.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.getdialed.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"GetDialed Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"GetDialed Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API introduction","href":"/api-reference/introduction"},{"title":"Dispatch pause \u0026 resume","href":"/api-reference/dispatch-pause"},{"title":"Change a batch's priority or pacing","href":"/api-reference/batch-patch"}]},{"group":"Flows — /v1/flows","pages":[{"group":"Definitions","pages":[{"title":"List definitions","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/definitions","href":"/api-reference/definitions/list-definitions"},{"title":"Create a definition","description":"Create a flow definition. Admin only. Expressions in the definition body are validated at creation time; malformed expressions return 422.","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/definitions","href":"/api-reference/definitions/create-a-definition"},{"title":"Get a definition","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/definitions/{definition_id}","href":"/api-reference/definitions/get-a-definition"},{"title":"Update a definition","description":"Replace a flow definition's fields. Admin only. Cross-tenant access returns 404.","deprecated":null,"version":null,"openapi":"/openapi.json put /flows/definitions/{definition_id}","href":"/api-reference/definitions/update-a-definition"},{"title":"Delete a definition","deprecated":null,"version":null,"openapi":"/openapi.json delete /flows/definitions/{definition_id}","href":"/api-reference/definitions/delete-a-definition"},{"title":"Trigger a definition","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/definitions/{definition_id}/trigger","href":"/api-reference/definitions/trigger-a-definition"},{"title":"List batches for a definition","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/definitions/{definition_id}/batches","href":"/api-reference/batches/list-batches-for-a-definition"}]},{"group":"Templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/templates","href":"/api-reference/templates/list-templates"},{"title":"Get a template","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/templates/{template_id}","href":"/api-reference/templates/get-a-template"}]},{"group":"Schedules","pages":[{"title":"List schedules","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/schedules","href":"/api-reference/schedules/list-schedules"},{"title":"Create a schedule","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/schedules","href":"/api-reference/schedules/create-a-schedule"},{"title":"Get a schedule","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/schedules/{sched_id}","href":"/api-reference/schedules/get-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/openapi.json patch /flows/schedules/{sched_id}","href":"/api-reference/schedules/update-a-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/openapi.json delete /flows/schedules/{sched_id}","href":"/api-reference/schedules/delete-a-schedule"}]},{"group":"Triggers","pages":[{"title":"List triggers","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/triggers","href":"/api-reference/triggers/list-triggers"},{"title":"Get a trigger","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/triggers/{trigger_id}","href":"/api-reference/triggers/get-a-trigger"},{"title":"List the batches a trigger spawned","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/triggers/{trigger_id}/batches","href":"/api-reference/triggers/list-the-batches-a-trigger-spawned"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Create a webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/webhooks","href":"/api-reference/webhooks/create-a-webhook"},{"title":"Get a webhook","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/webhooks/{webhook_id}","href":"/api-reference/webhooks/get-a-webhook"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"/openapi.json patch /flows/webhooks/{webhook_id}","href":"/api-reference/webhooks/update-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"/openapi.json delete /flows/webhooks/{webhook_id}","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"Rotate a webhook signing secret","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/webhooks/{webhook_id}/rotate-secret","href":"/api-reference/webhooks/rotate-a-webhook-signing-secret"},{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/webhooks/{webhook_id}/deliveries","href":"/api-reference/webhooks/list-webhook-deliveries"},{"title":"Receive a webhook (called by your external system)","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/webhooks/{slug}/{webhook_id}","href":"/api-reference/webhooks/receive-a-webhook-called-by-your-external-system"},{"title":"Five9 import callback (called by Five9, not by you)","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/webhooks/five9-import/{slug}/{token}","href":"/api-reference/webhooks/five9-import-callback-called-by-five9-not-by-you"}]},{"group":"Event Subscriptions","pages":[{"title":"List event subscriptions","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/event-subscriptions","href":"/api-reference/event-subscriptions/list-event-subscriptions"},{"title":"Create an event subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/event-subscriptions","href":"/api-reference/event-subscriptions/create-an-event-subscription"},{"title":"Get an event subscription","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/event-subscriptions/{sub_id}","href":"/api-reference/event-subscriptions/get-an-event-subscription"},{"title":"Delete an event subscription","deprecated":null,"version":null,"openapi":"/openapi.json delete /flows/event-subscriptions/{sub_id}","href":"/api-reference/event-subscriptions/delete-an-event-subscription"}]},{"group":"Batches","pages":[{"title":"List account-wide batches","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/batches","href":"/api-reference/batches/list-account-wide-batches"},{"title":"Get a batch","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/batches/{batch_id}","href":"/api-reference/batches/get-a-batch"},{"title":"Change a batch's priority or pacing","deprecated":null,"version":null,"openapi":"/openapi.json patch /flows/batches/{batch_id}","href":"/api-reference/batches/change-a-batchs-priority-or-pacing"},{"title":"Cancel a batch","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/batches/{batch_id}/cancel","href":"/api-reference/batches/cancel-a-batch"},{"title":"Cancel a batch (deprecated)","deprecated":true,"version":null,"openapi":"/openapi.json delete /flows/batches/{batch_id}","href":"/api-reference/batches/cancel-a-batch-deprecated"},{"title":"Pause dispatch for a batch","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/batches/{batch_id}/pause","href":"/api-reference/batches/pause-dispatch-for-a-batch"},{"title":"Resume dispatch for a batch","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/batches/{batch_id}/resume","href":"/api-reference/batches/resume-dispatch-for-a-batch"},{"title":"Requeue a batch's held work","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/batches/{batch_id}/requeue","href":"/api-reference/batches/requeue-a-batchs-held-work"},{"title":"List executions for a batch","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/batches/{batch_id}/executions","href":"/api-reference/executions/list-executions-for-a-batch"},{"title":"Stream batch events (SSE)","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/batches/{batch_id}/stream","href":"/api-reference/streams/stream-batch-events-sse"}]},{"group":"Executions","pages":[{"title":"Get an execution","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/executions/{execution_id}","href":"/api-reference/executions/get-an-execution"},{"title":"Stream execution events (SSE)","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/executions/{execution_id}/stream","href":"/api-reference/streams/stream-execution-events-sse"}]},{"group":"Jobs \u0026 Exports","pages":[{"title":"List account-wide jobs","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/jobs","href":"/api-reference/jobs/list-account-wide-jobs"},{"title":"Get a job","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/jobs/{job_id}","href":"/api-reference/jobs/get-a-job"},{"title":"Request a CSV export of your jobs","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/jobs/export","href":"/api-reference/jobs/request-a-csv-export-of-your-jobs"},{"title":"Get an export and its download URL","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/jobs/exports/{export_id}","href":"/api-reference/jobs/get-an-export-and-its-download-url"}]},{"group":"Variables","pages":[{"title":"List variable sets","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/variables","href":"/api-reference/variables/list-variable-sets"},{"title":"Create a variable set","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/variables","href":"/api-reference/variables/create-a-variable-set"},{"title":"Get a variable set","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/variables/{set_name}","href":"/api-reference/variables/get-a-variable-set"},{"title":"Update or rename a variable set","deprecated":null,"version":null,"openapi":"/openapi.json put /flows/variables/{set_name}","href":"/api-reference/variables/update-or-rename-a-variable-set"},{"title":"Delete a variable set","deprecated":null,"version":null,"openapi":"/openapi.json delete /flows/variables/{set_name}","href":"/api-reference/variables/delete-a-variable-set"},{"title":"Add a version to a set","deprecated":null,"version":null,"openapi":"/openapi.json post /flows/variables/{set_name}/versions","href":"/api-reference/variables/add-a-version-to-a-set"},{"title":"Update or rename a version","deprecated":null,"version":null,"openapi":"/openapi.json put /flows/variables/{set_name}/versions/{version_name}","href":"/api-reference/variables/update-or-rename-a-version"},{"title":"Delete a version","deprecated":null,"version":null,"openapi":"/openapi.json delete /flows/variables/{set_name}/versions/{version_name}","href":"/api-reference/variables/delete-a-version"}]},{"group":"Dashboard \u0026 Usage","pages":[{"title":"Get the dashboard summary","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/dashboard/summary","href":"/api-reference/dashboard/get-the-dashboard-summary"},{"title":"Get usage analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/usage","href":"/api-reference/usage/get-usage-analytics"}]}]},{"group":"Account — /v1/account","pages":[{"title":"Get current session context","deprecated":null,"version":null,"openapi":"/openapi.json get /account/me","href":"/api-reference/me/get-current-session-context"},{"title":"List API keys","deprecated":null,"version":null,"openapi":"/openapi.json get /account/api-keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"/openapi.json post /account/api-keys","href":"/api-reference/api-keys/create-an-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"/openapi.json delete /account/api-keys/{key_id}","href":"/api-reference/api-keys/revoke-an-api-key"},{"title":"Mint a stream token","deprecated":null,"version":null,"openapi":"/openapi.json post /account/auth/stream-token","href":"/api-reference/auth/mint-a-stream-token"}]},{"group":"Data — /v1/data","pages":[{"title":"Create a record set","deprecated":null,"version":null,"openapi":"/openapi.json post /data/record-sets","href":"/api-reference/record-sets/create-a-record-set"},{"title":"Get a record set","deprecated":null,"version":null,"openapi":"/openapi.json get /data/record-sets/{record_set_id}","href":"/api-reference/record-sets/get-a-record-set"},{"title":"Upload one chunk of records","deprecated":null,"version":null,"openapi":"/openapi.json post /data/record-sets/{record_set_id}/records","href":"/api-reference/record-sets/upload-one-chunk-of-records"},{"title":"Seal a record set","deprecated":null,"version":null,"openapi":"/openapi.json post /data/record-sets/{record_set_id}/seal","href":"/api-reference/record-sets/seal-a-record-set"},{"title":"List data stores","deprecated":null,"version":null,"openapi":"/openapi.json get /data/stores","href":"/api-reference/data-stores/list-data-stores"},{"title":"Get a data store","deprecated":null,"version":null,"openapi":"/openapi.json get /data/stores/{store}","href":"/api-reference/data-stores/get-a-data-store"},{"title":"List store records","deprecated":null,"version":null,"openapi":"/openapi.json get /data/stores/{store}/records","href":"/api-reference/data-stores/list-store-records"},{"title":"Get a store record","deprecated":null,"version":null,"openapi":"/openapi.json get /data/stores/{store}/records/{key}","href":"/api-reference/data-stores/get-a-store-record"},{"title":"Edit a store record","deprecated":null,"version":null,"openapi":"/openapi.json patch /data/stores/{store}/records/{key}","href":"/api-reference/data-stores/edit-a-store-record"},{"title":"Get a store record's history","deprecated":null,"version":null,"openapi":"/openapi.json get /data/stores/{store}/records/{key}/history","href":"/api-reference/data-stores/get-a-store-records-history"},{"title":"Get a store's precedence settings","deprecated":null,"version":null,"openapi":"/openapi.json get /data/stores/{store}/precedence","href":"/api-reference/data-stores/get-a-stores-precedence-settings"},{"title":"Set a store's precedence settings","deprecated":null,"version":null,"openapi":"/openapi.json put /data/stores/{store}/precedence","href":"/api-reference/data-stores/set-a-stores-precedence-settings"},{"title":"Reset a store's precedence settings","deprecated":null,"version":null,"openapi":"/openapi.json delete /data/stores/{store}/precedence","href":"/api-reference/data-stores/reset-a-stores-precedence-settings"}]},{"group":"Catalog — /v1/catalog","pages":[{"title":"List platforms","deprecated":null,"version":null,"openapi":"/openapi.json get /catalog/platforms","href":"/api-reference/catalog/list-platforms"},{"title":"Get a platform","deprecated":null,"version":null,"openapi":"/openapi.json get /catalog/platforms/{platform_id}","href":"/api-reference/catalog/get-a-platform"},{"title":"List services for a platform","deprecated":null,"version":null,"openapi":"/openapi.json get /catalog/platforms/{platform_id}/services","href":"/api-reference/catalog/list-services-for-a-platform"},{"title":"Get a service","deprecated":null,"version":null,"openapi":"/openapi.json get /catalog/services/{service_id}","href":"/api-reference/catalog/get-a-service"},{"title":"List actions for a service","deprecated":null,"version":null,"openapi":"/openapi.json get /catalog/services/{service_id}/actions","href":"/api-reference/catalog/list-actions-for-a-service"},{"title":"Get an action","deprecated":null,"version":null,"openapi":"/openapi.json get /catalog/actions/{action_id}","href":"/api-reference/catalog/get-an-action"}]},{"group":"Credentials — /v1/credentials","pages":[{"title":"List credentials","deprecated":null,"version":null,"openapi":"/openapi.json get /credentials","href":"/api-reference/credentials/list-credentials"},{"title":"Create a credential","deprecated":null,"version":null,"openapi":"/openapi.json post /credentials","href":"/api-reference/credentials/create-a-credential"},{"title":"Get a credential","deprecated":null,"version":null,"openapi":"/openapi.json get /credentials/{credential_id}","href":"/api-reference/credentials/get-a-credential"},{"title":"Update a credential","deprecated":null,"version":null,"openapi":"/openapi.json put /credentials/{credential_id}","href":"/api-reference/credentials/update-a-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/openapi.json delete /credentials/{credential_id}","href":"/api-reference/credentials/delete-a-credential"},{"title":"Test credentials without saving them","deprecated":null,"version":null,"openapi":"/openapi.json post /credentials/test","href":"/api-reference/credentials/test-credentials-without-saving-them"},{"title":"Test a saved credential","deprecated":null,"version":null,"openapi":"/openapi.json post /credentials/{credential_id}/test","href":"/api-reference/credentials/test-a-saved-credential"}]},{"group":"Tenants — /v1/tenants","pages":[{"title":"List tenants","deprecated":null,"version":null,"openapi":"/openapi.json get /tenants","href":"/api-reference/tenants/list-tenants"},{"title":"Get a tenant","deprecated":null,"version":null,"openapi":"/openapi.json get /tenants/{tenancy_id}","href":"/api-reference/tenants/get-a-tenant"},{"title":"Rename a tenant","deprecated":null,"version":null,"openapi":"/openapi.json patch /tenants/{tenancy_id}","href":"/api-reference/tenants/rename-a-tenant"},{"title":"Retire a tenant","deprecated":null,"version":null,"openapi":"/openapi.json delete /tenants/{tenancy_id}","href":"/api-reference/tenants/retire-a-tenant"}]},{"group":"Five9 Domains — /v1/platforms/five9","pages":[{"title":"List Five9 Domains","deprecated":null,"version":null,"openapi":"/openapi.json get /platforms/five9/domains","href":"/api-reference/five9-domains/list-five9-domains"},{"title":"Get a Five9 Domain","deprecated":null,"version":null,"openapi":"/openapi.json get /platforms/five9/domains/{tenancy_id}","href":"/api-reference/five9-domains/get-a-five9-domain"},{"title":"Update a Five9 Domain's margins and lanes","deprecated":null,"version":null,"openapi":"/openapi.json patch /platforms/five9/domains/{tenancy_id}","href":"/api-reference/five9-domains/update-a-five9-domains-margins-and-lanes"},{"title":"Read a Domain's remaining budget per bucket","deprecated":null,"version":null,"openapi":"/openapi.json get /platforms/five9/domains/{tenancy_id}/headroom","href":"/api-reference/five9-domains/read-a-domains-remaining-budget-per-bucket"},{"title":"Read a Domain's queue depth and estimated completion","deprecated":null,"version":null,"openapi":"/openapi.json get /platforms/five9/domains/{tenancy_id}/queue","href":"/api-reference/five9-domains/read-a-domains-queue-depth-and-estimated-completion"},{"title":"Read a Domain's recent rate-limit usage history","deprecated":null,"version":null,"openapi":"/openapi.json get /platforms/five9/domains/{tenancy_id}/usage","href":"/api-reference/five9-domains/read-a-domains-recent-rate-limit-usage-history"},{"title":"Read per-credential budget attribution for a Domain","deprecated":null,"version":null,"openapi":"/openapi.json get /platforms/five9/domains/{tenancy_id}/attribution","href":"/api-reference/five9-domains/read-per-credential-budget-attribution-for-a-domain"},{"title":"Estimate what an upload will cost against a Domain's budget","deprecated":null,"version":null,"openapi":"/openapi.json post /platforms/five9/domains/{tenancy_id}/estimate","href":"/api-reference/five9-domains/estimate-what-an-upload-will-cost-against-a-domains-budget"},{"title":"Refresh a Five9 Domain's live limits","deprecated":null,"version":null,"openapi":"/openapi.json post /platforms/five9/domains/{tenancy_id}/refresh-limits","href":"/api-reference/five9-domains/refresh-a-five9-domains-live-limits"},{"title":"Pause dispatch for a Five9 Domain","deprecated":null,"version":null,"openapi":"/openapi.json post /platforms/five9/domains/{tenancy_id}/pause","href":"/api-reference/five9-domains/pause-dispatch-for-a-five9-domain"},{"title":"Resume dispatch for a Five9 Domain","deprecated":null,"version":null,"openapi":"/openapi.json post /platforms/five9/domains/{tenancy_id}/resume","href":"/api-reference/five9-domains/resume-dispatch-for-a-five9-domain"},{"title":"List everything holding this Domain's dispatch","deprecated":null,"version":null,"openapi":"/openapi.json get /platforms/five9/domains/{tenancy_id}/pauses","href":"/api-reference/five9-domains/list-everything-holding-this-domains-dispatch"},{"title":"Extend a Domain pause's scheduled resume","deprecated":null,"version":null,"openapi":"/openapi.json patch /platforms/five9/domains/{tenancy_id}/pauses/{pause_id}","href":"/api-reference/five9-domains/extend-a-domain-pauses-scheduled-resume"}]},{"group":"Admin — /v1/admin","pages":[{"title":"Reference data status","href":"/api-reference/reference-status"},{"title":"Pause all dispatch (break-glass)","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/dispatch/pause","href":"/api-reference/dispatch/pause-all-dispatch-break-glass"},{"title":"Resume all dispatch (break-glass)","deprecated":null,"version":null,"openapi":"/openapi.json post /admin/dispatch/resume","href":"/api-reference/dispatch/resume-all-dispatch-break-glass"},{"title":"List everything holding dispatch","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/dispatch/pauses","href":"/api-reference/dispatch/list-everything-holding-dispatch"},{"title":"Get one pause record","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/dispatch/pauses/{pause_id}","href":"/api-reference/dispatch/get-one-pause-record"},{"title":"Reference data freshness","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/reference/status","href":"/api-reference/reference-data/reference-data-freshness"},{"title":"Inbound delivery counts by status","deprecated":null,"version":null,"openapi":"/openapi.json get /admin/vendor-deliveries/counts","href":"/api-reference/vendor-deliveries/inbound-delivery-counts-by-status"}]}]}]},"basePath":"","title":"Get a definition - GetDialed Docs","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}