{
"detail": "margins['Upload'] must be between 1 and 100"
}
{
"detail": "Rate limit exceeded: 100 per 1 minute"
}
Five9 Domains — /v1/platforms/five9
Get a Five9 Domain
Fetch one Five9 Domain, including its per-bucket raw provider caps, the margin_pct safety margin, the effective budget computed from both, the action → rate-bucket map, and any lane overrides. sync_status reports whether the caps are provider-observed (live), catalog defaults (catalog_default), or the result of a refresh that returned unusable counters (stale). Readable by any organization member. Cross-tenant access returns 404, never 403.
GET
/
platforms
/
five9
/
domains
/
{tenancy_id}
Get a Five9 Domain
curl --request GET \ --url https://api.getdialed.ai/v1/platforms/five9/domains/{tenancy_id} \ --header 'X-API-Key: <api-key>'
One Five9 Domain: the provider-tenant record that anchors rate limits.
N Connections resolving to the same Domain share ONE quota budget. Each
rate bucket reports the provider's raw caps per time window, the
operator's margin_pct safety margin, and the effective budget computed
from both. min_interval_ms is the minimum spacing enforced between two
consecutive calls on the bucket — a floor applied on top of the window
budget, so a bucket well inside its hourly cap can still be paced; null
means no explicit floor, and the margin is not applied to it. tenancy_unit
carries the platform's own vocabulary for this
record so it can be labelled correctly without a second lookup, and
sync_status reports whether the caps are provider-observed (live),
catalog defaults (catalog_default), or unchanged after a refresh returned
unusable counters (stale).
{"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/five9-domains/get-a-five9-domain","slug":"/api-reference/five9-domains/get-a-five9-domain","pageMetadata":{"title":"Get a Five9 Domain","description":"Fetch one Five9 Domain, including its per-bucket raw provider `caps`, the `margin_pct` safety margin, the `effective` budget computed from both, the action → rate-bucket map, and any lane overrides. `sync_status` reports whether the caps are provider-observed (`live`), catalog defaults (`catalog_default`), or the result of a refresh that returned unusable counters (`stale`). Readable by any organization member. Cross-tenant access returns 404, never 403.","deprecated":null,"version":null,"openapi":"/openapi.json get /platforms/five9/domains/{tenancy_id}","href":"/api-reference/five9-domains/get-a-five9-domain","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Fetch one Five9 Domain, including its per-bucket raw provider \", _jsx(_components.code, {\n children: \"caps\"\n }), \", the \", _jsx(_components.code, {\n children: \"margin_pct\"\n }), \" safety margin, the \", _jsx(_components.code, {\n children: \"effective\"\n }), \" budget computed from both, the action → rate-bucket map, and any lane overrides. \", _jsx(_components.code, {\n children: \"sync_status\"\n }), \" reports whether the caps are provider-observed (\", _jsx(_components.code, {\n children: \"live\"\n }), \"), catalog defaults (\", _jsx(_components.code, {\n children: \"catalog_default\"\n }), \"), or the result of a refresh that returned unusable counters (\", _jsx(_components.code, {\n children: \"stale\"\n }), \"). Readable by any organization member. Cross-tenant access returns 404, never 403.\"]\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 Five9 Domain","description":"Fetch one Five9 Domain, including its per-bucket raw provider `caps`, the `margin_pct` safety margin, the `effective` budget computed from both, the action → rate-bucket map, and any lane overrides. `sync_status` reports whether the caps are provider-observed (`live`), catalog defaults (`catalog_default`), or the result of a refresh that returned unusable counters (`stale`). Readable by any organization member. Cross-tenant access returns 404, never 403.","deprecated":null,"version":null,"openapi":"/openapi.json get /platforms/five9/domains/{tenancy_id}","href":"/api-reference/five9-domains/get-a-five9-domain","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["five9-domains"],"summary":"Get a Five9 Domain","description":"Fetch one Five9 Domain, including its per-bucket raw provider `caps`, the `margin_pct` safety margin, the `effective` budget computed from both, the action → rate-bucket map, and any lane overrides. `sync_status` reports whether the caps are provider-observed (`live`), catalog defaults (`catalog_default`), or the result of a refresh that returned unusable counters (`stale`). Readable by any organization member. Cross-tenant access returns 404, never 403.","operationId":"get_five9_domain_platforms_five9_domains__tenancy_id__get","security":["649d44b1-4731-4d92-9591-9700cea4db45","041636a3-2274-4017-84d6-63e3d99d7dca"],"parameters":["451a79cb-ba7d-450a-b4e4-de46714e6a1e"],"responses":{"200":"65eef755-f171-4b34-91db-51e41086f9f2","401":"bfa90878-48ba-480f-b946-3335ac5977b0","404":"98872840-c03e-4bd9-bee7-5c65fdc1e8bd","422":"bf0c47af-c7b4-4101-a104-30fdb816d396","429":"468fc12e-234b-4669-8643-356e51fb015d"},"method":"get","type":"path","servers":["46b27330-8729-49f8-bc01-5b7026690c37"],"path":"/platforms/five9/domains/{tenancy_id}","baseUrlOptions":["https://api.getdialed.ai/v1"],"title":"Get a Five9 Domain","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"451a79cb-ba7d-450a-b4e4-de46714e6a1e":{"name":"tenancy_id","in":"path","required":true,"schema":{"type":"string","title":"Tenancy Id","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"65eef755-f171-4b34-91db-51e41086f9f2":{"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"},"platform_id":{"type":"string","title":"Platform Id","isRequired":true,"uniqueKey":"platform_id","typeLabel":"string"},"domain_id":{"type":"string","title":"Domain Id","isRequired":true,"uniqueKey":"domain_id","typeLabel":"string"},"domain_name":{"type":"string","title":"Domain Name","isRequired":true,"uniqueKey":"domain_name","typeLabel":"string"},"api_host":{"type":"string","title":"Api Host","isRequired":true,"uniqueKey":"api_host","typeLabel":"string"},"tenancy_unit":{"additionalProperties":true,"type":"object","title":"Tenancy Unit","isRequired":true,"uniqueKey":"tenancy_unit","typeLabel":"Tenancy Unit · object"},"buckets":{"additionalProperties":{"additionalProperties":true,"type":"object","uniqueKey":"buckets.additionalProperties","typeLabel":"object"},"type":"object","title":"Buckets","isRequired":true,"uniqueKey":"buckets","typeLabel":"Buckets · object"},"bucket_map":{"additionalProperties":{"additionalProperties":true,"type":"object","uniqueKey":"bucket_map.additionalProperties","typeLabel":"object"},"type":"object","title":"Bucket Map","isRequired":true,"uniqueKey":"bucket_map","typeLabel":"Bucket Map · object"},"lane_overrides":{"additionalProperties":{"type":"string","uniqueKey":"lane_overrides.additionalProperties","typeLabel":"string"},"type":"object","title":"Lane Overrides","isRequired":true,"uniqueKey":"lane_overrides","typeLabel":"Lane Overrides · object"},"lane_order":{"additionalProperties":{"items":{"type":"string","uniqueKey":"lane_order.additionalProperties.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"lane_order.additionalProperties","typeLabel":"string[]"},"type":"object","title":"Lane Order","isRequired":true,"uniqueKey":"lane_order","typeLabel":"Lane Order · object"},"sync_status":{"type":"string","title":"Sync Status","isRequired":true,"uniqueKey":"sync_status","typeLabel":"string"},"counters_synced_at":{"oneOf":[{"type":"string","title":"Counters Synced At","format":"date-time","isRequired":true,"uniqueKey":"counters_synced_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Counters Synced At","isRequired":true,"uniqueKey":"counters_synced_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"counters_synced_at","typeLabel":"string\u003cdate-time> | null"},"status":{"type":"string","title":"Status","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","title":"Created At","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"oneOf":[{"type":"string","title":"Updated At","format":"date-time","isRequired":true,"uniqueKey":"updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Updated At","isRequired":true,"uniqueKey":"updated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time> | null"}},"type":"object","required":["id","org_id","platform_id","domain_id","domain_name","api_host","tenancy_unit","buckets","bucket_map","lane_overrides","lane_order","sync_status","counters_synced_at","status","created_at","updated_at"],"title":"Five9DomainResponse","description":"One Five9 Domain: the provider-tenant record that anchors rate limits.\n\nN Connections resolving to the same Domain share ONE quota budget. Each\nrate bucket reports the provider's raw `caps` per time window, the\noperator's `margin_pct` safety margin, and the `effective` budget computed\nfrom both. `min_interval_ms` is the minimum spacing enforced between two\nconsecutive calls on the bucket — a floor applied on top of the window\nbudget, so a bucket well inside its hourly cap can still be paced; `null`\nmeans no explicit floor, and the margin is not applied to it. `tenancy_unit`\ncarries the platform's own vocabulary for this\nrecord so it can be labelled correctly without a second lookup, and\n`sync_status` reports whether the caps are provider-observed (`live`),\ncatalog defaults (`catalog_default`), or unchanged after a refresh returned\nunusable counters (`stale`).","example":{"api_host":"api.five9.com","bucket_map":{"five9__configuration_service__add_to_list":{"operation_types":["Upload"],"resolved":true}},"buckets":{"Upload":{"caps":{"60":20,"3600":400,"86400":2000},"effective":{"60":16,"3600":320,"86400":1600},"label":"Uploading (batch)","margin_pct":80,"max_records_per_request":50000,"min_interval_ms":250,"observed_at":"2026-07-25T18:00:00Z","source":"live"}},"counters_synced_at":"2026-07-25T18:00:00Z","created_at":"2026-07-25T17:00:00Z","domain_id":"100200","domain_name":"Acme Corp","id":"ten_9f2c1a7b3d4e5f60","lane_order":{"bulk":["five9__configuration_service__add_to_list"]},"lane_overrides":{"five9__configuration_service__add_to_list":"bulk"},"org_id":"org_a1b2c3d4","platform_id":"five9","status":"active","sync_status":"live","tenancy_unit":{"key_field":"domain_id","key_source":"getVCCConfiguration.domainId","name":"Domain","plural":"Domains"},"updated_at":"2026-07-25T18:00:00Z"},"uniqueKey":"","typeLabel":"Five9DomainResponse · object"},"examples":{"Example":{"title":"Example","value":{"api_host":"api.five9.com","bucket_map":{"five9__configuration_service__add_to_list":{"operation_types":["Upload"],"resolved":true}},"buckets":{"Upload":{"caps":{"60":20,"3600":400,"86400":2000},"effective":{"60":16,"3600":320,"86400":1600},"label":"Uploading (batch)","margin_pct":80,"max_records_per_request":50000,"min_interval_ms":250,"observed_at":"2026-07-25T18:00:00Z","source":"live"}},"counters_synced_at":"2026-07-25T18:00:00Z","created_at":"2026-07-25T17:00:00Z","domain_id":"100200","domain_name":"Acme Corp","id":"ten_9f2c1a7b3d4e5f60","lane_order":{"bulk":["five9__configuration_service__add_to_list"]},"lane_overrides":{"five9__configuration_service__add_to_list":"bulk"},"org_id":"org_a1b2c3d4","platform_id":"five9","status":"active","sync_status":"live","tenancy_unit":{"key_field":"domain_id","key_source":"getVCCConfiguration.domainId","name":"Domain","plural":"Domains"},"updated_at":"2026-07-25T18:00:00Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"bfa90878-48ba-480f-b946-3335ac5977b0":{"description":"Missing or invalid authentication","content":{"application/json":{"example":{"detail":"Authentication required"},"examples":{"Example":{"title":"Example","value":{"detail":"Authentication required"}}},"exampleType":"examples"}},"exampleType":"examples"},"98872840-c03e-4bd9-bee7-5c65fdc1e8bd":{"description":"No such Domain for this organization (cross-tenant access also returns 404)","content":{"application/json":{"example":{"detail":"Domain not found"},"examples":{"Example":{"title":"Example","value":{"detail":"Domain not found"}}},"exampleType":"examples"}},"exampleType":"examples"},"bf0c47af-c7b4-4101-a104-30fdb816d396":{"description":"The body failed validation — an out-of-range safety margin, an unknown lane, an unknown rate bucket, an unknown action id, or an explicit null.","content":{"application/json":{"example":{"detail":"margins['Upload'] must be between 1 and 100"},"examples":{"Example":{"title":"Example","value":{"detail":"margins['Upload'] must be between 1 and 100"}}},"exampleType":"examples"}},"exampleType":"examples"},"468fc12e-234b-4669-8643-356e51fb015d":{"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":{"649d44b1-4731-4d92-9591-9700cea4db45":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[],"schemeName":"APIKeyHeader"}},"041636a3-2274-4017-84d6-63e3d99d7dca":{"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 Five9 Domain - GetDialed Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T15:46:44.174Z","originalFileLocation":"api-reference/five9-domains/get-a-five9-domain.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 one Five9 Domain, including its per-bucket raw provider caps, the margin_pct safety margin, the effective budget computed from both, the action → rate-bucket map, and any lane overrides. sync_status reports whether the caps are provider-observed (live), catalog defaults (catalog_default), or the result of a refresh that returned unusable counters (stale). Readable by any organization member. Cross-tenant access returns 404, never 403.\">\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 Five9 Domain - GetDialed Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Fetch one Five9 Domain, including its per-bucket raw provider caps, the margin_pct safety margin, the effective budget computed from both, the action → rate-bucket map, and any lane overrides. sync_status reports whether the caps are provider-observed (live), catalog defaults (catalog_default), or the result of a refresh that returned unusable counters (stale). Readable by any organization member. Cross-tenant access returns 404, never 403.\">\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/five9-domains/get-a-five9-domain\">\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=Five9+Domains+%E2%80%94+%2Fv1%2Fplatforms%2Ffive9\u0026amp;title=Get+a+Five9+Domain\u0026amp;description=Fetch+one+Five9+Domain%2C+including+its+per-bucket+raw+provider+%60caps%60%2C+the+%60margin_pct%60+safety+margin%2C+the+%60effective%60+budget+computed+from+both%2C+the+action+%E2%86%92+ra\u0026amp;theme=b6a8f417cb6da704c51ca7d7\u0026amp;signature=99a8a5561b63097d1a030585a829876d2d3cff72301fc722212bde1746db86cd\">\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 Five9 Domain - GetDialed Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Fetch one Five9 Domain, including its per-bucket raw provider caps, the margin_pct safety margin, the effective budget computed from both, the action → rate-bucket map, and any lane overrides. sync_status reports whether the caps are provider-observed (live), catalog defaults (catalog_default), or the result of a refresh that returned unusable counters (stale). Readable by any organization member. Cross-tenant access returns 404, never 403.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://getdialed.mintlify.app/_mintlify/api/og/v2?division=Five9+Domains+%E2%80%94+%2Fv1%2Fplatforms%2Ffive9\u0026amp;title=Get+a+Five9+Domain\u0026amp;description=Fetch+one+Five9+Domain%2C+including+its+per-bucket+raw+provider+%60caps%60%2C+the+%60margin_pct%60+safety+margin%2C+the+%60effective%60+budget+computed+from+both%2C+the+action+%E2%86%92+ra\u0026amp;theme=b6a8f417cb6da704c51ca7d7\u0026amp;signature=99a8a5561b63097d1a030585a829876d2d3cff72301fc722212bde1746db86cd\">\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/five9-domains/get-a-five9-domain\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/five9-domains/get-a-five9-domain.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/five9-domains/get-a-five9-domain#webpage\",\"url\":\"https://docs.getdialed.ai/api-reference/five9-domains/get-a-five9-domain\",\"name\":\"Get a Five9 Domain\",\"description\":\"Fetch one Five9 Domain, including its per-bucket raw provider caps, the margin_pct safety margin, the effective budget computed from both, the action → rate-bucket map, and any lane overrides. sync_status reports whether the caps are provider-observed (live), catalog defaults (catalog_default), or the result of a refresh that returned unusable counters (stale). Readable by any organization member. Cross-tenant access returns 404, never 403.\",\"dateModified\":\"2026-10-22T15:46:44.174Z\",\"isPartOf\":{\"@id\":\"https://docs.getdialed.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.getdialed.ai/api-reference/five9-domains/get-a-five9-domain#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.getdialed.ai/api-reference/five9-domains/get-a-five9-domain#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Five9 Domains — /v1/platforms/five9\",\"item\":\"https://docs.getdialed.ai/api-reference/five9-domains/list-five9-domains\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get a Five9 Domain\",\"item\":\"https://docs.getdialed.ai/api-reference/five9-domains/get-a-five9-domain\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.getdialed.ai/api-reference/five9-domains/get-a-five9-domain#apireference\",\"headline\":\"Get a Five9 Domain\",\"name\":\"Get a Five9 Domain\",\"description\":\"Fetch one Five9 Domain, including its per-bucket raw provider caps, the margin_pct safety margin, the effective budget computed from both, the action → rate-bucket map, and any lane overrides. sync_status reports whether the caps are provider-observed (live), catalog defaults (catalog_default), or the result of a refresh that returned unusable counters (stale). Readable by any organization member. Cross-tenant access returns 404, never 403.\",\"url\":\"https://docs.getdialed.ai/api-reference/five9-domains/get-a-five9-domain\",\"mainEntityOfPage\":{\"@id\":\"https://docs.getdialed.ai/api-reference/five9-domains/get-a-five9-domain#webpage\"},\"dateModified\":\"2026-10-22T15:46:44.174Z\",\"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","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","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","description":"List the calling organization's Five9 Domains. A Domain is the provider-tenant record that anchors rate limits, per-action lane placement and the safety margin — N credentials against the same Domain share ONE budget. Each item carries the platform's own vocabulary in `tenancy_unit`, its raw per-window provider `caps`, the operator's `margin_pct`, and the `effective` budget computed from both. Sort with `sort_by`/`order` (default newest-first), paginate with `limit`/`skip`. Readable by any organization member.","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","description":"Admin only. Three independent edits, any subset per request:\n\n- `margins` — a per-rate-bucket safety margin as a percentage of the provider cap. DOWNWARD-ONLY: values outside 1–100 are rejected, because a margin above the provider cap would hand out budget Five9 never granted, and a 0% margin is a permanent outage. Only the named buckets' margins are written; the raw `caps` are never touched.\n- `lane_overrides` — move one action into a different named dispatch lane for this Domain.\n- `lane_order` — fix the deterministic ordering of actions within a lane (an ordered list, not numeric weights).\n\nEvery referenced action id is re-validated against the catalog. An empty body is a no-op. Explicit JSON `null` is rejected — omit a field to leave it unchanged. Cross-tenant access returns 404, never 403.","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 Five9 Domain - 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"]}