Lists the application’s receiving addresses, oldest first: its kind (domain, a subdomain of your domain, or hosted, one Tawked gives), the domain where every local part reaches you, an example, its state, a hold, what it does with spam and its automatic forward. Addresses are added in the console.
Authorization: Bearer . An application key (tk_live_, tk_test_) has full access, which covers every product and any product added later, or custom access, chosen when the key is created: one or more of the scopes verify:check, verify:send (includes verify:check), notifications:read, notifications:send (includes notifications:read), email:read, email:send (includes email:read), email:manage (includes email:send), webhooks:manage, email:inbound, notifications:templates (includes notifications:read), chat:menus, chat:attendant. No key made on the API keys page holds notifications:templates, full access included: the three template writes answer such a key 403 insufficient_scope. A connected app's key holds it. Nor chat:menus: the five conversation menu operations answer such a key 403 insufficient_scope, and a connected app's key holds it once the client approved it. Nor chat:attendant: the five auto-attendant operations answer such a key 403 insufficient_scope too, and a connected app's key holds it once the client approved it. email:manage and webhooks:manage are held only by a key someone chose them for: a full-access key, old or new, never holds them. email:inbound, which reads, deletes and forwards received e-mail, is opt-in on every key, full access included: a key holds it only when it was turned on when the key was created. A call outside the key's access answers 403 insufficient_scope and names the scope it needs in the WWW-Authenticate response header. A partner key (tk_partner_) always has full access. Whatever its access, a key is a server-side secret.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Tawked","description":"Tawked developer docs: one-time codes by SMS with Tawked Verify, WhatsApp template messages from your own number with Tawked Notifications, replies in Tawked Chat, transactional e-mail from your own domain with Tawked Email, the Partner API for platforms, and the store integrations.","colors":{"primary":"#2563EB","light":"#60A5FA","dark":"#1D4ED8"},"logo":{"light":"https://mintcdn.com/tawked/Vn57enlu2GVgFv-J/logo/light.svg?fit=max\u0026auto=format\u0026n=Vn57enlu2GVgFv-J\u0026q=85\u0026s=353a0cedb91848c1296f205d3552fcca","dark":"https://mintcdn.com/tawked/Vn57enlu2GVgFv-J/logo/dark.svg?fit=max\u0026auto=format\u0026n=Vn57enlu2GVgFv-J\u0026q=85\u0026s=55027020324a6f5ac4b2608dbd1f8b9f","href":"https://tawked.com"},"favicon":"https://mintcdn.com/tawked/Vn57enlu2GVgFv-J/favicon.svg?fit=max\u0026auto=format\u0026n=Vn57enlu2GVgFv-J\u0026q=85\u0026s=a021d3b38b58bccc6b7b81a1b83946ee","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","php","python"]}},"appearance":{"default":"system"},"navbar":{"links":[{"href":"https://tawked.com/en/contact","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://tawked.com/en/login"}},"footer":{"socials":{"x":"https://x.com/tawkeds"},"links":[{"header":"Products","items":[{"label":"Tawked Verify","href":"https://tawked.com/en/verify"},{"label":"Tawked Notifications","href":"https://tawked.com/en/whatsapp"},{"label":"Tawked Chat","href":"https://tawked.com/en/chat"},{"label":"The Salla app","href":"https://tawked.com/en/salla"},{"label":"Pricing","href":"https://tawked.com/en/pricing"},{"label":"Status","href":"https://tawked.com/en/status"}]},{"header":"Machine-readable","items":[{"label":"OpenAPI","href":"https://tawked.com/openapi.json"},{"label":"Docs MCP server","href":"https://docs.tawked.com/agents"},{"label":"llms.txt","href":"https://docs.tawked.com/llms.txt"},{"label":"skill.md","href":"https://docs.tawked.com/skill.md"},{"label":"Changelog RSS","href":"https://docs.tawked.com/changelog/rss.xml"}]},{"header":"Legal","items":[{"label":"Terms","href":"https://tawked.com/en/terms"},{"label":"Privacy","href":"https://tawked.com/en/privacy"}]}]},"search":{"prompt":"Search the Tawked docs"},"seo":{"metatags":{"og:site_name":"Tawked developer docs","og:image":"https://tawked.com/og/developer-docs-en.png?v=27df06570d","og:image:type":"image/png","og:image:width":"1200","og:image:height":"630","og:image:alt":"Tawked developer docs. Verify, WhatsApp, Chat, Email and the Account API","twitter:card":"summary_large_image","twitter:image":"https://tawked.com/og/developer-docs-en.png?v=27df06570d"},"indexing":"all"},"fonts":{"family":"Figtree"},"styling":{"eyebrows":"section","codeblocks":"dark","latex":false},"errors":{"404":{"redirect":false,"title":"This page is not here","description":"It may have moved. Search the docs, or start from the [overview](/)."}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","add-mcp","cursor","vscode","download-spec"],"display":"header"},"metadata":{"timestamp":true},"navigation":{"global":{"anchors":[{"anchor":"Status","icon":"signal","href":"https://tawked.com/en/status"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tawked","hasAudioNarration":false,"actualSubdomain":"tawked","customDomains":["docs.tawked.com"],"gitSource":{"type":"github","owner":"snoker87","repo":"tawked","deployBranch":"main","contentDirectory":"docs/site","isPrivate":false,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae5f6a33d1d28d235826841","collectionId":"74a8b83d-8b94-48ed-a3c2-0f61e1eabb41","liveDeploymentHistoryId":"6ae5f6a33d1d28d235826841","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ae5f6a33d1d28d235826841","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"Account API","count":413},{"language":"default","tag":"Operations","count":403},{"language":"default","tag":"API reference","count":133},{"language":"default","tag":"radeef","count":65},{"language":"default","tag":"email","count":58},{"language":"default","tag":"Email","count":53},{"language":"default","tag":"Webhooks","count":50},{"language":"default","tag":"Guides","count":44},{"language":"default","tag":"whatsapp","count":43},{"language":"default","tag":"campaigns","count":32}]},"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":"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":"byok-sep-25","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":"billing-updated-9-15","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":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"styles.css","content":":root{--tawked-radius:0.75rem}.callout,.card,.code-block,[class*=card],pre{border-radius:var(--tawked-radius)}code:not(pre code){font-size:.9em}.method-pill,[class*=method]>span{border-radius:9999px}table td:first-child,table th:first-child{white-space:nowrap;width:1%}table td code{white-space:nowrap}"}],"page":{"pagePath":"api-reference/email/list-receiving-addresses","slug":"/api-reference/email/list-receiving-addresses","pageMetadata":{"title":"List receiving addresses","description":"Lists the application's receiving addresses, oldest first: its kind (`domain`, a subdomain of your domain, or `hosted`, one Tawked gives), the domain where every local part reaches you, an example, its state, a hold, what it does with spam and its automatic forward. Addresses are added in the console.","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/inbound-addresses","href":"/api-reference/email/list-receiving-addresses","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: [\"Lists the application’s receiving addresses, oldest first: its kind (\", _jsx(_components.code, {\n children: \"domain\"\n }), \", a subdomain of your domain, or \", _jsx(_components.code, {\n children: \"hosted\"\n }), \", one Tawked gives), the domain where every local part reaches you, an example, its state, a hold, what it does with spam and its automatic forward. Addresses are added in the console.\"]\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[`Guide: `,_jsx(_components.a,{href:`/email/receiving`,children:`Receiving email`})]})}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":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"List receiving addresses","description":"Lists the application's receiving addresses, oldest first: its kind (`domain`, a subdomain of your domain, or `hosted`, one Tawked gives), the domain where every local part reaches you, an example, its state, a hold, what it does with spam and its automatic forward. Addresses are added in the console.","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/inbound-addresses","href":"/api-reference/email/list-receiving-addresses","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"email_inbound_addresses","tags":["Email"],"summary":"List receiving addresses","description":"Lists the application's receiving addresses, oldest first: its kind (`domain`, a subdomain of your domain, or `hosted`, one Tawked gives), the domain where every local part reaches you, an example, its state, a hold, what it does with spam and its automatic forward. Addresses are added in the console.","responses":{"200":"e720bb1d-cc6f-480c-8139-4e3daf7a3023","400":"7fafac74-acda-4ef8-926a-764b7093c430","401":"6258ef11-47a5-4365-a281-f1c4e756fd7b","403":"1bb45b29-5617-4cb9-b25f-ee6f88cedd27","404":"f762011a-c644-42bb-9cdb-e33b80a6f97c","429":"f752e7f9-cb5c-4ff2-b7ba-81db3785cfaf","500":"34dd86a3-cc19-4566-a77e-8508c66f37de"},"x-codeSamples":[{"lang":"bash","label":"cURL","source":"curl https://tawked.com/v1/email/inbound-addresses \\\n -H \"Authorization: Bearer tk_live_xxxxxxxxxxxxxxxxxxxx\""},{"lang":"javascript","label":"Node.js","source":"const res = await fetch(\"https://tawked.com/v1/email/inbound-addresses\", {\n headers: {\n Authorization: \"Bearer tk_live_xxxxxxxxxxxxxxxxxxxx\",\n },\n});\nconst data = await res.json();"},{"lang":"python","label":"Python","source":"import requests\n\nres = requests.get(\n \"https://tawked.com/v1/email/inbound-addresses\",\n headers={\"Authorization\": \"Bearer tk_live_xxxxxxxxxxxxxxxxxxxx\"},\n)\ndata = res.json()"}],"x-mint":{"content":"Guide: [Receiving email](/email/receiving)"},"method":"get","type":"path","servers":["098b5cff-a5a4-40d5-a09c-d4f2de097e74","8e6ac1df-d7eb-4814-92be-cac11ef83826"],"security":["f1a99a99-6a6a-42b3-93ac-e626d326e9e6","fe7bec02-0049-4146-a16f-86fd192472c9"],"path":"/v1/email/inbound-addresses","baseUrlOptions":["https://tawked.com","https://tawked.com/api"],"title":"List receiving addresses","codeSamples":[{"label":"cURL","lang":"bash","source":"curl https://tawked.com/v1/email/inbound-addresses \\\n -H \"Authorization: Bearer tk_live_xxxxxxxxxxxxxxxxxxxx\""},{"label":"Node.js","lang":"javascript","source":"const res = await fetch(\"https://tawked.com/v1/email/inbound-addresses\", {\n headers: {\n Authorization: \"Bearer tk_live_xxxxxxxxxxxxxxxxxxxx\",\n },\n});\nconst data = await res.json();"},{"label":"Python","lang":"python","source":"import requests\n\nres = requests.get(\n \"https://tawked.com/v1/email/inbound-addresses\",\n headers={\"Authorization\": \"Bearer tk_live_xxxxxxxxxxxxxxxxxxxx\"},\n)\ndata = res.json()"}],"requestExampleLanguages":["bash","javascript","php","python"],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"e720bb1d-cc6f-480c-8139-4e3daf7a3023":{"description":"The addresses","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"data.items.[INDEX].id","typeLabel":"string"},"kind":{"type":"string","uniqueKey":"data.items.[INDEX].kind","typeLabel":"string"},"domain":{"type":"string","uniqueKey":"data.items.[INDEX].domain","typeLabel":"string"},"example":{"type":"string","uniqueKey":"data.items.[INDEX].example","typeLabel":"string"},"state":{"type":"string","uniqueKey":"data.items.[INDEX].state","typeLabel":"string"},"held":{"oneOf":[{"type":"string","uniqueKey":"data.items.[INDEX].held.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.items.[INDEX].held.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].held","typeLabel":"string | null"},"spam_policy":{"type":"string","uniqueKey":"data.items.[INDEX].spam_policy","typeLabel":"string"},"forward":{"type":"object","properties":{"to":{"type":"string","uniqueKey":"data.items.[INDEX].forward.to","typeLabel":"string"},"from":{"type":"string","uniqueKey":"data.items.[INDEX].forward.from","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX].forward","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","uniqueKey":"data.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"the_addresses":{"title":"the_addresses","value":{"data":[{"id":"0199f2b0-1a2b-7c3d-8e4f-5a6b7c8d9e0f","kind":"domain","domain":"inbound.acme.sa","example":"orders@inbound.acme.sa","state":"active","held":null,"spam_policy":"keep","forward":{"to":"ops@acme.sa","from":"no-reply@acme.sa"},"created_at":"2026-10-25T08:00:00+00:00"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"7fafac74-acda-4ef8-926a-764b7093c430":{"description":"`service_required`: Partner key used with no `application` (or `service`) in the request body.; `invalid_json`: The request body is not valid JSON.; `invalid_request`: start: `to` (and `phone`) both missing or blank. check: `id` or `code` missing.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"A stable machine-readable code; the docs list every one.","enum":["service_required","invalid_json","invalid_request"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"service_required"}}},"exampleType":"generated"}},"exampleType":"generated"},"6258ef11-47a5-4365-a281-f1c4e756fd7b":{"description":"`unauthorized`: Missing, unknown, revoked, or mode-mismatched key; or an unknown/suspended partner.; `key_expired`: The key's `expires_at` has passed. Checked right after the key is recognised, before the IP allowlist or scope.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"A stable machine-readable code; the docs list every one.","enum":["unauthorized","key_expired"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"unauthorized"}}},"exampleType":"generated"}},"exampleType":"generated"},"1bb45b29-5617-4cb9-b25f-ee6f88cedd27":{"description":"No email:inbound / `live_key_required`: A test (tk_test_) key on a management endpoint: domains, suppressions, metrics and templates are the account's real objects, managed with the application's live key, and received e-mail is read with it too. A test key sends, reads and cancels messages in test mode; a partner's test key (tk_partner_test_) has no e-mail at all.; `account_not_active`: The application is not approved yet, the account is banned, or a partner disabled this application. All four causes share this one response.; `ip_not_allowed`: The caller's IP does not match the key's `ip_allowlist` (exact IPs and/or CIDR ranges, IPv4 and IPv6).; `insufficient_scope`: The key was not granted this call: a custom key without this product, or with a level below the call, such as a key that checks where the call sends. The response header `WWW-Authenticate` names the scope the call needs. Judged right after the key is recognised, before `account_not_active` and the request's shape. This operation needs `email:inbound`.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"A stable machine-readable code; the docs list every one.","enum":["live_key_required","account_not_active","ip_not_allowed","insufficient_scope"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"no_email_inbound":{"title":"no_email_inbound","value":{"error":"insufficient_scope"}}},"exampleType":"examples"}},"headers":{"WWW-Authenticate":{"description":"Sent with `insufficient_scope` only: the scope this operation needs, which the key was not granted.","schema":{"type":"string"},"example":"Bearer error=\"insufficient_scope\", scope=\"email:inbound\""}},"exampleType":"examples"},"f762011a-c644-42bb-9cdb-e33b80a6f97c":{"description":"`service_not_found`: Partner key, but `application`/`service` does not match any of that partner's provisioned applications.; `not_found`: No received e-mail of this application has that id: another application's, one you deleted, one past the 30 days, or an attachment of another e-mail. A partner's key, which receives no e-mail, gets it on every received e-mail call.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"A stable machine-readable code; the docs list every one.","enum":["service_not_found","not_found"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"service_not_found"}}},"exampleType":"generated"}},"exampleType":"generated"},"f752e7f9-cb5c-4ff2-b7ba-81db3785cfaf":{"description":"`too_many_requests`: Per-key rate limit exceeded (default 120 requests/minute, fixed 60s window; 1,200 on the e-mail endpoints). Checked before authentication. The `Retry-After` header gives the seconds to the next window.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"A stable machine-readable code; the docs list every one.","enum":["too_many_requests"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"too_many_requests"}}},"exampleType":"generated"}},"exampleType":"generated"},"34dd86a3-cc19-4566-a77e-8508c66f37de":{"description":"`internal_error`: An unhandled server error. Quote the X-Request-Id header if you report it.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"A stable machine-readable code; the docs list every one.","enum":["internal_error"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"internal_error"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f1a99a99-6a6a-42b3-93ac-e626d326e9e6":{"bearerKey":{"type":"http","scheme":"bearer","description":"Authorization: Bearer \u003capi key>. An application key (tk_live_, tk_test_) has full access, which covers every product and any product added later, or custom access, chosen when the key is created: one or more of the scopes `verify:check`, `verify:send` (includes `verify:check`), `notifications:read`, `notifications:send` (includes `notifications:read`), `email:read`, `email:send` (includes `email:read`), `email:manage` (includes `email:send`), `webhooks:manage`, `email:inbound`, `notifications:templates` (includes `notifications:read`), `chat:menus`, `chat:attendant`. No key made on the API keys page holds `notifications:templates`, full access included: the three template writes answer such a key 403 `insufficient_scope`. A connected app's key holds it. Nor `chat:menus`: the five conversation menu operations answer such a key 403 `insufficient_scope`, and a connected app's key holds it once the client approved it. Nor `chat:attendant`: the five auto-attendant operations answer such a key 403 `insufficient_scope` too, and a connected app's key holds it once the client approved it. `email:manage` and `webhooks:manage` are held only by a key someone chose them for: a full-access key, old or new, never holds them. `email:inbound`, which reads, deletes and forwards received e-mail, is opt-in on every key, full access included: a key holds it only when it was turned on when the key was created. A call outside the key's access answers 403 `insufficient_scope` and names the scope it needs in the `WWW-Authenticate` response header. A partner key (tk_partner_) always has full access. Whatever its access, a key is a server-side secret.","scopes":[],"schemeName":"bearerKey"}},"fe7bec02-0049-4146-a16f-86fd192472c9":{"headerKey":{"type":"apiKey","in":"header","name":"x-api-key","description":"The same API key, with the same access, as a header, for clients that cannot set Authorization.","scopes":[],"schemeName":"headerKey"}}},"servers":{"098b5cff-a5a4-40d5-a09c-d4f2de097e74":{"url":"https://tawked.com","description":"Production (the sandbox is a tk_test_ key on the same host)"},"8e6ac1df-d7eb-4814-92be-cac11ef83826":{"url":"https://tawked.com/api","description":"The same API under /api/v1/..., kept for older integrations"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Authorization: Bearer \u003capi key>. An application key (tk_live_, tk_test_) has full access, which covers every product and any product added later, or custom access, chosen when the key is created: one or more of the scopes `verify:check`, `verify:send` (includes `verify:check`), `notifications:read`, `notifications:send` (includes `notifications:read`), `email:read`, `email:send` (includes `email:read`), `email:manage` (includes `email:send`), `webhooks:manage`, `email:inbound`, `notifications:templates` (includes `notifications:read`), `chat:menus`, `chat:attendant`. No key made on the API keys page holds `notifications:templates`, full access included: the three template writes answer such a key 403 `insufficient_scope`. A connected app's key holds it. Nor `chat:menus`: the five conversation menu operations answer such a key 403 `insufficient_scope`, and a connected app's key holds it once the client approved it. Nor `chat:attendant`: the five auto-attendant operations answer such a key 403 `insufficient_scope` too, and a connected app's key holds it once the client approved it. `email:manage` and `webhooks:manage` are held only by a key someone chose them for: a full-access key, old or new, never holds them. `email:inbound`, which reads, deletes and forwards received e-mail, is opt-in on every key, full access included: a key holds it only when it was turned on when the key was created. A call outside the key's access answers 403 `insufficient_scope` and names the scope it needs in the `WWW-Authenticate` response header. A partner key (tk_partner_) always has full access. Whatever its access, a key is a server-side secret.","scopes":[],"schemeName":"bearerKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Authorization: Bearer \u003capi key>. An application key (tk_live_, tk_test_) has full access, which covers every product and any product added later, or custom access, chosen when the key is created: one or more of the scopes `verify:check`, `verify:send` (includes `verify:check`), `notifications:read`, `notifications:send` (includes `notifications:read`), `email:read`, `email:send` (includes `email:read`), `email:manage` (includes `email:send`), `webhooks:manage`, `email:inbound`, `notifications:templates` (includes `notifications:read`), `chat:menus`, `chat:attendant`. No key made on the API keys page holds `notifications:templates`, full access included: the three template writes answer such a key 403 `insufficient_scope`. A connected app's key holds it. Nor `chat:menus`: the five conversation menu operations answer such a key 403 `insufficient_scope`, and a connected app's key holds it once the client approved it. Nor `chat:attendant`: the five auto-attendant operations answer such a key 403 `insufficient_scope` too, and a connected app's key holds it once the client approved it. `email:manage` and `webhooks:manage` are held only by a key someone chose them for: a full-access key, old or new, never holds them. `email:inbound`, which reads, deletes and forwards received e-mail, is opt-in on every key, full access included: a key holds it only when it was turned on when the key was created. A call outside the key's access answers 403 `insufficient_scope` and names the scope it needs in the `WWW-Authenticate` response header. A partner key (tk_partner_) always has full access. Whatever its access, a key is a server-side secret.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerKey","name":"Authorization"}],"title":"bearerKey"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"The same API key, with the same access, as a header, for clients that cannot set Authorization.","scopes":[],"schemeName":"headerKey"},"schema":{"title":"x-api-key","type":"string","description":"The same API key, with the same access, as a header, for clients that cannot set Authorization.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"headerKey","name":"x-api-key"}],"title":"headerKey"}]},"originalFileLocation":"https://tawked.com/openapi.json"},"subdomain":"tawked","siteName":"Tawked","title":"List receiving addresses - Tawked","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/email/list-receiving-addresses.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=\"Lists the application\u0026#x27;s receiving addresses, oldest first: its kind (domain, a subdomain of your domain, or hosted, one Tawked gives), the domain where every local part reaches you, an example, its state, a hold, what it does with spam and its automatic forward. Addresses are added in the console.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Tawked\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tawked/1Q4IItpqEOP1_JUm/_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/tawked/1Q4IItpqEOP1_JUm/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tawked/1Q4IItpqEOP1_JUm/_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/tawked/1Q4IItpqEOP1_JUm/_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/tawked/1Q4IItpqEOP1_JUm/_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/tawked/1Q4IItpqEOP1_JUm/_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/tawked/1Q4IItpqEOP1_JUm/_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/tawked/1Q4IItpqEOP1_JUm/_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/tawked/1Q4IItpqEOP1_JUm/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List receiving addresses - Tawked\">\u003cmeta data-mint-head property=\"og:description\" content=\"Lists the application\u0026#x27;s receiving addresses, oldest first: its kind (domain, a subdomain of your domain, or hosted, one Tawked gives), the domain where every local part reaches you, an example, its state, a hold, what it does with spam and its automatic forward. Addresses are added in the console.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Tawked developer docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tawked.com/api-reference/email/list-receiving-addresses\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tawked.com/og/developer-docs-en.png?v=27df06570d\">\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=\"List receiving addresses - Tawked\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Lists the application\u0026#x27;s receiving addresses, oldest first: its kind (domain, a subdomain of your domain, or hosted, one Tawked gives), the domain where every local part reaches you, an example, its state, a hold, what it does with spam and its automatic forward. Addresses are added in the console.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tawked.com/og/developer-docs-en.png?v=27df06570d\">\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/tawked/1Q4IItpqEOP1_JUm/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Tawked\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003cmeta data-mint-head name=\"og:image:type\" content=\"image/png\">\u003cmeta data-mint-head name=\"og:image:alt\" content=\"Tawked developer docs. Verify, WhatsApp, Chat, Email and the Account API\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tawked.com/api-reference/email/list-receiving-addresses\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/email/list-receiving-addresses.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.tawked.com/#organization\",\"name\":\"Tawked\",\"url\":\"https://docs.tawked.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tawked/Vn57enlu2GVgFv-J/logo/light.svg?fit=max\u0026auto=format\u0026n=Vn57enlu2GVgFv-J\u0026q=85\u0026s=353a0cedb91848c1296f205d3552fcca\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tawked.com#website\",\"name\":\"Tawked\",\"url\":\"https://docs.tawked.com\",\"publisher\":{\"@id\":\"https://docs.tawked.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tawked.com/api-reference/email/list-receiving-addresses#webpage\",\"url\":\"https://docs.tawked.com/api-reference/email/list-receiving-addresses\",\"name\":\"List receiving addresses\",\"description\":\"Lists the application's receiving addresses, oldest first: its kind (domain, a subdomain of your domain, or hosted, one Tawked gives), the domain where every local part reaches you, an example, its state, a hold, what it does with spam and its automatic forward. Addresses are added in the console.\",\"isPartOf\":{\"@id\":\"https://docs.tawked.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tawked.com/api-reference/email/list-receiving-addresses#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tawked.com/api-reference/email/list-receiving-addresses#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Email\",\"item\":\"https://docs.tawked.com/api-reference/email/list-emails\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List receiving addresses\",\"item\":\"https://docs.tawked.com/api-reference/email/list-receiving-addresses\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tawked.com/api-reference/email/list-receiving-addresses#apireference\",\"headline\":\"List receiving addresses\",\"name\":\"List receiving addresses\",\"description\":\"Lists the application's receiving addresses, oldest first: its kind (domain, a subdomain of your domain, or hosted, one Tawked gives), the domain where every local part reaches you, an example, its state, a hold, what it does with spam and its automatic forward. Addresses are added in the console.\",\"url\":\"https://docs.tawked.com/api-reference/email/list-receiving-addresses\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tawked.com/api-reference/email/list-receiving-addresses#webpage\"},\"image\":\"https://tawked.com/og/developer-docs-en.png?v=27df06570d\",\"publisher\":{\"@id\":\"https://docs.tawked.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tawked.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Tawked\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Tawked","nav":{"global":{"anchors":[{"anchor":"Status","icon":"signal","href":"https://tawked.com/en/status"}]},"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":""}]},{"tab":"Integrations","icon":"plug","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"API reference","icon":"square-terminal","groups":[{"group":"Verify","pages":[{"title":"Start a verification","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/verify/start","href":"/api-reference/verify/start-a-verification"},{"title":"Check a code","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/verify/check","href":"/api-reference/verify/check-a-code"},{"title":"Get a verification","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/verify/{id}","href":"/api-reference/verify/get-a-verification"},{"title":"Resend a code","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/verify/{id}/resend","href":"/api-reference/verify/resend-a-code"},{"title":"Cancel a verification","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/verify/{id}/cancel","href":"/api-reference/verify/cancel-a-verification"}]},{"group":"Notifications","pages":[{"title":"Send a template message","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/whatsapp/messages","href":"/api-reference/whatsapp/send-a-template-message"},{"title":"Get a message","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/whatsapp/messages/{id}","href":"/api-reference/whatsapp/get-a-message"},{"title":"List templates","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/whatsapp/templates","href":"/api-reference/whatsapp/list-templates"},{"title":"Create a template","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/whatsapp/templates","href":"/api-reference/whatsapp/create-a-template"},{"title":"Get a template","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/whatsapp/templates/{template_id}","href":"/api-reference/whatsapp/get-a-template"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json delete /v1/whatsapp/templates/{template_id}","href":"/api-reference/whatsapp/delete-a-template"},{"title":"Update a template","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json patch /v1/whatsapp/templates/{template_id}","href":"/api-reference/whatsapp/update-a-template"}]},{"group":"Email","pages":[{"title":"List emails","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/messages","href":"/api-reference/email/list-emails"},{"title":"Send an email","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/messages","href":"/api-reference/email/send-an-email"},{"title":"Send a batch of emails","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/messages/batch","href":"/api-reference/email/send-a-batch-of-emails"},{"title":"Get an email","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/messages/{id}","href":"/api-reference/email/get-an-email"},{"title":"Reschedule an email","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json patch /v1/email/messages/{id}","href":"/api-reference/email/reschedule-an-email"},{"title":"Cancel a scheduled email","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/messages/{id}/cancel","href":"/api-reference/email/cancel-a-scheduled-email"},{"title":"Check an email key","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/key","href":"/api-reference/email/check-an-email-key"},{"title":"Get an email's content","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/messages/{id}/content","href":"/api-reference/email/get-an-emails-content"},{"title":"List domains","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/domains","href":"/api-reference/email/list-domains"},{"title":"Add a domain","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/domains","href":"/api-reference/email/add-a-domain"},{"title":"Get a domain","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/domains/{id}","href":"/api-reference/email/get-a-domain"},{"title":"Remove a domain","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json delete /v1/email/domains/{id}","href":"/api-reference/email/remove-a-domain"},{"title":"Update a domain","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json patch /v1/email/domains/{id}","href":"/api-reference/email/update-a-domain"},{"title":"Check a domain now","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/domains/{id}/verify","href":"/api-reference/email/check-a-domain-now"},{"title":"List suppressed addresses","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/suppressions","href":"/api-reference/email/list-suppressed-addresses"},{"title":"Suppress addresses","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/suppressions","href":"/api-reference/email/suppress-addresses"},{"title":"Look up an address","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/suppressions/{address}","href":"/api-reference/email/look-up-an-address"},{"title":"Lift an address","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json delete /v1/email/suppressions/{address}","href":"/api-reference/email/lift-an-address"},{"title":"Import suppressed addresses","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/suppressions/imports","href":"/api-reference/email/import-suppressed-addresses"},{"title":"Get an import","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/suppressions/imports/{id}","href":"/api-reference/email/get-an-import"},{"title":"Get email metrics","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/metrics","href":"/api-reference/email/get-email-metrics"},{"title":"List templates","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/templates","href":"/api-reference/email/list-templates"},{"title":"Create a template","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/templates","href":"/api-reference/email/create-a-template"},{"title":"Get a template","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/templates/{id}","href":"/api-reference/email/get-a-template"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json delete /v1/email/templates/{id}","href":"/api-reference/email/delete-a-template"},{"title":"Update a template","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json patch /v1/email/templates/{id}","href":"/api-reference/email/update-a-template"},{"title":"Publish a template","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/templates/{id}/publish","href":"/api-reference/email/publish-a-template"},{"title":"List a template's versions","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/templates/{id}/versions","href":"/api-reference/email/list-a-templates-versions"},{"title":"Get a template version","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/templates/{id}/versions/{number}","href":"/api-reference/email/get-a-template-version"},{"title":"Restore a template version","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/templates/{id}/versions/{number}/restore","href":"/api-reference/email/restore-a-template-version"},{"title":"List received emails","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/received","href":"/api-reference/email/list-received-emails"},{"title":"Get a received email","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/received/{id}","href":"/api-reference/email/get-a-received-email"},{"title":"Delete a received email","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json delete /v1/email/received/{id}","href":"/api-reference/email/delete-a-received-email"},{"title":"Download a received email's raw message","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/received/{id}/raw","href":"/api-reference/email/download-a-received-emails-raw-message"},{"title":"Download a received attachment","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/received/{id}/attachments/{attachment}","href":"/api-reference/email/download-a-received-attachment"},{"title":"Forward a received email","description":"Sends the received e-mail on as a new e-mail from your verified domain: its subject, bodies and attachments, `reply_to` its sender, your note above it. It is a send like any other, charged at the send's price and answered with the same `202`. Needs `email:inbound` and `email:send`. Never more than 10 attachments and 10 MiB; an attachment that could run a program is never forwarded.","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/received/{id}/forward","href":"/api-reference/email/forward-a-received-email"},{"title":"List receiving addresses","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/email/inbound-addresses","href":"/api-reference/email/list-receiving-addresses"},{"title":"Simulate a received email","description":"With a test key (tk_test_) holding `email:send`: sends one `email.received` webhook in test mode (`\"mode\": \"test\"` in the envelope) to the endpoints that receive test events, as if a message had reached the application's hosted address (else its first). Nothing is received, stored or charged, so the id is the event's alone: the received e-mail reads answer it 404. A live key answers `403 test_key_required`. Counts against test mode's 1000 a day for an application (Tawked's limit). Takes no body.","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/email/received/test","href":"/api-reference/email/simulate-a-received-email"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/webhooks","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/webhooks","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/webhooks/{id}","href":"/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json delete /v1/webhooks/{id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json patch /v1/webhooks/{id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Rotate a webhook secret","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/webhooks/{id}/rotate-secret","href":"/api-reference/webhooks/rotate-a-webhook-secret"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/webhooks/{id}/test","href":"/api-reference/webhooks/send-a-test-event"},{"title":"List deliveries","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/webhooks/{id}/deliveries","href":"/api-reference/webhooks/list-deliveries"},{"title":"Get a delivery","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/webhooks/{id}/deliveries/{delivery}","href":"/api-reference/webhooks/get-a-delivery"},{"title":"Send a delivery again","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/webhooks/{id}/deliveries/{delivery}/replay","href":"/api-reference/webhooks/send-a-delivery-again"},{"title":"Replay deliveries","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/webhooks/{id}/replay","href":"/api-reference/webhooks/replay-deliveries"},{"title":"Get a replay","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/webhooks/{id}/replays/{replay}","href":"/api-reference/webhooks/get-a-replay"},{"title":"Verification verified","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook verification.verified","href":"/api-reference/webhooks/verification-verified"},{"title":"Verification failed","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook verification.failed","href":"/api-reference/webhooks/verification-failed"},{"title":"Verification expired","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook verification.expired","href":"/api-reference/webhooks/verification-expired"},{"title":"Message sent","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook message.sent","href":"/api-reference/webhooks/message-sent"},{"title":"Message delivered","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook message.delivered","href":"/api-reference/webhooks/message-delivered"},{"title":"Message read","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook message.read","href":"/api-reference/webhooks/message-read"},{"title":"Message failed","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook message.failed","href":"/api-reference/webhooks/message-failed"},{"title":"Email delivered","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.delivered","href":"/api-reference/webhooks/email-delivered"},{"title":"Email bounced","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.bounced","href":"/api-reference/webhooks/email-bounced"},{"title":"Email complained","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.complained","href":"/api-reference/webhooks/email-complained"},{"title":"Email failed","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.failed","href":"/api-reference/webhooks/email-failed"},{"title":"Email sent","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.sent","href":"/api-reference/webhooks/email-sent"},{"title":"Email delivery delayed","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.delivery_delayed","href":"/api-reference/webhooks/email-delivery-delayed"},{"title":"Email suppressed","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.suppressed","href":"/api-reference/webhooks/email-suppressed"},{"title":"Email scheduled","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.scheduled","href":"/api-reference/webhooks/email-scheduled"},{"title":"Email canceled","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.canceled","href":"/api-reference/webhooks/email-canceled"},{"title":"Email opened","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.opened","href":"/api-reference/webhooks/email-opened"},{"title":"Email clicked","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.clicked","href":"/api-reference/webhooks/email-clicked"},{"title":"Domain created","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook domain.created","href":"/api-reference/webhooks/domain-created"},{"title":"Domain verified","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook domain.verified","href":"/api-reference/webhooks/domain-verified"},{"title":"Domain failed","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook domain.failed","href":"/api-reference/webhooks/domain-failed"},{"title":"Domain removed","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook domain.removed","href":"/api-reference/webhooks/domain-removed"},{"title":"Suppression added","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook suppression.added","href":"/api-reference/webhooks/suppression-added"},{"title":"Suppression removed","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook suppression.removed","href":"/api-reference/webhooks/suppression-removed"},{"title":"Email received","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook email.received","href":"/api-reference/webhooks/email-received"},{"title":"Service approved","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook service.approved","href":"/api-reference/webhooks/service-approved"},{"title":"Service rejected","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook service.rejected","href":"/api-reference/webhooks/service-rejected"},{"title":"Service suspended","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook service.suspended","href":"/api-reference/webhooks/service-suspended"},{"title":"Service resumed","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook service.resumed","href":"/api-reference/webhooks/service-resumed"},{"title":"Service paused","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook service.paused","href":"/api-reference/webhooks/service-paused"},{"title":"Service unpaused","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook service.unpaused","href":"/api-reference/webhooks/service-unpaused"},{"title":"Service review requested","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook service.review_requested","href":"/api-reference/webhooks/service-review-requested"},{"title":"Service archived","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook service.archived","href":"/api-reference/webhooks/service-archived"},{"title":"Service restored","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook service.restored","href":"/api-reference/webhooks/service-restored"},{"title":"Balance low","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook balance.low","href":"/api-reference/webhooks/balance-low"},{"title":"Verification verified partner","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook partner.verification.verified","href":"/api-reference/webhooks/verification-verified-partner"},{"title":"Verification failed partner","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook partner.verification.failed","href":"/api-reference/webhooks/verification-failed-partner"},{"title":"Verification expired partner","version":null,"deprecated":null,"openapi":"https://tawked.com/openapi.json webhook partner.verification.expired","href":"/api-reference/webhooks/verification-expired-partner"}]},{"group":"Chat","pages":[{"title":"List menus","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/chat/menus","href":"/api-reference/chat/list-menus"},{"title":"Add a menu","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/chat/menus","href":"/api-reference/chat/add-a-menu"},{"title":"Get a menu","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/chat/menus/{id}","href":"/api-reference/chat/get-a-menu"},{"title":"Delete a menu","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json delete /v1/chat/menus/{id}","href":"/api-reference/chat/delete-a-menu"},{"title":"Update a menu","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json patch /v1/chat/menus/{id}","href":"/api-reference/chat/update-a-menu"},{"title":"Get the auto-attendant","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/chat/attendant","href":"/api-reference/chat/get-the-auto-attendant"},{"title":"Save the auto-attendant draft","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json put /v1/chat/attendant/draft","href":"/api-reference/chat/save-the-auto-attendant-draft"},{"title":"Publish the auto-attendant","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/chat/attendant/publish","href":"/api-reference/chat/publish-the-auto-attendant"},{"title":"Switch the auto-attendant on or off","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json put /v1/chat/attendant/state","href":"/api-reference/chat/switch-the-auto-attendant-on-or-off"},{"title":"Update the auto-attendant settings","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json patch /v1/chat/attendant/settings","href":"/api-reference/chat/update-the-auto-attendant-settings"}]},{"group":"Partner API","pages":[{"title":"Get the profile","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/partner/profile","href":"/api-reference/partner/get-the-profile"},{"title":"Preview the screening","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/partner/screening","href":"/api-reference/partner/preview-the-screening"},{"title":"List applications","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/partner/applications","href":"/api-reference/partner/list-applications"},{"title":"Provision an application","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/partner/applications","href":"/api-reference/partner/provision-an-application"},{"title":"Provision in bulk","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/partner/applications/batch","href":"/api-reference/partner/provision-in-bulk"},{"title":"Get an application","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/partner/applications/{external_id}","href":"/api-reference/partner/get-an-application"},{"title":"Update the brand","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json patch /v1/partner/applications/{external_id}","href":"/api-reference/partner/update-the-brand"},{"title":"Get the history","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/partner/applications/{external_id}/history","href":"/api-reference/partner/get-the-history"},{"title":"Upload the logo","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/partner/applications/{external_id}/logo","href":"/api-reference/partner/upload-the-logo"},{"title":"Remove the logo","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json delete /v1/partner/applications/{external_id}/logo","href":"/api-reference/partner/remove-the-logo"},{"title":"Update the verify settings","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json patch /v1/partner/applications/{external_id}/verify-settings","href":"/api-reference/partner/update-the-verify-settings"},{"title":"Suspend an application","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/partner/applications/{external_id}/suspend","href":"/api-reference/partner/suspend-an-application"},{"title":"Resume an application","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/partner/applications/{external_id}/resume","href":"/api-reference/partner/resume-an-application"},{"title":"Unpause an application","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/partner/applications/{external_id}/unpause","href":"/api-reference/partner/unpause-an-application"},{"title":"Archive an application","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/partner/applications/{external_id}/archive","href":"/api-reference/partner/archive-an-application"},{"title":"Restore an application","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/partner/applications/{external_id}/restore","href":"/api-reference/partner/restore-an-application"},{"title":"Get usage","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/partner/usage","href":"/api-reference/partner/get-usage"},{"title":"List verifications","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/partner/verifications","href":"/api-reference/partner/list-verifications"},{"title":"Get the event feed","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/partner/events","href":"/api-reference/partner/get-the-event-feed"},{"title":"Get the webhook","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/partner/webhook","href":"/api-reference/partner/get-the-webhook"},{"title":"Update the webhook","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json put /v1/partner/webhook","href":"/api-reference/partner/update-the-webhook"},{"title":"List deliveries","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json get /v1/partner/webhook/deliveries","href":"/api-reference/partner/list-deliveries"},{"title":"Retry a delivery","deprecated":null,"version":null,"openapi":"https://tawked.com/openapi.json post /v1/partner/webhook/deliveries/{id}/retry","href":"/api-reference/partner/retry-a-delivery"}]}]},{"tab":"Account API","icon":"user-gear","pages":[{"title":"Account API","href":"/account-api/overview"}]},{"tab":"Changelog","icon":"list","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"List receiving addresses - Tawked","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}