A ceiling on how fast a batch may be released: N records every M minutes.
The rate is a hard ceiling over any interval — there is no catch-up burst.
After a pause, an exhausted provider quota or a closed delivery window,
delivery resumes at the configured rate from that moment; the time lost is
not made up.
period_minutes is measured in whole minutes: pacing finer than a minute
cannot be expressed. Add a window to confine delivery to particular local
hours.
Show child attributes
{"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/batches/get-a-batch","slug":"/api-reference/batches/get-a-batch","pageMetadata":{"title":"Get a batch","description":"Fetch a single batch by id. Cross-tenant access returns 404.","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/batches/{batch_id}","href":"/api-reference/batches/get-a-batch","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 batch 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 batch","description":"Fetch a single batch by id. Cross-tenant access returns 404.","deprecated":null,"version":null,"openapi":"/openapi.json get /flows/batches/{batch_id}","href":"/api-reference/batches/get-a-batch","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["batches"],"summary":"Get a batch","description":"Fetch a single batch by id. Cross-tenant access returns 404.","operationId":"get_batch_flows_batches__batch_id__get","security":["812db9b4-9db8-4f4d-b31a-530b40532916","f7d562e9-8784-45c5-a417-0d243d589e93"],"parameters":["c5a42eb3-2c2c-4aaa-be96-63853bddb46e"],"responses":{"200":"ce559267-b81b-49fd-9d0b-d81b7899f990","401":"ec1684e2-ce83-40a5-afe1-bfcc58fb5882","404":"c6938c79-50bd-4d1b-822d-1c89ee87b7a2","422":"fe3b6c68-bfa9-471e-aaec-692ec32c436d","429":"62a257b5-fe4e-4843-8ca3-cea95e7b30d4"},"method":"get","type":"path","servers":["46b27330-8729-49f8-bc01-5b7026690c37"],"path":"/flows/batches/{batch_id}","baseUrlOptions":["https://api.getdialed.ai/v1"],"title":"Get a batch","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c5a42eb3-2c2c-4aaa-be96-63853bddb46e":{"name":"batch_id","in":"path","required":true,"schema":{"type":"string","title":"Batch Id","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"ce559267-b81b-49fd-9d0b-d81b7899f990":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"definition_id":{"type":"string","title":"Definition Id","isRequired":true,"uniqueKey":"definition_id","typeLabel":"string"},"org_id":{"type":"string","title":"Org Id","isRequired":true,"uniqueKey":"org_id","typeLabel":"string"},"trigger_id":{"type":"string","title":"Trigger Id","isRequired":true,"uniqueKey":"trigger_id","typeLabel":"string"},"trigger_type":{"type":"string","title":"Trigger Type","isRequired":true,"uniqueKey":"trigger_type","typeLabel":"string"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata","isRequired":true,"uniqueKey":"metadata","typeLabel":"Metadata · object"},"status":{"type":"string","enum":["pending","queued","scheduled","running","paused","completed","completed_with_errors","partially_failed","failed","cancelled"],"title":"Status","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"record_count":{"type":"integer","title":"Record Count","isRequired":true,"uniqueKey":"record_count","typeLabel":"integer"},"scheduled_at":{"oneOf":[{"type":"string","title":"Scheduled At","format":"date-time","isRequired":true,"uniqueKey":"scheduled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Scheduled At","isRequired":true,"uniqueKey":"scheduled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"scheduled_at","typeLabel":"string\u003cdate-time> | null"},"started_at":{"oneOf":[{"type":"string","title":"Started At","format":"date-time","isRequired":true,"uniqueKey":"started_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Started At","isRequired":true,"uniqueKey":"started_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"started_at","typeLabel":"string\u003cdate-time> | null"},"completed_at":{"oneOf":[{"type":"string","title":"Completed At","format":"date-time","isRequired":true,"uniqueKey":"completed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Completed At","isRequired":true,"uniqueKey":"completed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"completed_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"type":"string","format":"date-time","title":"Created At","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"trigger_source":{"oneOf":[{"type":"string","title":"Trigger Source","uniqueKey":"trigger_source.oneOf.0","typeLabel":"string"},{"type":"null","title":"Trigger Source","uniqueKey":"trigger_source.oneOf.1","typeLabel":"null"}],"uniqueKey":"trigger_source","typeLabel":"string | null"},"schedule_id":{"oneOf":[{"type":"string","title":"Schedule Id","uniqueKey":"schedule_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Schedule Id","uniqueKey":"schedule_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"schedule_id","typeLabel":"string | null"},"priority":{"oneOf":[{"type":"string","title":"Priority","enum":["normal","high"],"uniqueKey":"priority.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Priority","uniqueKey":"priority.oneOf.1","typeLabel":"null"}],"uniqueKey":"priority","typeLabel":"enum\u003cstring> | null"},"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":"pacing.oneOf.0.records_per_period","typeLabel":"integer"},"period_minutes":{"type":"integer","minimum":1,"title":"Period Minutes","isRequired":true,"uniqueKey":"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":"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":"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":"pacing.oneOf.0.window.oneOf.0.end_minute_of_day","typeLabel":"integer"},"days":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"pacing.oneOf.0.window.oneOf.0.days.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Days","uniqueKey":"pacing.oneOf.0.window.oneOf.0.days.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Days","uniqueKey":"pacing.oneOf.0.window.oneOf.0.days.oneOf.1","typeLabel":"null"}],"uniqueKey":"pacing.oneOf.0.window.oneOf.0.days","typeLabel":"string[] | null"}},"uniqueKey":"pacing.oneOf.0.window.oneOf.0","typeLabel":"DeliveryWindow · object"},{"type":"null","uniqueKey":"pacing.oneOf.0.window.oneOf.1","typeLabel":"null"}],"uniqueKey":"pacing.oneOf.0.window","typeLabel":"DeliveryWindow · object | null"}},"uniqueKey":"pacing.oneOf.0","typeLabel":"PacingPolicy · object"},{"type":"null","uniqueKey":"pacing.oneOf.1","typeLabel":"null"}],"uniqueKey":"pacing","typeLabel":"PacingPolicy · object | null"}},"type":"object","required":["id","definition_id","org_id","trigger_id","trigger_type","metadata","status","record_count","scheduled_at","started_at","completed_at","created_at","updated_at"],"title":"BatchResponse","example":{"completed_at":"2026-07-09T18:00:05Z","created_at":"2026-07-09T17:59:59Z","definition_id":"def_a1b2c3d4","id":"batch_55667788","metadata":{"campaign":"spring-2026"},"org_id":"org_a1b2c3d4","record_count":2,"started_at":"2026-07-09T18:00:00Z","status":"completed","trigger_id":"trigger_44556677","trigger_type":"api_call","updated_at":"2026-07-09T18:00:05Z"},"uniqueKey":"","typeLabel":"BatchResponse · object"},"examples":{"Example":{"title":"Example","value":{"completed_at":"2026-07-09T18:00:05Z","created_at":"2026-07-09T17:59:59Z","definition_id":"def_a1b2c3d4","id":"batch_55667788","metadata":{"campaign":"spring-2026"},"org_id":"org_a1b2c3d4","record_count":2,"started_at":"2026-07-09T18:00:00Z","status":"completed","trigger_id":"trigger_44556677","trigger_type":"api_call","updated_at":"2026-07-09T18:00:05Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"ec1684e2-ce83-40a5-afe1-bfcc58fb5882":{"description":"Missing or invalid authentication","content":{"application/json":{"example":{"detail":"Authentication required"},"examples":{"Example":{"title":"Example","value":{"detail":"Authentication required"}}},"exampleType":"examples"}},"exampleType":"examples"},"c6938c79-50bd-4d1b-822d-1c89ee87b7a2":{"description":"No such batch for this organization (cross-tenant access also returns 404)","content":{"application/json":{"example":{"detail":"Batch not found"},"examples":{"Example":{"title":"Example","value":{"detail":"Batch not found"}}},"exampleType":"examples"}},"exampleType":"examples"},"fe3b6c68-bfa9-471e-aaec-692ec32c436d":{"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"},"62a257b5-fe4e-4843-8ca3-cea95e7b30d4":{"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":{"812db9b4-9db8-4f4d-b31a-530b40532916":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[],"schemeName":"APIKeyHeader"}},"f7d562e9-8784-45c5-a417-0d243d589e93":{"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 batch - GetDialed Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T15:46:43.362Z","originalFileLocation":"api-reference/batches/get-a-batch.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 batch 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 batch - GetDialed Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Fetch a single batch 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/batches/get-a-batch\">\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=Batches\u0026amp;title=Get+a+batch\u0026amp;description=Fetch+a+single+batch+by+id.+Cross-tenant+access+returns+404.\u0026amp;theme=b6a8f417cb6da704c51ca7d7\u0026amp;signature=de138570c36661c150e301ee814132732cd304c32f8ce0243a4b3ff08eb425c6\">\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 batch - GetDialed Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Fetch a single batch by id. Cross-tenant access returns 404.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://getdialed.mintlify.app/_mintlify/api/og/v2?division=Batches\u0026amp;title=Get+a+batch\u0026amp;description=Fetch+a+single+batch+by+id.+Cross-tenant+access+returns+404.\u0026amp;theme=b6a8f417cb6da704c51ca7d7\u0026amp;signature=de138570c36661c150e301ee814132732cd304c32f8ce0243a4b3ff08eb425c6\">\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/batches/get-a-batch\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/batches/get-a-batch.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/batches/get-a-batch#webpage\",\"url\":\"https://docs.getdialed.ai/api-reference/batches/get-a-batch\",\"name\":\"Get a batch\",\"description\":\"Fetch a single batch by id. Cross-tenant access returns 404.\",\"dateModified\":\"2026-10-22T15:46:43.362Z\",\"isPartOf\":{\"@id\":\"https://docs.getdialed.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.getdialed.ai/api-reference/batches/get-a-batch#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.getdialed.ai/api-reference/batches/get-a-batch#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\":\"Batches\",\"item\":\"https://docs.getdialed.ai/api-reference/batches/list-account-wide-batches\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a batch\",\"item\":\"https://docs.getdialed.ai/api-reference/batches/get-a-batch\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.getdialed.ai/api-reference/batches/get-a-batch#apireference\",\"headline\":\"Get a batch\",\"name\":\"Get a batch\",\"description\":\"Fetch a single batch by id. Cross-tenant access returns 404.\",\"url\":\"https://docs.getdialed.ai/api-reference/batches/get-a-batch\",\"mainEntityOfPage\":{\"@id\":\"https://docs.getdialed.ai/api-reference/batches/get-a-batch#webpage\"},\"dateModified\":\"2026-10-22T15:46:43.362Z\",\"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","description":"List every batch across all definitions for the caller's account, newest first, with opaque cursor pagination. Filter by `status`, `definition_id`, `source`, and `since` (a `created_at >=` lower bound); page forward by passing the previous response's `next_cursor`. `total` is always null on this endpoint — read `next_cursor != null` to know more rows exist. Only the caller's account batches are ever returned.","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","description":"Re-order or re-pace a batch that is still queued or in flight. Both fields are optional — send only what you are changing, and an empty body leaves the batch untouched.\n\n- `priority` re-orders the batch's REMAINING work within its own dispatch lane. Work already claimed or sent is never re-ordered, and the boost cannot take capacity from another lane — it only changes the order in which your own account's budget is spent, which is why no elevated role is required.\n- `pacing` sets or replaces the release policy and applies from the next release tick: slowing a batch down never recalls work already released, and speeding one up never produces a burst to catch up. A policy that is not strictly slower than the rate your provider budget already allows is rejected rather than quietly clamped, so the policy you set is always the policy in force. Send `remove_pacing: true` to stop pacing a batch entirely.\n\nExplicit JSON `null` is rejected — omit a field to leave it unchanged. A completed, failed, or cancelled batch cannot be changed (409). Cross-tenant access returns 404, never 403.","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 batch - 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"]}