Check whether a WhatsApp instance is connected. Send the unique API instance name in the query parameter. When the instance is connected, the normalized response includes the display name, API instance name, detected WhatsApp number, and profile information when available.
Check whether a WhatsApp instance is connected.When the instance is already connected, the response also includes the detected WhatsApp number and profile fields when they are available.Use the unique API instance name in the instanceName query parameter. In the normalized response, instance.instanceName is the display name shown in Wachat, while instance.apiInstanceName is the unique name you should keep using for API calls.
If WhatsApp returns the internal API instance name as the profile name, Wachat normalizes it back to the display name so your UI can show a clean name such as jakarta_store.
profilePictureUrl may be null if WhatsApp does not return a public profile photo for the connected account. For browser image rendering, use the Profile Picture endpoint instead of loading the WhatsApp URL directly.
Authenticate your integration payloads by injecting your premium secure Wachat Account API Private Secret Key inside standard Authorization Bearer header vectors.
Normalized instance state and profile data for UI and API usage.
Show child attributes
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Wachat","colors":{"primary":"#25D366","light":"#4ade80","dark":"#16a34a"},"favicon":"https://mintcdn.com/wachat-336ab83a/9nBhxtXyAAg2y0Gz/logo/favicon.png?fit=max\u0026auto=format\u0026n=9nBhxtXyAAg2y0Gz\u0026q=85\u0026s=afe15ff563e4f1b3b27f860d807640c6","logo":{"light":"https://mintcdn.com/wachat-336ab83a/mcumifWE4a7E0QYj/logo/light.png?fit=max\u0026auto=format\u0026n=mcumifWE4a7E0QYj\u0026q=85\u0026s=a0951689af3dcc8aeec39e45d675ef58","dark":"https://mintcdn.com/wachat-336ab83a/mcumifWE4a7E0QYj/logo/light.png?fit=max\u0026auto=format\u0026n=mcumifWE4a7E0QYj\u0026q=85\u0026s=a0951689af3dcc8aeec39e45d675ef58"},"api":{"openapi":"https://crm.wachat.net/docs/api.json","playground":{"display":"interactive"},"mdx":{"server":"https://crm.wachat.net/api/v1","auth":{"method":"bearer","name":null}}},"navbar":{"links":[{"label":"Pricing","href":"https://www.wachat.net/pricing"},{"label":"Support","href":"mailto:support@wachat.net"}],"primary":{"type":"button","label":"Dashboard","href":"https://crm.wachat.net"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"wachat-336ab83a","hasAudioNarration":false,"actualSubdomain":"wachat-336ab83a","customDomains":["docs.wachat.net"],"gitSource":{"type":"github","owner":"whmcs90","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ab8da941f8fe965b40df0a2","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"Messages","count":9},{"language":"default","tag":"Instances","count":7},{"language":"default","tag":"Webhooks","count":3},{"language":"default","tag":"Guides","count":3},{"language":"default","tag":"Start here","count":2},{"language":"default","tag":"Account","count":1},{"language":"default","tag":"Numbers","count":1},{"language":"default","tag":"Contacts","count":1},{"language":"default","tag":"Groups","count":1},{"language":"default","tag":"API Reference","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/instance-state","slug":"/api-reference/instance-state","pageMetadata":{"title":"Get Instance State","openapi":"GET /instance/state","description":"Check whether a WhatsApp instance is connected. Send the unique API instance name in the query parameter. When the instance is connected, the normalized response includes the display name, API instance name, detected WhatsApp number, and profile information when available.","href":"/api-reference/instance-state"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Check whether a WhatsApp instance is connected. Send the unique API instance name in the query parameter. When the instance is connected, the normalized response includes the display name, API instance name, detected WhatsApp number, and profile information when available.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Note}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Check whether a WhatsApp instance is connected.`}),`\n`,_jsx(_components.p,{children:`When the instance is already connected, the response also includes the detected WhatsApp number and profile fields when they are available.`}),`\n`,_jsxs(_components.p,{children:[`Use the unique API instance name in the `,_jsx(_components.code,{children:`instanceName`}),` query parameter. In the normalized response, `,_jsx(_components.code,{children:`instance.instanceName`}),` is the display name shown in Wachat, while `,_jsx(_components.code,{children:`instance.apiInstanceName`}),` is the unique name you should keep using for API calls.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`21`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`21`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"instance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"instanceName\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"jakarta_store\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"state\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"open\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"instance\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"instanceName\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"jakarta_store\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"apiInstanceName\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"t1_mqc3zame_jakarta_store\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"internalName\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"t1_mqc3zame_jakarta_store\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"state\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"open\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"profileName\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"jakarta_store\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"profilePictureUrl\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://pps.whatsapp.net/...\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"profilePicUrl\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://pps.whatsapp.net/...\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"number\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"628123456789\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"owner\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"628123456789@s.whatsapp.net\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"integration\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"WHATSAPP-BAILEYS\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`If WhatsApp returns the internal API instance name as the profile name, Wachat normalizes it back to the display name so your UI can show a clean name such as `,_jsx(_components.code,{children:`jakarta_store`}),`.`]})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`profilePictureUrl`}),` may be `,_jsx(_components.code,{children:`null`}),` if WhatsApp does not return a public profile photo for the connected account. For browser image rendering, use the Profile Picture endpoint instead of loading the WhatsApp URL directly.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Instance State","openapi":"GET /instance/state","description":"Check whether a WhatsApp instance is connected. Send the unique API instance name in the query parameter. When the instance is connected, the normalized response includes the display name, API instance name, detected WhatsApp number, and profile information when available.","href":"/api-reference/instance-state"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get Instance State","description":"Check whether a WhatsApp instance is connected. Send the unique API instance name in the query parameter. When the instance is connected, the normalized response includes the display name, API instance name, detected WhatsApp number, and profile information when available.","tags":["Session Lifecycle Infrastructure"],"parameters":["cef504ff-2a9e-4463-ba0f-35236615a1fb"],"responses":{"200":"85504359-a2e5-4154-856c-89aa87abac0d","400":"82fa9e2f-6e4a-4874-9f76-f31bdf4f42ff","401":"4e0780be-2294-4195-82b6-77e818362c14","403":"28807856-3bb4-4d1e-aac6-d1bda5854fae","404":"49e5c772-35fd-47b5-8799-16f8dae4a00b","500":"aec25b3b-ada8-4081-84c0-0128486d88ad"},"method":"get","type":"path","servers":["536c3b0c-abef-4d8d-8483-52ee9fa5eda9"],"security":["8dd0d32d-495e-4c03-bbd7-8622d71ed8f9"],"path":"/instance/state","baseUrlOptions":["https://crm.wachat.net/api/v1"],"title":"Get Instance State","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"cef504ff-2a9e-4463-ba0f-35236615a1fb":{"in":"query","name":"instanceName","required":true,"schema":{"type":"string","isRequired":true,"description":"Unique API instance name returned by Wachat. Use apiInstanceName from the create or state response.","uniqueKey":"","typeLabel":"string"},"description":"Unique API instance name returned by Wachat. Use apiInstanceName from the create or state response.","example":"t1_mq9r2jov_jakarta_store"}},"responses":{"85504359-a2e5-4154-856c-89aa87abac0d":{"description":"Instance state returned successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"uniqueKey":"success","typeLabel":"boolean"},"data":{"type":"object","description":"Raw state payload returned by Wachat. This may contain the internal API instance name.","properties":{"instance":{"type":"object","properties":{"instanceName":{"type":"string","example":"t1_mq9r2jov_jakarta_store","uniqueKey":"data.instance.instanceName","typeLabel":"string"},"state":{"type":"string","example":"open","uniqueKey":"data.instance.state","typeLabel":"string"}},"uniqueKey":"data.instance","typeLabel":"object"}},"uniqueKey":"data","typeLabel":"object"},"instance":{"type":"object","description":"Normalized instance state and profile data for UI and API usage.","properties":{"instanceName":{"type":"string","description":"Display name shown in Wachat. This is safe to show in your UI.","example":"jakarta_store","uniqueKey":"instance.instanceName","typeLabel":"string"},"apiInstanceName":{"type":"string","description":"Unique API instance name to use in future API calls.","example":"t1_mq9r2jov_jakarta_store","uniqueKey":"instance.apiInstanceName","typeLabel":"string"},"internalName":{"type":"string","description":"Internal API instance name.","example":"t1_mq9r2jov_jakarta_store","uniqueKey":"instance.internalName","typeLabel":"string"},"state":{"type":"string","example":"open","uniqueKey":"instance.state","typeLabel":"string"},"profileName":{"oneOf":[{"type":"string","description":"Connected WhatsApp profile name. If WhatsApp returns the internal API name, Wachat normalizes this to the display name.","example":"jakarta_store","uniqueKey":"instance.profileName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Connected WhatsApp profile name. If WhatsApp returns the internal API name, Wachat normalizes this to the display name.","example":"jakarta_store","uniqueKey":"instance.profileName.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance.profileName","typeLabel":"string | null"},"profilePictureUrl":{"oneOf":[{"type":"string","description":"WhatsApp profile picture URL when returned by WhatsApp.","example":"https://pps.whatsapp.net/v/t61.24694-24/example.jpg","uniqueKey":"instance.profilePictureUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"WhatsApp profile picture URL when returned by WhatsApp.","example":"https://pps.whatsapp.net/v/t61.24694-24/example.jpg","uniqueKey":"instance.profilePictureUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance.profilePictureUrl","typeLabel":"string | null"},"profilePicUrl":{"oneOf":[{"type":"string","description":"Alias of profilePictureUrl.","example":"https://pps.whatsapp.net/v/t61.24694-24/example.jpg","uniqueKey":"instance.profilePicUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"Alias of profilePictureUrl.","example":"https://pps.whatsapp.net/v/t61.24694-24/example.jpg","uniqueKey":"instance.profilePicUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance.profilePicUrl","typeLabel":"string | null"},"number":{"oneOf":[{"type":"string","example":"628123456789","uniqueKey":"instance.number.oneOf.0","typeLabel":"string"},{"type":"null","example":"628123456789","uniqueKey":"instance.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance.number","typeLabel":"string | null"},"owner":{"oneOf":[{"type":"string","example":"628123456789@s.whatsapp.net","uniqueKey":"instance.owner.oneOf.0","typeLabel":"string"},{"type":"null","example":"628123456789@s.whatsapp.net","uniqueKey":"instance.owner.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance.owner","typeLabel":"string | null"},"integration":{"oneOf":[{"type":"string","example":"WHATSAPP-BAILEYS","uniqueKey":"instance.integration.oneOf.0","typeLabel":"string"},{"type":"null","example":"WHATSAPP-BAILEYS","uniqueKey":"instance.integration.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance.integration","typeLabel":"string | null"}},"uniqueKey":"instance","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"instance":{"instanceName":"t1_mq9r2jov_jakarta_store","state":"open"}},"instance":{"instanceName":"jakarta_store","apiInstanceName":"t1_mq9r2jov_jakarta_store","internalName":"t1_mq9r2jov_jakarta_store","state":"open","profileName":"jakarta_store","profilePictureUrl":"https://pps.whatsapp.net/v/t61.24694-24/example.jpg","profilePicUrl":"https://pps.whatsapp.net/v/t61.24694-24/example.jpg","number":"628123456789","owner":"628123456789@s.whatsapp.net","integration":"WHATSAPP-BAILEYS"}}}},"exampleType":"generated"}},"exampleType":"generated"},"82fa9e2f-6e4a-4874-9f76-f31bdf4f42ff":{"description":"Missing instanceName query parameter.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"4e0780be-2294-4195-82b6-77e818362c14":{"description":"Missing or invalid API key.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"28807856-3bb4-4d1e-aac6-d1bda5854fae":{"description":"Subscription restriction prevented state lookup.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"49e5c772-35fd-47b5-8799-16f8dae4a00b":{"description":"Instance not found for this API key.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"aec25b3b-ada8-4081-84c0-0128486d88ad":{"description":"Internal server error.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"8dd0d32d-495e-4c03-bbd7-8622d71ed8f9":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Authenticate your integration payloads by injecting your premium secure Wachat Account API Private Secret Key inside standard Authorization Bearer header vectors.","scopes":[]}}},"servers":{"536c3b0c-abef-4d8d-8483-52ee9fa5eda9":{"url":"https://crm.wachat.net/api/v1","description":"Live Production Gateway"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Authenticate your integration payloads by injecting your premium secure Wachat Account API Private Secret Key inside standard Authorization Bearer header vectors.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Authenticate your integration payloads by injecting your premium secure Wachat Account API Private Secret Key inside standard Authorization Bearer header vectors.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"wachat-336ab83a","siteName":"Wachat","title":"Get Instance State - Wachat","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-13T09:15:09.575Z","originalFileLocation":"api-reference/instance-state.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=\"Check whether a WhatsApp instance is connected. Send the unique API instance name in the query parameter. When the instance is connected, the normalized response includes the display name, API instance name, detected WhatsApp number, and profile information when available.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Wachat\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Instance State - Wachat\">\u003cmeta data-mint-head property=\"og:description\" content=\"Check whether a WhatsApp instance is connected. Send the unique API instance name in the query parameter. When the instance is connected, the normalized response includes the display name, API instance name, detected WhatsApp number, and profile information when available.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Wachat\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.wachat.net/api-reference/instance-state\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://wachat-336ab83a.mintlify.site/_mintlify/api/og/v2?division=Instances\u0026amp;title=Get+Instance+State\u0026amp;description=Check+whether+a+WhatsApp+instance+is+connected.+Send+the+unique+API+instance+name+in+the+query+parameter.+When+the+instance+is+connected%2C+the+normalized+respons\u0026amp;theme=67933629576128fde9291cfd\u0026amp;signature=89669e7a32add72c5950ba4622d621977927f39c71ef1957753373ade5c1cf0f\">\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 Instance State - Wachat\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Check whether a WhatsApp instance is connected. Send the unique API instance name in the query parameter. When the instance is connected, the normalized response includes the display name, API instance name, detected WhatsApp number, and profile information when available.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://wachat-336ab83a.mintlify.site/_mintlify/api/og/v2?division=Instances\u0026amp;title=Get+Instance+State\u0026amp;description=Check+whether+a+WhatsApp+instance+is+connected.+Send+the+unique+API+instance+name+in+the+query+parameter.+When+the+instance+is+connected%2C+the+normalized+respons\u0026amp;theme=67933629576128fde9291cfd\u0026amp;signature=89669e7a32add72c5950ba4622d621977927f39c71ef1957753373ade5c1cf0f\">\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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Wachat\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#25D366\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.wachat.net/api-reference/instance-state\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/instance-state.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.wachat.net/#organization\",\"name\":\"Wachat\",\"url\":\"https://docs.wachat.net\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/wachat-336ab83a/mcumifWE4a7E0QYj/logo/light.png?fit=max\u0026auto=format\u0026n=mcumifWE4a7E0QYj\u0026q=85\u0026s=a0951689af3dcc8aeec39e45d675ef58\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.wachat.net#website\",\"name\":\"Wachat\",\"url\":\"https://docs.wachat.net\",\"publisher\":{\"@id\":\"https://docs.wachat.net/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.wachat.net/api-reference/instance-state#webpage\",\"url\":\"https://docs.wachat.net/api-reference/instance-state\",\"name\":\"Get Instance State\",\"description\":\"Check whether a WhatsApp instance is connected. Send the unique API instance name in the query parameter. When the instance is connected, the normalized response includes the display name, API instance name, detected WhatsApp number, and profile information when available.\",\"dateModified\":\"2026-06-13T09:15:09.575Z\",\"isPartOf\":{\"@id\":\"https://docs.wachat.net#website\"},\"breadcrumb\":{\"@id\":\"https://docs.wachat.net/api-reference/instance-state#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.wachat.net/api-reference/instance-state#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Instances\",\"item\":\"https://docs.wachat.net/api-reference/instance-create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Instance State\",\"item\":\"https://docs.wachat.net/api-reference/instance-state\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.wachat.net/api-reference/instance-state#apireference\",\"headline\":\"Get Instance State\",\"name\":\"Get Instance State\",\"description\":\"Check whether a WhatsApp instance is connected. Send the unique API instance name in the query parameter. When the instance is connected, the normalized response includes the display name, API instance name, detected WhatsApp number, and profile information when available.\",\"url\":\"https://docs.wachat.net/api-reference/instance-state\",\"mainEntityOfPage\":{\"@id\":\"https://docs.wachat.net/api-reference/instance-state#webpage\"},\"dateModified\":\"2026-06-13T09:15:09.575Z\",\"publisher\":{\"@id\":\"https://docs.wachat.net/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.wachat.net#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Wachat\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Wachat\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/instance-state.md","siteName":"Wachat","nav":{"global":null,"groups":[{"group":"Start here","pages":[{"title":"Build on Wachat","mode":"wide","href":"/index"},{"title":"Introduction","href":"/introduction"}]},{"group":"Guides","pages":[{"title":"Authentication","href":"/guides/authentication"},{"title":"Quickstart","href":"/guides/quickstart"},{"title":"Webhooks","href":"/guides/webhooks"}]},{"group":"API Reference","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Account","pages":[{"title":"Get Account Limits","openapi":"GET /account/limits","href":"/api-reference/account-limits"}]},{"group":"Messages","pages":[{"title":"Send Text Message","openapi":"POST /send/text","href":"/api-reference/send-text"},{"title":"Send Media Message","openapi":"POST /send/media","href":"/api-reference/send-media"},{"title":"Send Reply Buttons","openapi":"openapi.yaml POST /send/button","href":"/api-reference/send-button"},{"title":"Send Carousel","openapi":"POST /send/carousel","href":"/api-reference/send-carousel"},{"title":"Send CTA Buttons","openapi":"POST /send/cta","href":"/api-reference/send-cta"},{"title":"Send List Menu","openapi":"POST /send/list","href":"/api-reference/send-list"},{"title":"Send Group Message","openapi":"POST /send-group","href":"/api-reference/send-group"},{"title":"Send Location","openapi":"POST /send-location","href":"/api-reference/send-location"},{"title":"Send Poll","openapi":"POST /send-poll","href":"/api-reference/send-poll"}]},{"group":"Instances","pages":[{"title":"Create Instance","openapi":"POST /instance/create","href":"/api-reference/instance-create"},{"title":"Get QR Image","openapi":"GET /instance/qr/image","description":"Return the QR code directly as an image/png response. This is useful for browser previews, documentation pages, and img tags. You can authenticate using the Authorization bearer header or the apiKey query parameter.","href":"/api-reference/instance-qr-image"},{"title":"Get Instance State","openapi":"GET /instance/state","href":"/api-reference/instance-state"},{"title":"Get Profile Picture","openapi":"GET /instance/profile-picture","description":"Return the connected WhatsApp profile picture directly as an image. You can authenticate using the Authorization bearer header or the apiKey query parameter for browser image rendering.","href":"/api-reference/instance-profile-picture"},{"title":"List Instances","openapi":"GET /instance/list","href":"/api-reference/instance-list"},{"title":"Logout Instance","openapi":"DELETE /instance/logout","href":"/api-reference/instance-logout"},{"title":"Delete Instance","openapi":"DELETE /instance/delete","href":"/api-reference/instance-delete"}]},{"group":"Groups","pages":[{"title":"Get All Groups","openapi":"GET /groups","href":"/api-reference/groups"}]},{"group":"Contacts","pages":[{"title":"List Contacts","openapi":"GET /contacts","href":"/api-reference/contacts"}]},{"group":"Numbers","pages":[{"title":"Check Number","openapi":"GET /check-number","href":"/api-reference/check-number"}]},{"group":"Webhooks","pages":[{"title":"List Webhooks","openapi":"GET /webhooks","href":"/api-reference/webhooks"},{"title":"Create Webhook","openapi":"POST /webhooks","href":"/api-reference/webhooks-create"},{"title":"Delete Webhook","openapi":"DELETE /webhooks","href":"/api-reference/webhooks-delete"}]}]},"basePath":"","title":"Get Instance State - Wachat","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}