Your workspace API key, created in Settings → Developer → API keys, sent as
Authorization: Bearer <key>. New keys start with watx_live_; keys
issued before the rename start with converse360_live_ and still work.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Watx","description":"Documentation for Watx: one inbox for WhatsApp, Instagram and website chat, with a CRM, automations, flows, forms, AI agents, integrations and a public API.","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/watx/RbII_Y84cOqYh7_M/logo/light.svg?fit=max\u0026auto=format\u0026n=RbII_Y84cOqYh7_M\u0026q=85\u0026s=9f016a244568da620d7a646c56e7889f","dark":"https://mintcdn.com/watx/RbII_Y84cOqYh7_M/logo/dark.svg?fit=max\u0026auto=format\u0026n=RbII_Y84cOqYh7_M\u0026q=85\u0026s=0bb6c63111efdfd7ef7a399e6887ab21","href":"https://app.watx.in"},"favicon":{"light":"https://mintcdn.com/watx/BcZx4nq4blikJB48/images/watx-mark-light.png?fit=max\u0026auto=format\u0026n=BcZx4nq4blikJB48\u0026q=85\u0026s=5cb4a28aa55834fb3a854e26ba4b8b50","dark":"https://mintcdn.com/watx/BcZx4nq4blikJB48/images/watx-mark-dark.png?fit=max\u0026auto=format\u0026n=BcZx4nq4blikJB48\u0026q=85\u0026s=9d042920d09f1124ec9cced5a27f3486"},"navbar":{"links":[{"icon":"paper-plane","href":"/api/postman","label":"Postman collection"},{"href":"mailto:support@watx.in","label":"Support"}],"primary":{"type":"button","label":"Open Watx","href":"https://app.watx.in"}},"footer":{"links":[{"header":"Product","items":[{"label":"Open Watx","href":"https://app.watx.in"},{"label":"Pricing","href":"https://app.watx.in/pricing"}]},{"header":"Help","items":[{"label":"Support","href":"mailto:support@watx.in"}]}]},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"watx","hasAudioNarration":false,"actualSubdomain":"watx","customDomains":["docs.watx.in"],"gitSource":{"type":"github","owner":"sivakrishnacode","repo":"watx-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ad4bb0a5ec9dc5442eb45c9","collectionId":"915b525b-9f30-403d-be81-db443151af68","liveDeploymentHistoryId":"6ad4bb0a5ec9dc5442eb45c9","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ad4bb0a5ec9dc5442eb45c9","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Guides","count":80},{"language":"default","tag":"API reference","count":29},{"language":"default","tag":"Channels","count":28},{"language":"default","tag":"Integrations","count":17},{"language":"default","tag":"WhatsApp","count":15},{"language":"default","tag":"AI agents","count":10},{"language":"default","tag":"Automations","count":10},{"language":"default","tag":"Forms","count":8},{"language":"default","tag":"Instagram","count":8},{"language":"default","tag":"Segments","count":8}]},"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":"per-site-search-delta","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":"editor-private-page-search","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":"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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/conversations/get-a-conversation","slug":"/api-reference/conversations/get-a-conversation","pageMetadata":{"title":"Get a conversation","description":"Returns one conversation with its contact. A conversation belonging to\nanother workspace answers `404`.\n\nRequires the `conversations:read` scope.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /conversations/{id}","href":"/api-reference/conversations/get-a-conversation","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, 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(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Returns one conversation with its contact. A conversation belonging to\\nanother workspace answers \", _jsx(_components.code, {\n children: \"404\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Requires the \", _jsx(_components.code, {\n children: \"conversations:read\"\n }), \" scope.\"]\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 conversation","description":"Returns one conversation with its contact. A conversation belonging to\nanother workspace answers `404`.\n\nRequires the `conversations:read` scope.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /conversations/{id}","href":"/api-reference/conversations/get-a-conversation","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getConversation","tags":["Conversations"],"summary":"Get a conversation","description":"Returns one conversation with its contact. A conversation belonging to\nanother workspace answers `404`.\n\nRequires the `conversations:read` scope.\n","x-required-scope":"conversations:read","responses":{"200":"07ca92c5-1056-4520-8c3f-0fbc85f458eb","401":"2a0c539f-bc20-4b71-8def-36f14c2a43a3","403":"518e9c22-01a8-49c2-9dfa-65ec1b5b69a0","404":"d9de00ff-d046-4cbd-9ecb-ea87a1d75113","429":"61277fc1-43f1-4f6f-af2f-d69dfd50c1d1"},"method":"get","type":"path","servers":["aad385d4-3f88-431f-bb44-1cd2895693b4"],"security":["c3ff3544-094c-4808-a459-57f829ae83c9"],"path":"/conversations/{id}","baseUrlOptions":["https://api.watx.in/v1"],"title":"Get a conversation","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c8046951-b118-46f7-89f9-4d62849eace4":{"name":"id","in":"path","required":true,"description":"The conversation id.","schema":{"type":"string","format":"uuid","isRequired":true,"description":"The conversation id.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"07ca92c5-1056-4520-8c3f-0fbc85f458eb":{"description":"The conversation.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"channel":{"type":"string","enum":["whatsapp","instagram","web"],"uniqueKey":"data.channel","typeLabel":"enum\u003cstring>"},"contact_id":{"type":"string","format":"uuid","uniqueKey":"data.contact_id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["open","pending","closed"],"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"assigned_agent_id":{"oneOf":[{"type":"string","description":"The member this conversation is assigned to, if any.","uniqueKey":"data.assigned_agent_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The member this conversation is assigned to, if any.","uniqueKey":"data.assigned_agent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.assigned_agent_id","typeLabel":"string | null"},"last_message_text":{"oneOf":[{"type":"string","uniqueKey":"data.last_message_text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.last_message_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.last_message_text","typeLabel":"string | null"},"last_message_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.last_message_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.last_message_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.last_message_at","typeLabel":"string\u003cdate-time> | null"},"last_inbound_at":{"oneOf":[{"type":"string","format":"date-time","description":"The customer's last message. The messaging window is measured from\nhere.\n","uniqueKey":"data.last_inbound_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The customer's last message. The messaging window is measured from\nhere.\n","uniqueKey":"data.last_inbound_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.last_inbound_at","typeLabel":"string\u003cdate-time> | null"},"unread_count":{"type":"integer","uniqueKey":"data.unread_count","typeLabel":"integer"},"created_at":{"type":"string","format":"date-time","uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"data.updated_at","typeLabel":"string\u003cdate-time>"},"contact":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"data.contact.oneOf.0.id","typeLabel":"string\u003cuuid>"},"phone":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.phone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.phone","typeLabel":"string | null"},"instagram_username":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.instagram_username.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.instagram_username.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.instagram_username","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.email","typeLabel":"string | null"},"company":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.company.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.company.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.company","typeLabel":"string | null"},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"data.contact.oneOf.0.tags.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","uniqueKey":"data.contact.oneOf.0.tags.items.[INDEX].name","typeLabel":"string"},"color":{"type":"string","description":"Hex colour, for example `#3b82f6`.","uniqueKey":"data.contact.oneOf.0.tags.items.[INDEX].color","typeLabel":"string"}},"uniqueKey":"data.contact.oneOf.0.tags.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.contact.oneOf.0.tags","typeLabel":"object[]"}},"uniqueKey":"data.contact.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.contact.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact","typeLabel":"object | null"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","channel":"whatsapp","contact_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"open","assigned_agent_id":"\u003cstring>","last_message_text":"\u003cstring>","last_message_at":"2023-11-07T05:31:56Z","last_inbound_at":"2023-11-07T05:31:56Z","unread_count":123,"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","contact":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","phone":"\u003cstring>","instagram_username":"\u003cstring>","name":"\u003cstring>","email":"\u003cstring>","company":"\u003cstring>","tags":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","color":"\u003cstring>"}]}}}}},"exampleType":"generated"}},"exampleType":"generated"},"2a0c539f-bc20-4b71-8def-36f14c2a43a3":{"description":"The key is missing, malformed, unknown, revoked or expired. All four\nanswer the same way.\n","content":{"application/json":{"schema":{"type":"object","description":"Every failure uses this shape. Branch on `error.code`, which is stable;\n`error.message` is written for people and may be reworded.\n","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"One of `bad_request`, `invalid_request`, `unauthorized`,\n`forbidden`, `not_found`, `rate_limited`, `internal`, or a\ndomain code such as `whatsapp_not_configured`, `meta_error`,\n`template_malformed`, `plan_limit_reached`,\n`subscription_lapsed`.\n","example":"bad_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"'phone' is required","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"unauthorized","message":"Missing or invalid API key"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthorized","message":"Missing or invalid API key"}}}},"exampleType":"examples"}},"exampleType":"examples"},"518e9c22-01a8-49c2-9dfa-65ec1b5b69a0":{"description":"The key is valid but was not granted the scope this operation requires.","content":{"application/json":{"schema":{"type":"object","description":"Every failure uses this shape. Branch on `error.code`, which is stable;\n`error.message` is written for people and may be reworded.\n","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"One of `bad_request`, `invalid_request`, `unauthorized`,\n`forbidden`, `not_found`, `rate_limited`, `internal`, or a\ndomain code such as `whatsapp_not_configured`, `meta_error`,\n`template_malformed`, `plan_limit_reached`,\n`subscription_lapsed`.\n","example":"bad_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"'phone' is required","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"forbidden","message":"This API key is missing the 'messages:send' scope"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"forbidden","message":"This API key is missing the 'messages:send' scope"}}}},"exampleType":"examples"}},"exampleType":"examples"},"d9de00ff-d046-4cbd-9ecb-ea87a1d75113":{"description":"No such resource in this workspace. A resource belonging to another\nworkspace answers the same way.\n","content":{"application/json":{"schema":{"type":"object","description":"Every failure uses this shape. Branch on `error.code`, which is stable;\n`error.message` is written for people and may be reworded.\n","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"One of `bad_request`, `invalid_request`, `unauthorized`,\n`forbidden`, `not_found`, `rate_limited`, `internal`, or a\ndomain code such as `whatsapp_not_configured`, `meta_error`,\n`template_malformed`, `plan_limit_reached`,\n`subscription_lapsed`.\n","example":"bad_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"'phone' is required","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"not_found","message":"Contact not found"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"not_found","message":"Contact not found"}}}},"exampleType":"examples"}},"exampleType":"examples"},"61277fc1-43f1-4f6f-af2f-d69dfd50c1d1":{"description":"More than 120 requests in a minute for this key. `Retry-After` says how\nmany seconds to wait.\n","headers":{"Retry-After":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"X-RateLimit-Limit":{"description":"Requests allowed per window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in this window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Unix time in seconds when the window resets.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","description":"Every failure uses this shape. Branch on `error.code`, which is stable;\n`error.message` is written for people and may be reworded.\n","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"One of `bad_request`, `invalid_request`, `unauthorized`,\n`forbidden`, `not_found`, `rate_limited`, `internal`, or a\ndomain code such as `whatsapp_not_configured`, `meta_error`,\n`template_malformed`, `plan_limit_reached`,\n`subscription_lapsed`.\n","example":"bad_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"'phone' is required","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"rate_limited","message":"Rate limit exceeded for this API key"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"rate_limited","message":"Rate limit exceeded for this API key"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"c3ff3544-094c-4808-a459-57f829ae83c9":{"apiKey":{"type":"http","scheme":"bearer","description":"Your workspace API key, created in **Settings → Developer → API keys**, sent as\n`Authorization: Bearer \u003ckey>`. New keys start with `watx_live_`; keys\nissued before the rename start with `converse360_live_` and still work.\n","scopes":[],"schemeName":"apiKey"}}},"servers":{"aad385d4-3f88-431f-bb44-1cd2895693b4":{"url":"https://api.watx.in/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your workspace API key, created in **Settings → Developer → API keys**, sent as\n`Authorization: Bearer \u003ckey>`. New keys start with `watx_live_`; keys\nissued before the rename start with `converse360_live_` and still work.\n","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your workspace API key, created in **Settings → Developer → API keys**, sent as\n`Authorization: Bearer \u003ckey>`. New keys start with `watx_live_`; keys\nissued before the rename start with `converse360_live_` and still work.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"watx","siteName":"Watx","title":"Get a conversation - Watx","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-18T10:39:27.966Z","originalFileLocation":"api-reference/conversations/get-a-conversation.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=\"Returns one conversation with its contact. A conversation belonging to another workspace answers 404. Requires the conversations:read scope.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Watx\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/watx/o5UY8HKtkGMmwyEK/_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/watx/o5UY8HKtkGMmwyEK/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/watx/o5UY8HKtkGMmwyEK/_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/watx/o5UY8HKtkGMmwyEK/_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/watx/o5UY8HKtkGMmwyEK/_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/watx/o5UY8HKtkGMmwyEK/_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/watx/o5UY8HKtkGMmwyEK/_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/watx/o5UY8HKtkGMmwyEK/_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/watx/o5UY8HKtkGMmwyEK/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a conversation - Watx\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns one conversation with its contact. A conversation belonging to another workspace answers 404. Requires the conversations:read scope.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Watx\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.watx.in/api-reference/conversations/get-a-conversation\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://watx.mintlify.app/_mintlify/api/og/v2?division=Conversations\u0026amp;title=Get+a+conversation\u0026amp;description=Returns+one+conversation+with+its+contact.+A+conversation+belonging+to%0Aanother+workspace+answers+%60404%60.%0A%0ARequires+the+%60conversations%3Aread%60+scope.%0A\u0026amp;theme=4702c6122007e2df47c96f3b\u0026amp;signature=afe6bccd65678fe4b83aa11a03155b124daf78b6ae52f10cdb08b324e4d46700\">\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 conversation - Watx\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns one conversation with its contact. A conversation belonging to another workspace answers 404. Requires the conversations:read scope.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://watx.mintlify.app/_mintlify/api/og/v2?division=Conversations\u0026amp;title=Get+a+conversation\u0026amp;description=Returns+one+conversation+with+its+contact.+A+conversation+belonging+to%0Aanother+workspace+answers+%60404%60.%0A%0ARequires+the+%60conversations%3Aread%60+scope.%0A\u0026amp;theme=4702c6122007e2df47c96f3b\u0026amp;signature=afe6bccd65678fe4b83aa11a03155b124daf78b6ae52f10cdb08b324e4d46700\">\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/watx/o5UY8HKtkGMmwyEK/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Watx\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.watx.in/api-reference/conversations/get-a-conversation\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/conversations/get-a-conversation.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.watx.in/#organization\",\"name\":\"Watx\",\"url\":\"https://docs.watx.in\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/watx/RbII_Y84cOqYh7_M/logo/light.svg?fit=max\u0026auto=format\u0026n=RbII_Y84cOqYh7_M\u0026q=85\u0026s=9f016a244568da620d7a646c56e7889f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.watx.in#website\",\"name\":\"Watx\",\"url\":\"https://docs.watx.in\",\"publisher\":{\"@id\":\"https://docs.watx.in/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.watx.in/api-reference/conversations/get-a-conversation#webpage\",\"url\":\"https://docs.watx.in/api-reference/conversations/get-a-conversation\",\"name\":\"Get a conversation\",\"description\":\"Returns one conversation with its contact. A conversation belonging to another workspace answers 404. Requires the conversations:read scope.\",\"dateModified\":\"2026-10-18T10:39:27.966Z\",\"isPartOf\":{\"@id\":\"https://docs.watx.in#website\"},\"breadcrumb\":{\"@id\":\"https://docs.watx.in/api-reference/conversations/get-a-conversation#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.watx.in/api-reference/conversations/get-a-conversation#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Conversations\",\"item\":\"https://docs.watx.in/api-reference/conversations/list-conversations\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get a conversation\",\"item\":\"https://docs.watx.in/api-reference/conversations/get-a-conversation\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.watx.in/api-reference/conversations/get-a-conversation#apireference\",\"headline\":\"Get a conversation\",\"name\":\"Get a conversation\",\"description\":\"Returns one conversation with its contact. A conversation belonging to another workspace answers 404. Requires the conversations:read scope.\",\"url\":\"https://docs.watx.in/api-reference/conversations/get-a-conversation\",\"mainEntityOfPage\":{\"@id\":\"https://docs.watx.in/api-reference/conversations/get-a-conversation#webpage\"},\"dateModified\":\"2026-10-18T10:39:27.966Z\",\"publisher\":{\"@id\":\"https://docs.watx.in/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.watx.in#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Watx\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Watx","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"Channels","pages":[{"title":"Channels","href":"/whatsapp/overview"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API introduction","icon":"plug","href":"/api/introduction"},{"title":"Authentication","icon":"key","href":"/api/authentication"},{"title":"Requests and responses","icon":"code","href":"/api/requests-and-responses"},{"title":"Webhooks","icon":"bell","href":"/api/webhooks"},{"title":"Postman collection","icon":"paper-plane","href":"/api/postman"}]},{"group":"Account","pages":[{"title":"Who am I","deprecated":null,"version":null,"openapi":"/openapi.yaml get /me","href":"/api-reference/account/who-am-i"}]},{"group":"Messages","pages":[{"title":"Send a message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /messages","href":"/api-reference/messages/send-a-message"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /contacts/{id}","href":"/api-reference/contacts/get-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /contacts/{id}","href":"/api-reference/contacts/update-a-contact"}]},{"group":"Segments","pages":[{"title":"List segments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /segments","href":"/api-reference/segments/list-segments"},{"title":"Create a segment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /segments","href":"/api-reference/segments/create-a-segment"},{"title":"Get a segment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /segments/{id}","href":"/api-reference/segments/get-a-segment"},{"title":"Update a segment","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /segments/{id}","href":"/api-reference/segments/update-a-segment"},{"title":"Delete a segment","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /segments/{id}","href":"/api-reference/segments/delete-a-segment"},{"title":"List a segment's contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /segments/{id}/contacts","href":"/api-reference/segments/list-a-segments-contacts"},{"title":"Add contacts to a segment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /segments/{id}/contacts","href":"/api-reference/segments/add-contacts-to-a-segment"},{"title":"Remove contacts from a segment","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /segments/{id}/contacts","href":"/api-reference/segments/remove-contacts-from-a-segment"}]},{"group":"Conversations","pages":[{"title":"List conversations","description":"Lists conversations, newest first, with cursor pagination. Each row\nembeds its contact and that contact's tags.\n\nEvery channel is returned unless you filter, so an integration written\nbefore Instagram and the website widget existed keeps seeing everything\nit saw before, plus threads it may not recognise. Each row carries\n`channel`.\n\nRequires the `conversations:read` scope.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /conversations/{id}","href":"/api-reference/conversations/get-a-conversation"},{"title":"List a conversation's messages","description":"Lists the messages in one conversation, newest first, with cursor\npagination. The conversation is checked against your workspace first —\nanother workspace's conversation answers `404`, never an empty list.\n\nRequires the `messages:read` scope.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /conversations/{id}/messages","href":"/api-reference/conversations/list-a-conversations-messages"}]},{"group":"Broadcasts","pages":[{"title":"Launch a broadcast","deprecated":null,"version":null,"openapi":"/openapi.yaml post /broadcasts","href":"/api-reference/broadcasts/launch-a-broadcast"},{"title":"Get a broadcast","deprecated":null,"version":null,"openapi":"/openapi.yaml get /broadcasts/{id}","href":"/api-reference/broadcasts/get-a-broadcast"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhooks","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Register a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml post /webhooks","href":"/api-reference/webhooks/register-a-webhook-endpoint"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhooks/{id}","href":"/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /webhooks/{id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /webhooks/{id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"}]}]}]},"title":"Get a conversation - Watx","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}