Return all WhatsApp instances that belong to the authenticated Wachat account, including display name, API instance name, connection status, number, and profile data when available.
Return all WhatsApp instances that belong to the authenticated Wachat account.Use this endpoint when your external application needs to show available instances, connection status, profile data, and the apiInstanceName required for future API calls.
Authenticate your integration payloads by injecting your premium secure Wachat Account API Private Secret Key inside standard Authorization Bearer header vectors.
{"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":""},"chroma":{"liveDeploymentHistoryId":"6ab8da941f8fe965b40df0a2","collectionId":"f5f11b61-af22-4cc3-9a9b-e3b3e0e4b8b7","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ab8da941f8fe965b40df0a2"},"entitlements":{},"buildId":"6ab8da941f8fe965b40df0a2","clientVersion":"0.0.4044","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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/instance-list","slug":"/api-reference/instance-list","pageMetadata":{"title":"List Instances","openapi":"GET /instance/list","description":"Return all WhatsApp instances that belong to the authenticated Wachat account, including display name, API instance name, connection status, number, and profile data when available.","href":"/api-reference/instance-list"},"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: \"Return all WhatsApp instances that belong to the authenticated Wachat account, including display name, API instance name, connection status, number, and profile data 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:`Return all WhatsApp instances that belong to the authenticated Wachat account.`}),`\n`,_jsxs(_components.p,{children:[`Use this endpoint when your external application needs to show available instances, connection status, profile data, and the `,_jsx(_components.code,{children:`apiInstanceName`}),` required for future API calls.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`24`,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:`24`,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:` \"count\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_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:` \"instances\"`}),_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:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`29`}),_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:` \"displayName\"`}),_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_mq9r2jov_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_mq9r2jov_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:` \"status\"`}),_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:` \"isConnected\"`}),_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:` \"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:` \"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:` \"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\"`}),_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:` \"createdAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-06-13T08:00:00.000Z\"`}),_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:` \"updatedAt\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-06-13T08:00:00.000Z\"`})]}),`\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`,_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:[_jsx(_components.code,{children:`instanceName`}),` is the display name shown in Wachat. Use `,_jsx(_components.code,{children:`apiInstanceName`}),` for API calls such as state, logout, delete, send message, and profile picture.`]})})]})}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":"List Instances","openapi":"GET /instance/list","description":"Return all WhatsApp instances that belong to the authenticated Wachat account, including display name, API instance name, connection status, number, and profile data when available.","href":"/api-reference/instance-list"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"List WhatsApp Instances","description":"Return all WhatsApp instances that belong to the authenticated Wachat account, including display name, API instance name, connection status, number, and profile data when available.","tags":["Session Lifecycle Infrastructure"],"responses":{"200":"530ae9d7-8700-4bfe-a9c5-8009b0521dbb","401":"f987b617-5088-4640-91b2-e8494a374ef7","403":"fc05b87c-5e6d-4eb1-bdac-8dc20344523b","500":"2b05278f-928a-4b61-9f0f-4ec31bb5989a"},"method":"get","type":"path","servers":["536c3b0c-abef-4d8d-8483-52ee9fa5eda9"],"security":["8dd0d32d-495e-4c03-bbd7-8622d71ed8f9"],"path":"/instance/list","baseUrlOptions":["https://crm.wachat.net/api/v1"],"title":"List WhatsApp Instances","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"530ae9d7-8700-4bfe-a9c5-8009b0521dbb":{"description":"Instance list returned successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"uniqueKey":"success","typeLabel":"boolean"},"count":{"type":"integer","example":1,"uniqueKey":"count","typeLabel":"integer"},"instances":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":29,"uniqueKey":"instances.items.[INDEX].id","typeLabel":"integer"},"instanceName":{"type":"string","description":"Display name shown in Wachat.","example":"jakarta_store","uniqueKey":"instances.items.[INDEX].instanceName","typeLabel":"string"},"displayName":{"type":"string","description":"Display name shown in Wachat.","example":"jakarta_store","uniqueKey":"instances.items.[INDEX].displayName","typeLabel":"string"},"apiInstanceName":{"type":"string","description":"Unique API instance name to use in future API calls.","example":"t1_mq9r2jov_jakarta_store","uniqueKey":"instances.items.[INDEX].apiInstanceName","typeLabel":"string"},"internalName":{"type":"string","description":"Internal API instance name. Same value as apiInstanceName.","example":"t1_mq9r2jov_jakarta_store","uniqueKey":"instances.items.[INDEX].internalName","typeLabel":"string"},"state":{"type":"string","example":"open","uniqueKey":"instances.items.[INDEX].state","typeLabel":"string"},"status":{"type":"string","example":"open","uniqueKey":"instances.items.[INDEX].status","typeLabel":"string"},"isConnected":{"type":"boolean","example":true,"uniqueKey":"instances.items.[INDEX].isConnected","typeLabel":"boolean"},"number":{"oneOf":[{"type":"string","example":"628123456789","uniqueKey":"instances.items.[INDEX].number.oneOf.0","typeLabel":"string"},{"type":"null","example":"628123456789","uniqueKey":"instances.items.[INDEX].number.oneOf.1","typeLabel":"null"}],"uniqueKey":"instances.items.[INDEX].number","typeLabel":"string | null"},"profileName":{"oneOf":[{"type":"string","example":"jakarta_store","uniqueKey":"instances.items.[INDEX].profileName.oneOf.0","typeLabel":"string"},{"type":"null","example":"jakarta_store","uniqueKey":"instances.items.[INDEX].profileName.oneOf.1","typeLabel":"null"}],"uniqueKey":"instances.items.[INDEX].profileName","typeLabel":"string | null"},"profilePictureUrl":{"oneOf":[{"type":"string","example":"https://pps.whatsapp.net/v/t61.24694-24/example.jpg","uniqueKey":"instances.items.[INDEX].profilePictureUrl.oneOf.0","typeLabel":"string"},{"type":"null","example":"https://pps.whatsapp.net/v/t61.24694-24/example.jpg","uniqueKey":"instances.items.[INDEX].profilePictureUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"instances.items.[INDEX].profilePictureUrl","typeLabel":"string | null"},"profilePicUrl":{"oneOf":[{"type":"string","description":"Alias of profilePictureUrl.","example":"https://pps.whatsapp.net/v/t61.24694-24/example.jpg","uniqueKey":"instances.items.[INDEX].profilePicUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"Alias of profilePictureUrl.","example":"https://pps.whatsapp.net/v/t61.24694-24/example.jpg","uniqueKey":"instances.items.[INDEX].profilePicUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"instances.items.[INDEX].profilePicUrl","typeLabel":"string | null"},"owner":{"oneOf":[{"type":"string","example":"628123456789@s.whatsapp.net","uniqueKey":"instances.items.[INDEX].owner.oneOf.0","typeLabel":"string"},{"type":"null","example":"628123456789@s.whatsapp.net","uniqueKey":"instances.items.[INDEX].owner.oneOf.1","typeLabel":"null"}],"uniqueKey":"instances.items.[INDEX].owner","typeLabel":"string | null"},"integration":{"type":"string","example":"WHATSAPP-BAILEYS","uniqueKey":"instances.items.[INDEX].integration","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","example":"2026-06-13T08:00:00.000Z","uniqueKey":"instances.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","example":"2026-06-13T08:00:00.000Z","uniqueKey":"instances.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"instances.items.[INDEX]","typeLabel":"object"},"uniqueKey":"instances","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"count":1,"instances":[{"id":29,"instanceName":"jakarta_store","displayName":"jakarta_store","apiInstanceName":"t1_mq9r2jov_jakarta_store","internalName":"t1_mq9r2jov_jakarta_store","state":"open","status":"open","isConnected":true,"number":"628123456789","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","owner":"628123456789@s.whatsapp.net","integration":"WHATSAPP-BAILEYS","createdAt":"2026-06-13T08:00:00.000Z","updatedAt":"2026-06-13T08:00:00.000Z"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"f987b617-5088-4640-91b2-e8494a374ef7":{"description":"Missing or invalid API key.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"fc05b87c-5e6d-4eb1-bdac-8dc20344523b":{"description":"Subscription restriction prevented instance list lookup.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"2b05278f-928a-4b61-9f0f-4ec31bb5989a":{"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":"List Instances - Wachat","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-13T09:55:04.238Z","originalFileLocation":"api-reference/instance-list.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=\"Return all WhatsApp instances that belong to the authenticated Wachat account, including display name, API instance name, connection status, number, and profile data 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=\"List Instances - Wachat\">\u003cmeta data-mint-head property=\"og:description\" content=\"Return all WhatsApp instances that belong to the authenticated Wachat account, including display name, API instance name, connection status, number, and profile data 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-list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://wachat-336ab83a.mintlify.app/_mintlify/api/og/v2?division=Instances\u0026amp;title=List+Instances\u0026amp;description=Return+all+WhatsApp+instances+that+belong+to+the+authenticated+Wachat+account%2C+including+display+name%2C+API+instance+name%2C+connection+status%2C+number%2C+and+profile\u0026amp;theme=9a5eb6a4feb8b1d774cd7cd1\u0026amp;signature=6ff485c165b09dbe3f1169b9832442f5e608fcf9842285421a48a6f356202520\">\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 Instances - Wachat\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Return all WhatsApp instances that belong to the authenticated Wachat account, including display name, API instance name, connection status, number, and profile data when available.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://wachat-336ab83a.mintlify.app/_mintlify/api/og/v2?division=Instances\u0026amp;title=List+Instances\u0026amp;description=Return+all+WhatsApp+instances+that+belong+to+the+authenticated+Wachat+account%2C+including+display+name%2C+API+instance+name%2C+connection+status%2C+number%2C+and+profile\u0026amp;theme=9a5eb6a4feb8b1d774cd7cd1\u0026amp;signature=6ff485c165b09dbe3f1169b9832442f5e608fcf9842285421a48a6f356202520\">\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-list\">\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-list.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-list#webpage\",\"url\":\"https://docs.wachat.net/api-reference/instance-list\",\"name\":\"List Instances\",\"description\":\"Return all WhatsApp instances that belong to the authenticated Wachat account, including display name, API instance name, connection status, number, and profile data when available.\",\"dateModified\":\"2026-06-13T09:55:04.238Z\",\"isPartOf\":{\"@id\":\"https://docs.wachat.net#website\"},\"breadcrumb\":{\"@id\":\"https://docs.wachat.net/api-reference/instance-list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.wachat.net/api-reference/instance-list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Instances\",\"item\":\"https://docs.wachat.net/api-reference/instance-create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List Instances\",\"item\":\"https://docs.wachat.net/api-reference/instance-list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.wachat.net/api-reference/instance-list#apireference\",\"headline\":\"List Instances\",\"name\":\"List Instances\",\"description\":\"Return all WhatsApp instances that belong to the authenticated Wachat account, including display name, API instance name, connection status, number, and profile data when available.\",\"url\":\"https://docs.wachat.net/api-reference/instance-list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.wachat.net/api-reference/instance-list#webpage\"},\"dateModified\":\"2026-06-13T09:55:04.238Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","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","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","description":"Gracefully execute remote instance logout workflows to sever session sockets, clear local instance configurations, and detach mobile nodes securely from your instance framework.","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":"List Instances - Wachat","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}