An API key created by the chain owner in the panel (Integrações → Nova chave), sent as Authorization: Bearer <key>. The key (<id>|na_…) is shown once, at creation; rotate or revoke it on the same screen. It is a server secret: never ship it in browser or mobile code.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Need Alert","description":"Avise seus clientes no momento em que o que eles esperam fica disponível.","colors":{"primary":"#465FFF","light":"#7C8CFF","dark":"#3641CC"},"logo":{"light":"https://mintcdn.com/need-alert/9mmUrKHe_2MF526d/logo/light.svg?fit=max\u0026auto=format\u0026n=9mmUrKHe_2MF526d\u0026q=85\u0026s=373a6fb813b58847213edb4a69e07fc2","dark":"https://mintcdn.com/need-alert/9mmUrKHe_2MF526d/logo/dark.svg?fit=max\u0026auto=format\u0026n=9mmUrKHe_2MF526d\u0026q=85\u0026s=30c19faa6f0c69ad4ce03787eb0be7fd"},"favicon":"https://mintcdn.com/need-alert/9mmUrKHe_2MF526d/favicon.svg?fit=max\u0026auto=format\u0026n=9mmUrKHe_2MF526d\u0026q=85\u0026s=3232d54c500467b3b6694a4c942ed879","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","javascript","python","php"]}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"pt-BR","default":true,"href":""},{"language":"en","href":"en"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"need-alert","hasAudioNarration":false,"actualSubdomain":"need-alert","customDomains":["docs.needalert.app"],"gitSource":{"type":"github","owner":"claudiusnascimento","repo":"docs-need-alert","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ad760e76e89f16d0373b3c1","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"pt-BR","tag":"API","count":26},{"language":"en","tag":"API","count":26},{"language":"pt-BR","tag":"Guias","count":18},{"language":"pt-BR","tag":"Endpoints","count":18},{"language":"en","tag":"Guides","count":18},{"language":"en","tag":"Endpoints","count":18},{"language":"pt-BR","tag":"Para estabelecimentos","count":8},{"language":"pt-BR","tag":"Items","count":8},{"language":"en","tag":"For establishments","count":8},{"language":"en","tag":"Items","count":8},{"language":"pt-BR","tag":"Dispatches","count":6},{"language":"en","tag":"Dispatches","count":6},{"language":"pt-BR","tag":"Para quem espera","count":4},{"language":"en","tag":"For people waiting","count":4},{"language":"pt-BR","tag":"Introdução","count":3},{"language":"pt-BR","tag":"Começando","count":3},{"language":"en","tag":"Introduction","count":3},{"language":"en","tag":"Getting started","count":3},{"language":"pt-BR","tag":"Convenções","count":2},{"language":"en","tag":"Conventions","count":2}]},"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":"custom-rbac-roles","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":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"en/api/reference/dispatches/get-a-dispatch","slug":"/en/api/reference/dispatches/get-a-dispatch","pageMetadata":{"title":"Get a dispatch","description":"Adds `notifications`, the recipients per delivery status. Poll it to follow a dispatch until it is `dispatched` or `failed`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /establishments/{establishment}/events/{event}","href":"/en/api/reference/dispatches/get-a-dispatch","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: [\"Adds \", _jsx(_components.code, {\n children: \"notifications\"\n }), \", the recipients per delivery status. Poll it to follow a dispatch until it is \", _jsx(_components.code, {\n children: \"dispatched\"\n }), \" or \", _jsx(_components.code, {\n children: \"failed\"\n }), \".\"]\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 dispatch","description":"Adds `notifications`, the recipients per delivery status. Poll it to follow a dispatch until it is `dispatched` or `failed`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /establishments/{establishment}/events/{event}","href":"/en/api/reference/dispatches/get-a-dispatch","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"v1.establishments.events.show","description":"Adds `notifications`, the recipients per delivery status. Poll it to follow a dispatch until it is `dispatched` or `failed`.","summary":"Get a dispatch","tags":["Dispatches"],"parameters":["dc29d71f-1ce3-4e8e-9c47-d8e83e1b6d79","21a3dd5e-ba0d-4354-9ac3-8682f4717526","68ec37ab-de14-44d9-9d3f-324d3ed7ac2a","b74e3a2a-2485-4c92-b1cf-4dfa28f7c268"],"responses":{"200":"4bcf0d75-b108-4ef3-bb73-b136d24cc328","401":"39af25c2-8565-420d-b2c8-5179e7933978","403":"4e7fece3-35a4-4b47-9b6f-82e35234edb0","404":"24407448-c482-44a6-a235-877285e4132b","429":"43433582-03b5-404d-9561-3fd440281694"},"method":"get","type":"path","servers":["4881b565-21c9-481f-ab04-2e9faf758340"],"security":["bba8f998-d38f-418f-a418-f9c23b32760a"],"path":"/establishments/{establishment}/events/{event}","baseUrlOptions":["https://needalert.app/api/v1"],"title":"Get a dispatch","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","php"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"dc29d71f-1ce3-4e8e-9c47-d8e83e1b6d79":{"name":"establishment","in":"path","required":true,"description":"The establishment ID","schema":{"type":"integer","isRequired":true,"description":"The establishment ID","uniqueKey":"","typeLabel":"integer"}},"21a3dd5e-ba0d-4354-9ac3-8682f4717526":{"name":"event","in":"path","required":true,"description":"The event ID","schema":{"type":"integer","isRequired":true,"description":"The event ID","uniqueKey":"","typeLabel":"integer"}},"68ec37ab-de14-44d9-9d3f-324d3ed7ac2a":{"name":"Accept-Language","in":"header","description":"Language of `message` and of translated content such as item names (`pt-BR` or `en`). Without it, the chain's default language.","schema":{"type":"string","enum":["pt-BR","en"],"description":"Language of `message` and of translated content such as item names (`pt-BR` or `en`). Without it, the chain's default language.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"example":"pt-BR"},"b74e3a2a-2485-4c92-b1cf-4dfa28f7c268":{"name":"X-Request-Id","in":"header","description":"Your own correlation id (1–64 characters of `A-Za-z0-9._-`), echoed back; generated when absent. Quote it to support.","schema":{"type":"string","pattern":"^[A-Za-z0-9._-]{1,64}$","minLength":1,"maxLength":64,"description":"Your own correlation id (1–64 characters of `A-Za-z0-9._-`), echoed back; generated when absent. Quote it to support.","uniqueKey":"","typeLabel":"string"}}},"responses":{"4bcf0d75-b108-4ef3-bb73-b136d24cc328":{"description":"`Event`","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"integer","isRequired":true,"uniqueKey":"data.id","typeLabel":"integer"},"item":{"type":"object","properties":{"id":{"type":"integer","isRequired":true,"uniqueKey":"data.item.id","typeLabel":"integer"},"public_code":{"type":"string","isRequired":true,"uniqueKey":"data.item.public_code","typeLabel":"string"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.item.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.item.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.item.name","typeLabel":"string | null"}},"required":["id","public_code","name"],"isRequired":true,"uniqueKey":"data.item","typeLabel":"object"},"title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.title","typeLabel":"string | null"},"message":{"type":"string","isRequired":true,"uniqueKey":"data.message","typeLabel":"string"},"status":{"type":"string","description":"| |\n|---|\n| `pending` \u003cbr/> Queued to be sent now. |\n| `processing` \u003cbr/> Being sent. |\n| `dispatched` \u003cbr/> Sent; see `sent_count` and `failed_count`. |\n| `failed` \u003cbr/> Not sent; see `failure_reason`. |\n| `cancelled` \u003cbr/> Cancelled while scheduled. |\n| `scheduled` \u003cbr/> Waiting for `scheduled_at`. |","enum":["pending","processing","dispatched","failed","cancelled","scheduled"],"title":"EventStatus","isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"scheduled_at":{"oneOf":[{"type":"string","description":"When the alert is or was due; `null` for an immediate send.","isRequired":true,"uniqueKey":"data.scheduled_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the alert is or was due; `null` for an immediate send.","isRequired":true,"uniqueKey":"data.scheduled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.scheduled_at","typeLabel":"string | null"},"dispatched_at":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.dispatched_at.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.dispatched_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.dispatched_at","typeLabel":"string | null"},"recipients_count":{"type":"integer","description":"Subscribers the alert was sent to.","isRequired":true,"uniqueKey":"data.recipients_count","typeLabel":"integer"},"credits_cost":{"type":"integer","description":"Credits debited: one per recipient.","isRequired":true,"uniqueKey":"data.credits_cost","typeLabel":"integer"},"sent_count":{"type":"integer","isRequired":true,"uniqueKey":"data.sent_count","typeLabel":"integer"},"failed_count":{"type":"integer","isRequired":true,"uniqueKey":"data.failed_count","typeLabel":"integer"},"failure_reason":{"oneOf":[{"type":"string","title":"EventFailureReason","description":"| |\n|---|\n| `processing_error` \u003cbr/> An error while sending; the credits were not debited. |\n| `insufficient_credits` \u003cbr/> The balance did not cover the send when it was due. |\n| `missed_schedule` \u003cbr/> The scheduled time passed while the system was unavailable. |\n| `item_not_dispatchable` \u003cbr/> The item, unit or chain could no longer be alerted when the send was due. |","enum":["processing_error","insufficient_credits","missed_schedule","item_not_dispatchable"],"isRequired":true,"uniqueKey":"data.failure_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"data.failure_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.failure_reason","typeLabel":"enum\u003cstring> | null"},"estimated_credits_cost":{"oneOf":[{"type":"integer","description":"Scheduled alerts only: the cost estimated when the alert was scheduled or last rescheduled.","isRequired":true,"uniqueKey":"data.estimated_credits_cost.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Scheduled alerts only: the cost estimated when the alert was scheduled or last rescheduled.","isRequired":true,"uniqueKey":"data.estimated_credits_cost.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.estimated_credits_cost","typeLabel":"integer | null"},"warning_sent_at":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.warning_sent_at.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.warning_sent_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.warning_sent_at","typeLabel":"string | null"},"cancelled_at":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.cancelled_at.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.cancelled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.cancelled_at","typeLabel":"string | null"},"cancelled_by":{"oneOf":[{"type":"object","description":"The person who cancelled; `null` when an API key did or the alert was not cancelled.","properties":{"id":{"type":"integer","isRequired":true,"uniqueKey":"data.cancelled_by.oneOf.0.id","typeLabel":"integer"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.cancelled_by.oneOf.0.name","typeLabel":"string"}},"required":["id","name"],"isRequired":true,"uniqueKey":"data.cancelled_by.oneOf.0","typeLabel":"object"},{"type":"null","description":"The person who cancelled; `null` when an API key did or the alert was not cancelled.","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"isRequired":true,"uniqueKey":"data.cancelled_by.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.cancelled_by","typeLabel":"object | null"},"cancelled_by_api_client":{"oneOf":[{"type":"object","description":"The API key that cancelled; `null` when a person did or the alert was not cancelled.","properties":{"id":{"type":"integer","isRequired":true,"uniqueKey":"data.cancelled_by_api_client.oneOf.0.id","typeLabel":"integer"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.cancelled_by_api_client.oneOf.0.name","typeLabel":"string"}},"required":["id","name"],"isRequired":true,"uniqueKey":"data.cancelled_by_api_client.oneOf.0","typeLabel":"object"},{"type":"null","description":"The API key that cancelled; `null` when a person did or the alert was not cancelled.","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"isRequired":true,"uniqueKey":"data.cancelled_by_api_client.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.cancelled_by_api_client","typeLabel":"object | null"},"created_by":{"oneOf":[{"type":"object","description":"The person who created the alert; `null` when an API key or the system did.","properties":{"id":{"type":"integer","isRequired":true,"uniqueKey":"data.created_by.oneOf.0.id","typeLabel":"integer"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.created_by.oneOf.0.name","typeLabel":"string"}},"required":["id","name"],"isRequired":true,"uniqueKey":"data.created_by.oneOf.0","typeLabel":"object"},{"type":"null","description":"The person who created the alert; `null` when an API key or the system did.","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"isRequired":true,"uniqueKey":"data.created_by.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.created_by","typeLabel":"object | null"},"created_by_api_client":{"oneOf":[{"type":"object","description":"The API key that created the alert; `null` when a person did.","properties":{"id":{"type":"integer","isRequired":true,"uniqueKey":"data.created_by_api_client.oneOf.0.id","typeLabel":"integer"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.created_by_api_client.oneOf.0.name","typeLabel":"string"}},"required":["id","name"],"isRequired":true,"uniqueKey":"data.created_by_api_client.oneOf.0","typeLabel":"object"},{"type":"null","description":"The API key that created the alert; `null` when a person did.","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"],"isRequired":true,"uniqueKey":"data.created_by_api_client.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.created_by_api_client","typeLabel":"object | null"},"created_at":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.created_at.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.created_at","typeLabel":"string | null"},"notifications":{"type":"object","description":"Only on `GET …/events/{event}`: recipients per delivery status.","additionalProperties":{"type":"integer","uniqueKey":"data.notifications.additionalProperties","typeLabel":"integer"},"uniqueKey":"data.notifications","typeLabel":"object"}},"required":["id","item","title","message","status","scheduled_at","dispatched_at","recipients_count","credits_cost","sent_count","failed_count","failure_reason","estimated_credits_cost","warning_sent_at","cancelled_at","cancelled_by","cancelled_by_api_client","created_by","created_by_api_client","created_at"],"title":"Event","isRequired":true,"uniqueKey":"data","typeLabel":"Event · object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":123,"item":{"id":123,"public_code":"\u003cstring>","name":"\u003cstring>"},"title":"\u003cstring>","message":"\u003cstring>","status":"pending","scheduled_at":"\u003cstring>","dispatched_at":"\u003cstring>","recipients_count":123,"credits_cost":123,"sent_count":123,"failed_count":123,"failure_reason":"processing_error","estimated_credits_cost":123,"warning_sent_at":"\u003cstring>","cancelled_at":"\u003cstring>","cancelled_by":{"id":123,"name":"\u003cstring>"},"cancelled_by_api_client":{"id":123,"name":"\u003cstring>"},"created_by":{"id":123,"name":"\u003cstring>"},"created_by_api_client":{"id":123,"name":"\u003cstring>"},"created_at":"\u003cstring>","notifications":{}}}}},"exampleType":"generated"}},"headers":{"Content-Language":{"description":"The language of the body, BCP 47 (`pt-BR`, `en`).","schema":{"type":"string"}},"X-Request-Id":{"description":"The request id, yours or the one generated here.","schema":{"type":"string"}}},"exampleType":"generated"},"39af25c2-8565-420d-b2c8-5179e7933978":{"description":"- `unauthenticated`: Missing, malformed, expired or revoked API key.","content":{"application/json":{"schema":{"type":"object","title":"ErrorEnvelope","description":"The shape of every error response of the API.","required":["message","code"],"properties":{"message":{"type":"string","description":"Translated (see `Content-Language`), for display only. Never program against it.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Stable `snake_case` identifier of the error. Program against it.","enum":["unauthenticated"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"errors":{"type":"object","description":"Only on some errors: the invalid fields of a `validation_failed`, or extra data of a business-rule refusal.","uniqueKey":"errors","typeLabel":"object"}},"uniqueKey":"","typeLabel":"ErrorEnvelope · object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"unauthenticated","errors":{}}}},"exampleType":"generated"}},"headers":{"Content-Language":{"description":"The language of the body, BCP 47 (`pt-BR`, `en`).","schema":{"type":"string"}},"X-Request-Id":{"description":"The request id, yours or the one generated here.","schema":{"type":"string"}}},"exampleType":"generated"},"4e7fece3-35a4-4b47-9b6f-82e35234edb0":{"description":"- `establishment_unavailable`: The unit is inactive or suspended.\n- `forbidden`: The key lacks the permission this operation needs in this unit (`view`, `create_items`, `edit_items`, `dispatch_events` or `manage_billing`).\n- `tenant_suspended`: The chain that owns the key is suspended.","content":{"application/json":{"schema":{"type":"object","title":"ErrorEnvelope","description":"The shape of every error response of the API.","required":["message","code"],"properties":{"message":{"type":"string","description":"Translated (see `Content-Language`), for display only. Never program against it.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Stable `snake_case` identifier of the error. Program against it.","enum":["establishment_unavailable","forbidden","tenant_suspended"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"errors":{"type":"object","description":"Only on some errors: the invalid fields of a `validation_failed`, or extra data of a business-rule refusal.","uniqueKey":"errors","typeLabel":"object"}},"uniqueKey":"","typeLabel":"ErrorEnvelope · object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"establishment_unavailable","errors":{}}}},"exampleType":"generated"}},"headers":{"Content-Language":{"description":"The language of the body, BCP 47 (`pt-BR`, `en`).","schema":{"type":"string"}},"X-Request-Id":{"description":"The request id, yours or the one generated here.","schema":{"type":"string"}}},"exampleType":"generated"},"24407448-c482-44a6-a235-877285e4132b":{"description":"- `not_found`: No such resource, or it is outside the key's scope. The API never reveals whether a resource you cannot see exists.","content":{"application/json":{"schema":{"type":"object","title":"ErrorEnvelope","description":"The shape of every error response of the API.","required":["message","code"],"properties":{"message":{"type":"string","description":"Translated (see `Content-Language`), for display only. Never program against it.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Stable `snake_case` identifier of the error. Program against it.","enum":["not_found"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"errors":{"type":"object","description":"Only on some errors: the invalid fields of a `validation_failed`, or extra data of a business-rule refusal.","uniqueKey":"errors","typeLabel":"object"}},"uniqueKey":"","typeLabel":"ErrorEnvelope · object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"not_found","errors":{}}}},"exampleType":"generated"}},"headers":{"Content-Language":{"description":"The language of the body, BCP 47 (`pt-BR`, `en`).","schema":{"type":"string"}},"X-Request-Id":{"description":"The request id, yours or the one generated here.","schema":{"type":"string"}}},"exampleType":"generated"},"43433582-03b5-404d-9561-3fd440281694":{"description":"- `too_many_requests`: Over the key's budget of 300 requests per minute. Wait the seconds in `Retry-After`.","content":{"application/json":{"schema":{"type":"object","title":"ErrorEnvelope","description":"The shape of every error response of the API.","required":["message","code"],"properties":{"message":{"type":"string","description":"Translated (see `Content-Language`), for display only. Never program against it.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Stable `snake_case` identifier of the error. Program against it.","enum":["too_many_requests"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"errors":{"type":"object","description":"Only on some errors: the invalid fields of a `validation_failed`, or extra data of a business-rule refusal.","uniqueKey":"errors","typeLabel":"object"}},"uniqueKey":"","typeLabel":"ErrorEnvelope · object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"too_many_requests","errors":{}}}},"exampleType":"generated"}},"headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}},"X-RateLimit-Limit":{"description":"Requests allowed per minute.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in the current minute.","schema":{"type":"integer"}},"Content-Language":{"description":"The language of the body, BCP 47 (`pt-BR`, `en`).","schema":{"type":"string"}},"X-Request-Id":{"description":"The request id, yours or the one generated here.","schema":{"type":"string"}}},"exampleType":"generated"}},"security":{"bba8f998-d38f-418f-a418-f9c23b32760a":{"apiKey":{"type":"http","description":"An API key created by the chain owner in the panel (**Integrações** → **Nova chave**), sent as `Authorization: Bearer \u003ckey>`. The key (`\u003cid>|na_…`) is shown once, at creation; rotate or revoke it on the same screen. It is a server secret: never ship it in browser or mobile code.","scheme":"bearer","scopes":[],"schemeName":"apiKey"}}},"servers":{"4881b565-21c9-481f-ab04-2e9faf758340":{"url":"https://needalert.app/api/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"An API key created by the chain owner in the panel (**Integrações** → **Nova chave**), sent as `Authorization: Bearer \u003ckey>`. The key (`\u003cid>|na_…`) is shown once, at creation; rotate or revoke it on the same screen. It is a server secret: never ship it in browser or mobile code.","scheme":"bearer","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key created by the chain owner in the panel (**Integrações** → **Nova chave**), sent as `Authorization: Bearer \u003ckey>`. The key (`\u003cid>|na_…`) is shown once, at creation; rotate or revoke it on the same screen. It is a server secret: never ship it in browser or mobile code.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"need-alert","siteName":"Need Alert","title":"Get a dispatch - Need Alert","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"pt-BR":{"href":"/api/reference/dispatches/get-a-dispatch","matchLevel":1},"en":{"href":"/en/api/reference/dispatches/get-a-dispatch","matchLevel":0}}},"lastModified":"2026-10-19T04:16:33.483Z","originalFileLocation":"en/api/reference/dispatches/get-a-dispatch.mdx","locale":"en"},"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=\"Adds notifications, the recipients per delivery status. Poll it to follow a dispatch until it is dispatched or failed.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Need Alert\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/need-alert/RuPQ-F31d7vVQjKt/_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/need-alert/RuPQ-F31d7vVQjKt/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/need-alert/RuPQ-F31d7vVQjKt/_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/need-alert/RuPQ-F31d7vVQjKt/_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/need-alert/RuPQ-F31d7vVQjKt/_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/need-alert/RuPQ-F31d7vVQjKt/_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/need-alert/RuPQ-F31d7vVQjKt/_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/need-alert/RuPQ-F31d7vVQjKt/_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/need-alert/RuPQ-F31d7vVQjKt/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a dispatch - Need Alert\">\u003cmeta data-mint-head property=\"og:description\" content=\"Adds notifications, the recipients per delivery status. Poll it to follow a dispatch until it is dispatched or failed.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Need Alert\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.needalert.app/en/api/reference/dispatches/get-a-dispatch\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://need-alert.mintlify.site/_mintlify/api/og/v2?division=Dispatches\u0026amp;title=Get+a+dispatch\u0026amp;description=Adds+%60notifications%60%2C+the+recipients+per+delivery+status.+Poll+it+to+follow+a+dispatch+until+it+is+%60dispatched%60+or+%60failed%60.\u0026amp;theme=bdfac1a245537d76f0edd834\u0026amp;signature=4609d1324ff1c30d673b48ba0135a7727f5195db5209c3c172d8a7c20d0037b4\">\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 dispatch - Need Alert\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Adds notifications, the recipients per delivery status. Poll it to follow a dispatch until it is dispatched or failed.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://need-alert.mintlify.site/_mintlify/api/og/v2?division=Dispatches\u0026amp;title=Get+a+dispatch\u0026amp;description=Adds+%60notifications%60%2C+the+recipients+per+delivery+status.+Poll+it+to+follow+a+dispatch+until+it+is+%60dispatched%60+or+%60failed%60.\u0026amp;theme=bdfac1a245537d76f0edd834\u0026amp;signature=4609d1324ff1c30d673b48ba0135a7727f5195db5209c3c172d8a7c20d0037b4\">\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/need-alert/RuPQ-F31d7vVQjKt/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Need Alert\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#465FFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.needalert.app/en/api/reference/dispatches/get-a-dispatch\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/api/reference/dispatches/get-a-dispatch.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.needalert.app/en/api/reference/dispatches/get-a-dispatch\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://docs.needalert.app/api/reference/dispatches/get-a-dispatch\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.needalert.app/api/reference/dispatches/get-a-dispatch\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.needalert.app/#organization\",\"name\":\"Need Alert\",\"url\":\"https://docs.needalert.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/need-alert/9mmUrKHe_2MF526d/logo/light.svg?fit=max\u0026auto=format\u0026n=9mmUrKHe_2MF526d\u0026q=85\u0026s=373a6fb813b58847213edb4a69e07fc2\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.needalert.app#website\",\"name\":\"Need Alert\",\"url\":\"https://docs.needalert.app\",\"publisher\":{\"@id\":\"https://docs.needalert.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.needalert.app/en/api/reference/dispatches/get-a-dispatch#webpage\",\"url\":\"https://docs.needalert.app/en/api/reference/dispatches/get-a-dispatch\",\"name\":\"Get a dispatch\",\"description\":\"Adds notifications, the recipients per delivery status. Poll it to follow a dispatch until it is dispatched or failed.\",\"dateModified\":\"2026-10-19T04:16:33.483Z\",\"isPartOf\":{\"@id\":\"https://docs.needalert.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.needalert.app/en/api/reference/dispatches/get-a-dispatch#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.needalert.app/en/api/reference/dispatches/get-a-dispatch#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.needalert.app/en/api/reference/establishments/list-units\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Dispatches\",\"item\":\"https://docs.needalert.app/en/api/reference/dispatches/preview-an-alert\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a dispatch\",\"item\":\"https://docs.needalert.app/en/api/reference/dispatches/get-a-dispatch\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.needalert.app/en/api/reference/dispatches/get-a-dispatch#apireference\",\"headline\":\"Get a dispatch\",\"name\":\"Get a dispatch\",\"description\":\"Adds notifications, the recipients per delivery status. Poll it to follow a dispatch until it is dispatched or failed.\",\"url\":\"https://docs.needalert.app/en/api/reference/dispatches/get-a-dispatch\",\"mainEntityOfPage\":{\"@id\":\"https://docs.needalert.app/en/api/reference/dispatches/get-a-dispatch#webpage\"},\"dateModified\":\"2026-10-19T04:16:33.483Z\",\"publisher\":{\"@id\":\"https://docs.needalert.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.needalert.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Need Alert\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Need Alert\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/en/api/reference/dispatches/get-a-dispatch.md","siteName":"Need Alert","nav":{"global":null,"languages":[{"language":"pt-BR","default":true,"pages":[{"title":"pt-BR","href":"/api/reference/dispatches/get-a-dispatch"}]},{"language":"en","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/en"}]},{"tab":"API","groups":[{"group":"Introduction","pages":[{"title":"API overview","icon":"code","href":"/en/api/overview"},{"title":"Authentication","icon":"key","href":"/en/api/authentication"},{"title":"First request","icon":"rocket","href":"/en/api/first-request"}]},{"group":"Guides","pages":[{"title":"Idempotency","icon":"rotate","href":"/en/api/idempotency"},{"title":"External reference","icon":"barcode","href":"/en/api/external-reference"},{"title":"Use cases","icon":"diagram-project","href":"/en/api/use-cases"}]},{"group":"Conventions","pages":[{"title":"Conventions","icon":"book","href":"/en/api/conventions"},{"title":"Changelog","icon":"clock-rotate-left","href":"/en/api/changelog"}]},{"group":"Endpoints","pages":[{"group":"Establishments","pages":[{"title":"List units","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /establishments","href":"/en/api/reference/establishments/list-units"},{"title":"Get a unit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /establishments/{establishment}","href":"/en/api/reference/establishments/get-a-unit"}]},{"group":"Items","pages":[{"title":"List items","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /establishments/{establishment}/items","href":"/en/api/reference/items/list-items"},{"title":"Create an item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /establishments/{establishment}/items","href":"/en/api/reference/items/create-an-item"},{"title":"Get an item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /establishments/{establishment}/items/{item}","href":"/en/api/reference/items/get-an-item"},{"title":"Archive an item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /establishments/{establishment}/items/{item}","href":"/en/api/reference/items/archive-an-item"},{"title":"Update an item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /establishments/{establishment}/items/{item}","href":"/en/api/reference/items/update-an-item"},{"title":"Get the item's QR code","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /establishments/{establishment}/items/{item}/qr-code","href":"/en/api/reference/items/get-the-items-qr-code"},{"title":"Upload the item's picture","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /establishments/{establishment}/items/{item}/image","href":"/en/api/reference/items/upload-the-items-picture"},{"title":"Remove the item's picture","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /establishments/{establishment}/items/{item}/image","href":"/en/api/reference/items/remove-the-items-picture"}]},{"group":"Dispatches","pages":[{"title":"Preview an alert","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /establishments/{establishment}/items/{item}/dispatch-preview","href":"/en/api/reference/dispatches/preview-an-alert"},{"title":"Send or schedule an alert","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /establishments/{establishment}/items/{item}/events","href":"/en/api/reference/dispatches/send-or-schedule-an-alert"},{"title":"List dispatches","description":"The unit's alerts, newest first, paginated. Filter by `item_id` and `status`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /establishments/{establishment}/events","href":"/en/api/reference/dispatches/list-dispatches"},{"title":"Get a dispatch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /establishments/{establishment}/events/{event}","href":"/en/api/reference/dispatches/get-a-dispatch"},{"title":"Cancel a scheduled dispatch","description":"Only while `scheduled`. The dispatch stays in the history as `cancelled`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /establishments/{establishment}/events/{event}","href":"/en/api/reference/dispatches/cancel-a-scheduled-dispatch"},{"title":"Reschedule a dispatch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /establishments/{establishment}/events/{event}","href":"/en/api/reference/dispatches/reschedule-a-dispatch"}]},{"group":"Credits","pages":[{"title":"Get the credit balance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tenants/{tenant}/credit-balance","href":"/en/api/reference/credits/get-the-credit-balance"},{"title":"List credit transactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tenants/{tenant}/credit-transactions","href":"/en/api/reference/credits/list-credit-transactions"}]}]}]}]}]},"basePath":"","title":"Get a dispatch - Need Alert","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}