{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Hypersender","description":"Send WhatsApp and SMS messages from your own numbers with the Hypersender API. Guides, REST API reference, webhook events, and Laravel SDK docs.","colors":{"primary":"#10b981","light":"#059669","dark":"#10b981"},"logo":{"light":"https://mintcdn.com/hypersender/RX4Bj-Mb6ti70ZQe/logo/light.svg?fit=max\u0026auto=format\u0026n=RX4Bj-Mb6ti70ZQe\u0026q=85\u0026s=e38aff8c21e09ed683da236a8ffe8e13","dark":"https://mintcdn.com/hypersender/RX4Bj-Mb6ti70ZQe/logo/dark.svg?fit=max\u0026auto=format\u0026n=RX4Bj-Mb6ti70ZQe\u0026q=85\u0026s=31d31abc2839f94267a1548817b83538","href":"https://docs.hypersender.com"},"favicon":"https://mintcdn.com/hypersender/dAZ_QYs7yJAVpPpO/favicon.svg?fit=max\u0026auto=format\u0026n=dAZ_QYs7yJAVpPpO\u0026q=85\u0026s=74d0e86aaf7cdfe05cbdf2c13a044dec","background":{"image":{"light":"https://mintcdn.com/hypersender/QHanPLHbv0ntvGTU/images/background.png?fit=max\u0026auto=format\u0026n=QHanPLHbv0ntvGTU\u0026q=85\u0026s=bfcb110c086b77caa501a84cab4586a4","dark":"https://mintcdn.com/hypersender/QHanPLHbv0ntvGTU/images/background-dark.png?fit=max\u0026auto=format\u0026n=QHanPLHbv0ntvGTU\u0026q=85\u0026s=3137c58a2031e6febc74d0c1ec3632ac"}},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.hypersender.com"}},"footer":{"socials":{"x":"https://x.com/hypersender","github":"https://github.com/hypersender","linkedin":"https://linkedin.com/company/hypersender"}},"search":{"prompt":"Search WhatsApp \u0026 SMS API docs"},"seo":{"metatags":{"canonical":"https://docs.hypersender.com","og:site_name":"Hypersender Docs","og:locale":"en_US","twitter:card":"summary_large_image","twitter:site":"@hypersender","robots":"index, follow","googlebot":"index, follow","author":"Hypersender","theme-color":"#10b981"},"organization":{"id":"https://hypersender.com/#organization","name":"Hypersender","url":"https://hypersender.com","sameAs":["https://x.com/hypersender","https://github.com/hypersender","https://linkedin.com/company/hypersender"]},"indexing":"navigable"},"styling":{"eyebrows":"breadcrumbs","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"metadata":{"timestamp":true},"navigation":{"global":{"anchors":[{"anchor":"WhatsApp Support","icon":"whatsapp","href":"https://wa.me/201065684630"},{"anchor":"Discord Support","icon":"discord","href":"https://discord.gg/ysSmK32ykC"},{"anchor":"Blog","icon":"newspaper","href":"https://hypersender.com/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hypersender","hasAudioNarration":false,"actualSubdomain":"hypersender","customDomains":["docs.hypersender.com"],"gitSource":{"type":"github","owner":"hypersender","repo":"docs-v2","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aef799cae7fce64eaea8c9e","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"Whatsapp API","count":72},{"language":"default","tag":"SMS API","count":58},{"language":"default","tag":"WhatsApp API","count":47},{"language":"default","tag":"Send Messages","count":36},{"language":"default","tag":"Packages and SDKs","count":30},{"language":"default","tag":"Laravel","count":28},{"language":"default","tag":"SMS Webhooks","count":26},{"language":"default","tag":"Enterprise WhatsApp API","count":22},{"language":"default","tag":"Guides","count":21},{"language":"default","tag":"Overview","count":18}]},"assistantConfig":{},"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":[{"filePath":"style.css","content":".prose{--tw-prose-code: #10b981}.dark .prose{--tw-prose-code: #34d399}.prose :not(pre)>code,.mdx-prose :not(pre)>code,article :not(pre)>code{color:#10b981!important}.dark .prose :not(pre)>code,.dark .mdx-prose :not(pre)>code,.dark article :not(pre)>code{color:#34d399!important}"}],"page":{"pagePath":"v1/api-reference/enterprise/instance-management/list-instances","slug":"/v1/api-reference/enterprise/instance-management/list-instances","pageMetadata":{"title":"List Instances (v1)","sidebarTitle":"List Instances","description":"Retrieve all WhatsApp instances associated with your account with powerful filtering options. (v1 API)","canonical":"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/list-instances","openapi":"v1/api-reference/enterprise/enterprise-collection.json GET /instances","href":"/v1/api-reference/enterprise/instance-management/list-instances"},"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: \"Retrieve all WhatsApp instances associated with your account with powerful filtering options. (v1 API)\"\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`,li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Tip}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`List all WhatsApp instances associated with your authenticated account. Use filters to narrow down results by UUID, name, phone number, or status.`}),`\n`,_jsx(Heading,{level:`2`,id:`filtering-options`,children:`Filtering Options`}),`\n`,_jsx(_components.p,{children:`You can filter the list of instances using the following query parameters:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`filter[uuid]`}),` - Filter by instance UUID (exact match)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`filter[name]`}),` - Filter by instance name (partial match)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`filter[phone]`}),` - Filter by phone number (exact match)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`filter[status]`}),` - Filter by instance status`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`response-fields`,children:`Response Fields`}),`\n`,_jsx(_components.p,{children:`Each instance in the response includes:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`id`}),` - Instance UUID`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`name`}),` - Instance name`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`phone`}),` - Phone number in E.164 format`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`service_type`}),` - Service type (whatsapp)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`status`}),` - Current instance status`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`access_token`}),` - Access token for the instance (null if not yet connected)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`created_at`}),` - Creation timestamp`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`example-use-cases`,children:`Example Use Cases`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Display all instances in your application dashboard`}),`\n`,_jsx(_components.li,{children:`Filter instances by status to show only active ones`}),`\n`,_jsx(_components.li,{children:`Search for a specific instance by name or phone number`}),`\n`,_jsx(_components.li,{children:`Monitor all instances created at a specific time`}),`\n`]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Use the `,_jsx(_components.code,{children:`filter[status]`}),` parameter with value `,_jsx(_components.code,{children:`WORKING`}),` to get only active and ready instances.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`instance-status-values`,children:`Instance Status Values`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`STOPPED`}),`: Instance is stopped`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`STARTING`}),`: Instance is starting up`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`WORKING`}),`: Instance is running and ready`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`SCAN_QR_CODE`}),`: Waiting for QR code scan`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`FAILED`}),`: Instance failed to start`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`PENDING`}),`: Awaiting server assignment`]}),`\n`]})]})}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 (v1)","sidebarTitle":"List Instances","description":"Retrieve all WhatsApp instances associated with your account with powerful filtering options. (v1 API)","canonical":"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/list-instances","openapi":"v1/api-reference/enterprise/enterprise-collection.json GET /instances","href":"/v1/api-reference/enterprise/instance-management/list-instances"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Filtering Options","slug":"filtering-options","depth":2,"children":[]},{"title":"Response Fields","slug":"response-fields","depth":2,"children":[]},{"title":"Example Use Cases","slug":"example-use-cases","depth":2,"children":[]},{"title":"Instance Status Values","slug":"instance-status-values","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Instance Management"],"x-hidden":true,"summary":"List Instances","description":"Retrieve all WhatsApp instances associated with your account with powerful filtering options. (v1 API)","parameters":["19dc6171-2d79-4df8-9fff-b19d63bd6caa","56345b42-0f56-4997-83a4-572eb0dfdf7e","60f974a7-6a60-4e0b-a34b-0d6153665fba","c235dd87-19ff-439e-a581-2c9a638bc1d0","2aede658-6742-488a-ad39-dae6bfd97e5e"],"responses":{"200":"7a28e24f-b8a9-406b-81da-b0e247a4a5ac"},"security":["eaa7e5f5-a722-41ad-bab6-795ba4136558"],"method":"get","type":"path","servers":["a2ff01d7-6516-47fd-9c9a-73788f5c617b"],"path":"/instances","baseUrlOptions":["https://app.hypersender.com/api/whatsapp/v1"],"title":"List Instances","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"19dc6171-2d79-4df8-9fff-b19d63bd6caa":{"name":"Accept","in":"header","description":"application/json","schema":{"type":"string","example":"application/json","description":"application/json","uniqueKey":"","typeLabel":"string"}},"56345b42-0f56-4997-83a4-572eb0dfdf7e":{"name":"filter[uuid]","in":"query","description":"Filter by instance UUID","required":false,"schema":{"type":"string","isRequired":false,"description":"Filter by instance UUID","uniqueKey":"","typeLabel":"string"}},"60f974a7-6a60-4e0b-a34b-0d6153665fba":{"name":"filter[name]","in":"query","description":"Filter by instance name (partial match)","required":false,"schema":{"type":"string","isRequired":false,"description":"Filter by instance name (partial match)","uniqueKey":"","typeLabel":"string"}},"c235dd87-19ff-439e-a581-2c9a638bc1d0":{"name":"filter[phone]","in":"query","description":"Filter by phone number","required":false,"schema":{"type":"string","isRequired":false,"description":"Filter by phone number","uniqueKey":"","typeLabel":"string"}},"2aede658-6742-488a-ad39-dae6bfd97e5e":{"name":"filter[status]","in":"query","description":"Filter by instance status","required":false,"schema":{"type":"string","enum":["STOPPED","STARTING","WORKING","SCAN_QR_CODE","FAILED","PENDING"],"isRequired":false,"description":"Filter by instance status","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"responses":{"7a28e24f-b8a9-406b-81da-b0e247a4a5ac":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Instance UUID","example":"fa3d01c4-1234-4c0d-a12f-df319b612f8c","uniqueKey":"items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Instance name","example":"MyInstanceName","uniqueKey":"items.[INDEX].name","typeLabel":"string"},"phone":{"type":"string","description":"Phone number in E.164 format","example":"+201234567890","uniqueKey":"items.[INDEX].phone","typeLabel":"string"},"service_type":{"type":"string","description":"Service type","example":"whatsapp","uniqueKey":"items.[INDEX].service_type","typeLabel":"string"},"status":{"type":"string","enum":["STOPPED","STARTING","WORKING","SCAN_QR_CODE","FAILED","PENDING"],"description":"Instance status","example":"WORKING","uniqueKey":"items.[INDEX].status","typeLabel":"enum\u003cstring>"},"access_token":{"oneOf":[{"type":"string","description":"Access token for the instance","example":"234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1","uniqueKey":"items.[INDEX].access_token.oneOf.0","typeLabel":"string"},{"type":"null","description":"Access token for the instance","example":"234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1","uniqueKey":"items.[INDEX].access_token.oneOf.1","typeLabel":"null"}],"uniqueKey":"items.[INDEX].access_token","typeLabel":"string | null"},"created_at":{"type":"string","description":"Creation timestamp","example":"2025-05-26T10:12:45","uniqueKey":"items.[INDEX].created_at","typeLabel":"string"}},"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"example":[{"id":"fa3d01c4-1234-4c0d-a12f-df319b612f8c","name":"MyInstanceName","phone":"+201234567890","service_type":"whatsapp","status":"WORKING","access_token":"234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1","created_at":"2025-05-26T10:12:45"},{"id":"c9a1dd76-5678-4f9d-9012-a5b78de100c3","name":"SecondInstance","phone":"+201234567891","service_type":"whatsapp","status":"SCAN_QR_CODE","access_token":null,"created_at":"2025-05-25T15:30:22"}],"examples":{"Example":{"title":"Example","value":[{"id":"fa3d01c4-1234-4c0d-a12f-df319b612f8c","name":"MyInstanceName","phone":"+201234567890","service_type":"whatsapp","status":"WORKING","access_token":"234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1","created_at":"2025-05-26T10:12:45"},{"id":"c9a1dd76-5678-4f9d-9012-a5b78de100c3","name":"SecondInstance","phone":"+201234567891","service_type":"whatsapp","status":"SCAN_QR_CODE","access_token":null,"created_at":"2025-05-25T15:30:22"}]}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"eaa7e5f5-a722-41ad-bab6-795ba4136558":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer token authentication. Example: `Bearer 234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1`","scopes":[]}}},"servers":{"a2ff01d7-6516-47fd-9c9a-73788f5c617b":{"url":"https://app.hypersender.com/api/whatsapp/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer token authentication. Example: `Bearer 234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1`","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer token authentication. Example: `Bearer 234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1`","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Authorization","name":"Authorization"}],"title":"Authorization"}]},"originalFileLocation":"v1/api-reference/enterprise/enterprise-collection.json"},"subdomain":"hypersender","siteName":"Hypersender","title":"List Instances (v1) - Hypersender","navMaps":{"firstHrefInVersion":{"v2":{"href":"/v2/api-reference/enterprise/instance-management/list-instances","matchLevel":1},"v1":{"href":"/v1/api-reference/enterprise/instance-management/list-instances","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-16T14:58:29.121Z","gitLastModified":"2026-10-16T14:57:52.000Z","originalFileLocation":"v1/api-reference/enterprise/instance-management/list-instances.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=\"Retrieve all WhatsApp instances associated with your account with powerful filtering options. (v1 API)\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hypersender\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hypersender/YssXEy8fq447EilS/_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/hypersender/YssXEy8fq447EilS/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hypersender/YssXEy8fq447EilS/_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/hypersender/YssXEy8fq447EilS/_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/hypersender/YssXEy8fq447EilS/_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/hypersender/YssXEy8fq447EilS/_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/hypersender/YssXEy8fq447EilS/_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/hypersender/YssXEy8fq447EilS/_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/hypersender/YssXEy8fq447EilS/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Instances (v1) - Hypersender\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve all WhatsApp instances associated with your account with powerful filtering options. (v1 API)\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hypersender Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/list-instances\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hypersender.mintlify.site/_mintlify/api/og/v2?division=Enterprise+WhatsApp+API\u0026amp;title=List+Instances+%28v1%29\u0026amp;description=Retrieve+all+WhatsApp+instances+associated+with+your+account+with+powerful+filtering+options.+%28v1+API%29\u0026amp;theme=99e6b81012c241153533187b\u0026amp;signature=737b0a2086257def3225aa974d0044ee88d5366b243e6f68427f897c165a2de2\">\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 (v1) - Hypersender\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve all WhatsApp instances associated with your account with powerful filtering options. (v1 API)\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hypersender.mintlify.site/_mintlify/api/og/v2?division=Enterprise+WhatsApp+API\u0026amp;title=List+Instances+%28v1%29\u0026amp;description=Retrieve+all+WhatsApp+instances+associated+with+your+account+with+powerful+filtering+options.+%28v1+API%29\u0026amp;theme=99e6b81012c241153533187b\u0026amp;signature=737b0a2086257def3225aa974d0044ee88d5366b243e6f68427f897c165a2de2\">\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/hypersender/YssXEy8fq447EilS/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hypersender\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#10b981\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"googlebot\" content=\"index, follow\">\u003cmeta data-mint-head name=\"author\" content=\"Hypersender\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#10b981\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/list-instances\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v1/api-reference/enterprise/instance-management/list-instances.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://hypersender.com/#organization\",\"name\":\"Hypersender\",\"url\":\"https://hypersender.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hypersender/RX4Bj-Mb6ti70ZQe/logo/light.svg?fit=max\u0026auto=format\u0026n=RX4Bj-Mb6ti70ZQe\u0026q=85\u0026s=e38aff8c21e09ed683da236a8ffe8e13\"},\"sameAs\":[\"https://x.com/hypersender\",\"https://github.com/hypersender\",\"https://linkedin.com/company/hypersender\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hypersender.com#website\",\"name\":\"Hypersender\",\"url\":\"https://docs.hypersender.com\",\"publisher\":{\"@id\":\"https://hypersender.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/list-instances#webpage\",\"url\":\"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/list-instances\",\"name\":\"List Instances (v1)\",\"description\":\"Retrieve all WhatsApp instances associated with your account with powerful filtering options. (v1 API)\",\"dateModified\":\"2026-10-16T14:57:52.000Z\",\"isPartOf\":{\"@id\":\"https://docs.hypersender.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/list-instances#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/list-instances#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Enterprise WhatsApp API\",\"item\":\"https://docs.hypersender.com/v1/api-reference/enterprise/instance-management/create-instance\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List Instances (v1)\",\"item\":\"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/list-instances\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/list-instances#apireference\",\"headline\":\"List Instances (v1)\",\"name\":\"List Instances (v1)\",\"description\":\"Retrieve all WhatsApp instances associated with your account with powerful filtering options. (v1 API)\",\"url\":\"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/list-instances\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/list-instances#webpage\"},\"dateModified\":\"2026-10-16T14:57:52.000Z\",\"publisher\":{\"@id\":\"https://hypersender.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hypersender.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hypersender\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Hypersender\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/v1/api-reference/enterprise/instance-management/list-instances.md","siteName":"Hypersender","nav":{"global":{"anchors":[{"anchor":"WhatsApp Support","icon":"whatsapp","href":"https://wa.me/201065684630"},{"anchor":"Discord Support","icon":"discord","href":"https://discord.gg/ysSmK32ykC"},{"anchor":"Blog","icon":"newspaper","href":"https://hypersender.com/blog"}]},"versions":[{"version":"v2","pages":[{"title":"v2","href":"/v2/api-reference/enterprise/instance-management/list-instances"}]},{"version":"v1","tabs":[{"tab":"Guides","icon":"book","pages":[{"title":"Guides","href":"/v1/hypersender/hypersender-api-for-whatsapp-and-sms-messaging"}]},{"tab":"Whatsapp API","icon":"whatsapp","pages":[{"title":"Whatsapp API","href":"/v1/api-reference/whatsapp/whatsapp-api-introduction"}]},{"tab":"SMS API","icon":"message","pages":[{"title":"SMS API","href":"/v1/api-reference/sms/sms-api-introduction"}]},{"tab":"Enterprise WhatsApp API","icon":"fire","groups":[{"group":"Overview","boost":0.5,"pages":[{"title":"Enterprise WhatsApp API Introduction (v1)","sidebarTitle":"Introduction","href":"/v1/api-reference/enterprise/enterprise-whatsapp-api-introduction"}]},{"group":"Enterprise WhatsApp API","pages":[{"title":"Create Instance (v1)","sidebarTitle":"Create Instance","openapi":"v1/api-reference/enterprise/enterprise-collection.json POST /create-instance","href":"/v1/api-reference/enterprise/instance-management/create-instance"},{"title":"Request New QR Code (v1)","sidebarTitle":"Request New QR Code","openapi":"v1/api-reference/enterprise/enterprise-collection.json POST /{instance}/request-new-qr-code","href":"/v1/api-reference/enterprise/instance-management/request-new-qr-code"},{"title":"Restart Instance (v1)","sidebarTitle":"Restart Instance","openapi":"v1/api-reference/enterprise/enterprise-collection.json POST /{instance}/restart","href":"/v1/api-reference/enterprise/instance-management/restart-instance"},{"title":"Check Instance Health (v1)","sidebarTitle":"Check Instance Health","description":"Check the current health status of a WhatsApp instance by its UUID to monitor connectivity and readiness. (v1 API)","openapi":"v1/api-reference/enterprise/enterprise-collection.json GET /{instance}/health","href":"/v1/api-reference/enterprise/instance-management/check-instance-health"},{"title":"List Instances (v1)","sidebarTitle":"List Instances","openapi":"v1/api-reference/enterprise/enterprise-collection.json GET /instances","href":"/v1/api-reference/enterprise/instance-management/list-instances"},{"group":"Instance Management","pages":[]}]}]},{"tab":"Packages and SDKs","icon":"box-open","pages":[{"title":"Packages and SDKs","href":"/v1/packages-and-sdks/packages-and-sdks-overview"}]}]}]},"basePath":"","title":"List Instances (v1) - Hypersender","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}