List of tenants available in the workspace. Tenant JSON is the same shape as the create/update tenant response, including the parent_id, ancestors, level, and children_count fields introduced with sub-tenants.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"SuprSend: API-first notification infrastructure","colors":{"primary":"#2E70E8","light":"#63A3F7","dark":"#2E70E8"},"logo":"https://mintcdn.com/suprsend/CMaQBA3E8wM1DyFj/images/suprsend-logo.svg?fit=max\u0026auto=format\u0026n=CMaQBA3E8wM1DyFj\u0026q=85\u0026s=f325b9764c629a0b488476db369b8d47","favicon":"https://mintcdn.com/suprsend/5H8hv-jDy8OaCsyX/favicon.svg?fit=max\u0026auto=format\u0026n=5H8hv-jDy8OaCsyX\u0026q=85\u0026s=e9c88c84e18f0fd4a64adb33f5fa3603","api":{"openapi":"openapi.yaml"},"background":{"decoration":"windows"},"navbar":{"links":[{"href":"mailto:support@suprsend.com","label":"Contact Us"}],"primary":{"type":"button","label":"Get Started","href":"https://app.suprsend.com"}},"footer":{"socials":{"x":"https://x.com/suprsend","github":"https://github.com/suprsend","linkedin":"https://linkedin.com/company/suprsend","youtube":"https://youtube.com/@suprsend"}},"seo":{"indexing":"all"},"fonts":{"family":"Inter"},"styling":{"codeblocks":"system","latex":true},"integrations":{"ga4":{"measurementId":"G-PPDYBESP2L"},"gtm":{"tagId":"GTM-T6W3P8RG"},"mixpanel":{"projectToken":"2febb9e078d777860c5624f2579507a7"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"slack","color":{"light":"#f59f0b","dark":"#f59f0b"},"href":"https://join.slack.com/t/suprsendcommunity/shared_invite/zt-3932rw936-XNWY1RC8bsffh4if4ZyoXQ"},{"anchor":"Trust Center","icon":"shield-halved","color":{"light":"#2564eb","dark":"#2564eb"},"href":"https://trust.suprsend.com"},{"anchor":"Platform Status","icon":"wifi","color":{"light":"#2564eb","dark":"#2564eb"},"href":"https://status.suprsend.com"},{"anchor":"Postman Collection","icon":"code","color":{"light":"#2564eb","dark":"#2564eb"},"href":"https://www.postman.com/suprsend/suprsend/collection/16bdmwa/suprsend-apis"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"suprsend","hasAudioNarration":false,"actualSubdomain":"suprsend","customDomains":["docs.suprsend.com"],"gitSource":{"type":"github","owner":"suprsend","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae333734c2492fe62cb5f9a","collectionId":"37278b68-1dc8-4a19-977b-205d552098f2","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae333734c2492fe62cb5f9a"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae333734c2492fe62cb5f9a","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Documentation","count":151},{"language":"default","tag":"Developer Resources","count":105},{"language":"default","tag":"Management API","count":91},{"language":"default","tag":"API Reference","count":86},{"language":"default","tag":"SDKs and APIs","count":81},{"language":"default","tag":"SDKs","count":78},{"language":"default","tag":"CORE CONCEPTS","count":57},{"language":"default","tag":"CLI","count":50},{"language":"default","tag":"SuprSend Client SDK","count":43},{"language":"default","tag":"SuprSend Backend SDK","count":34}]},"assistantConfig":{"deflection":{"enabled":true,"email":"support@suprsend.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"img{max-width:100%;height:auto}table{display:block}code,pre,table{overflow-x:auto;max-width:100%}@media (max-width:768px){img[width]{width:100%!important;max-width:100%!important;height:auto!important}pre{font-size:13px}}a.card[href=\"https://skills.sh/suprsend/skills\"]{position:relative}a.card[href=\"https://skills.sh/suprsend/skills\"]>img{position:absolute!important;top:1.25rem!important;left:1.5rem!important;width:1.5rem!important;height:1.5rem!important;max-width:1.5rem!important;max-height:1.5rem!important;min-height:1.5rem!important;object-fit:contain!important;z-index:1}a.card[href=\"https://skills.sh/suprsend/skills\"] .px-6.py-5{padding-top:3.25rem!important}a.card[href=\"https://skills.sh/suprsend/skills\"] h2{margin-top:0!important}[data-component-name=mermaid-controls-wrapper]{display:none!important}.mermaid .cluster-label,.mermaid .cluster-label p,.mermaid .edgeLabel,.mermaid .edgeLabel p,.mermaid .nodeLabel,.mermaid .nodeLabel p{color:#4d4d4d!important}.mermaid .cluster-label,.mermaid .edgeLabel,.mermaid .nodeLabel,.mermaid text{fill:#4d4d4d!important}.dark .mermaid .cluster-label,.dark .mermaid .cluster-label p,.dark .mermaid .edgeLabel,.dark .mermaid .edgeLabel p,.dark .mermaid .nodeLabel,.dark .mermaid .nodeLabel p{color:#ccc!important}.dark .mermaid .cluster-label,.dark .mermaid .edgeLabel,.dark .mermaid .nodeLabel,.dark .mermaid text{fill:#ccc!important}.changelog-page-content{padding:0 7rem}@media (max-width:768px){.changelog-page-content{padding:0 1rem}}.ss-flow{--ss-ink:#1f2937;--ss-muted:#6b7280;--ss-line:#e5e7eb;--ss-accent:#2e70e8;--ss-core-bg:#f5f8fe;--ss-core-line:#d4e2fb;--ss-arrow:#9ca3af;display:grid;grid-template-columns:minmax(0,1fr) 1.5rem minmax(0,2.1fr) 1.5rem minmax(0,1fr);align-items:center;margin:1.75rem 0 2rem;font-size:.875rem;line-height:1.4;color:var(--ss-ink)}.dark .ss-flow{--ss-ink:#e5e7eb;--ss-muted:#9ca3af;--ss-line:rgba(255, 255, 255, 0.12);--ss-accent:#63a3f7;--ss-core-bg:rgba(46, 112, 232, 0.1);--ss-core-line:rgba(99, 163, 247, 0.28);--ss-arrow:#6b7280}.ss-flow .ss-flow__label{margin:0 0 .5rem;font-size:.75rem;font-weight:600;color:var(--ss-muted)}.ss-flow .ss-flow__list{list-style:none;margin:0;padding:.5rem .75rem;border:1px solid var(--ss-line);border-radius:10px;font-size:.8125rem}.ss-flow .ss-flow__list li{margin:0;padding:.3125rem 0}.ss-flow .ss-flow__arrow{position:relative;height:1px;margin:1.25rem .25rem 0 .125rem;background:var(--ss-arrow)}.ss-flow .ss-flow__arrow::after{content:\"\";position:absolute;top:-4px;right:-1px;border-top:4.5px solid transparent;border-bottom:4.5px solid transparent;border-left:6px solid var(--ss-arrow)}.ss-flow .ss-flow__core{overflow:hidden;border:1px solid var(--ss-core-line);border-radius:14px;background:var(--ss-core-bg)}.ss-flow .ss-flow__label--core{margin:0;padding:.875rem 1rem 0;font-size:.875rem;color:var(--ss-accent)}.ss-flow .ss-flow__stages{list-style:none;margin:0;padding:.875rem 1rem 1rem}.ss-flow .ss-flow__stage{position:relative;margin:0;padding:0 0 1rem 1.5rem}.ss-flow .ss-flow__stage:last-child{padding-bottom:0}.ss-flow .ss-flow__stage::before{content:\"\";position:absolute;top:.3rem;left:0;z-index:1;width:.625rem;height:.625rem;border-radius:50%;background:var(--ss-accent)}.ss-flow .ss-flow__stage::after{content:\"\";position:absolute;top:.5rem;bottom:-.5rem;left:calc(.3125rem - 1px);width:2px;background:var(--ss-core-line)}.ss-flow .ss-flow__stage:last-child::after{display:none}.ss-flow .ss-flow__stage strong{display:block}.ss-flow .ss-flow__stage span{display:block;margin-top:.125rem;font-size:.8125rem;color:var(--ss-muted)}.ss-flow .ss-flow__logs{margin:0;padding:.625rem 1rem;border-top:1px dashed var(--ss-core-line);font-size:.8125rem;color:var(--ss-muted)}.ss-flow .ss-flow__logs strong,.ss-flow .ss-flow__stage strong{font-weight:600;color:var(--ss-ink)}@media (max-width:640px){.ss-flow{grid-template-columns:minmax(0,1fr)}.ss-flow .ss-flow__list{display:flex;flex-wrap:wrap;gap:0 1rem}.ss-flow .ss-flow__arrow{width:1px;height:1.25rem;margin:.5rem auto}.ss-flow .ss-flow__arrow::after{top:auto;right:auto;bottom:-1px;left:-4px;border-top:6px solid var(--ss-arrow);border-right:4.5px solid transparent;border-bottom:0;border-left:4.5px solid transparent}}"}],"page":{"pagePath":"reference/get-tenant-list","slug":"/reference/get-tenant-list","pageMetadata":{"title":"List Tenants","openapi":"GET /v1/tenant/","sidebarTitle":"List Tenants","description":"API to fetch a paginated list of tenants available in your workspace.","href":"/reference/get-tenant-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: \"API to fetch a paginated list of tenants available in your workspace.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"List Tenants","openapi":"GET /v1/tenant/","sidebarTitle":"List Tenants","description":"API to fetch a paginated list of tenants available in your workspace.","href":"/reference/get-tenant-list"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/suprsend/1ff47b86af33ef76/apollo-tracker.js"],"openApiReferenceData":{"operation":{"summary":"List Tenants","security":["edea4abf-44bd-49a8-91e4-d1d40cce3899"],"description":"API to fetch a paginated list of tenants available in your workspace.","operationId":"get-tenant-list","parameters":["4f5e7d26-cc85-4b60-a119-35143f91b72a","3febfda6-3801-4da2-8734-5f1895814877","1e8d7aa4-93b1-4d22-adde-b1e13299b918","c3c31de2-954a-42fb-9250-7a1aa1cf2e99","cb7f302a-41c3-4f62-b763-3ab3d8fc0ee8"],"responses":{"200":"bc0c79ad-f457-40b5-910a-7e1eeaaabc80"},"deprecated":false,"method":"get","type":"path","servers":["eea7dbe4-4763-43a4-939e-87eba61d4470"],"path":"/v1/tenant/","baseUrlOptions":["https://hub.suprsend.com"],"title":"List Tenants","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"4f5e7d26-cc85-4b60-a119-35143f91b72a":{"name":"limit","in":"query","description":"Number of tenants to return per page.","schema":{"type":"integer","default":10,"description":"Number of tenants to return per page.","uniqueKey":"","typeLabel":"integer"}},"3febfda6-3801-4da2-8734-5f1895814877":{"name":"offset","in":"query","description":"Number of tenants to skip.","schema":{"type":"integer","description":"Number of tenants to skip.","uniqueKey":"","typeLabel":"integer"}},"1e8d7aa4-93b1-4d22-adde-b1e13299b918":{"name":"parent_id","in":"query","description":"Returns only direct children of the given tenant.","required":false,"schema":{"type":"string","isRequired":false,"description":"Returns only direct children of the given tenant.","uniqueKey":"","typeLabel":"string"},"example":"acme-corp"},"c3c31de2-954a-42fb-9250-7a1aa1cf2e99":{"name":"ancestor[]","in":"query","description":"Returns all descendants (at any depth) of the given tenant. The tenant itself is not included. Repeat the param to pass multiple tenants.","required":false,"schema":{"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX]","typeLabel":"string"},"isRequired":false,"description":"Returns all descendants (at any depth) of the given tenant. The tenant itself is not included. Repeat the param to pass multiple tenants.","uniqueKey":"","typeLabel":"string[]"},"example":["acme-corp"]},"cb7f302a-41c3-4f62-b763-3ab3d8fc0ee8":{"name":"level[]","in":"query","description":"Returns tenants at the given level(s). Root = 0, max = 4. Repeat the param to combine levels.","required":false,"schema":{"type":"array","items":{"type":"integer","uniqueKey":"items.[INDEX]","typeLabel":"integer"},"isRequired":false,"description":"Returns tenants at the given level(s). Root = 0, max = 4. Repeat the param to combine levels.","uniqueKey":"","typeLabel":"integer[]"},"example":[0]}},"responses":{"bc0c79ad-f457-40b5-910a-7e1eeaaabc80":{"description":"200 - OK","content":{"application/json":{"examples":{"Result":{"title":"Result","value":{"meta":{"count":28,"limit":20,"offset":0},"results":[{"id":"acme-corp","name":"Acme Corp","tenant_id":"acme-corp","tenant_name":"Acme Corp","parent_id":null,"ancestors":[],"level":0,"children_count":2,"logo":"https://ik.imagekit.io/l0quatz6utm/suprsend/staging/media/suprsend-only-logo_c8aa27faef118418e8c5bd7b31a1cafc74e09200.png","timezone":null,"blocked_channels":null,"embedded_preference_url":"https://app.suprsend.com/en/user-settings/notifications","hosted_preference_domain":"preferences.suprsend.com","primary_color":"#ff0000","secondary_color":null,"tertiary_color":null,"social_links":{"website":"https://suprsend.com","facebook":"","linkedin":"","x":"","instagram":"","medium":"","discord":"","telegram":"","youtube":""},"properties":{},"updated_at":"2026-08-27T20:57:16.935605Z"}]}}},"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"count":{"type":"integer","example":28,"description":"Total number of results returned.","uniqueKey":"meta.count","typeLabel":"integer"},"limit":{"type":"integer","example":20,"description":"Maximum number of results per page.","uniqueKey":"meta.limit","typeLabel":"integer"},"offset":{"type":"integer","example":0,"description":"offset passed in request","uniqueKey":"meta.offset","typeLabel":"integer"}},"uniqueKey":"meta","typeLabel":"object"},"results":{"type":"array","description":"List of tenants available in the workspace. Tenant JSON is the same shape as the [create/update tenant](/reference/create-update-tenants) response, including the `parent_id`, `ancestors`, `level`, and `children_count` fields introduced with [sub-tenants](/docs/sub-tenants).","items":{"type":"object","properties":{"id":{"type":"string","description":"Tenant `id`. Replaces the legacy `tenant_id` field; both are returned.","example":"acme-corp","uniqueKey":"results.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Tenant display name. Replaces the legacy `tenant_name` field; both are returned.","example":"Acme Corp","uniqueKey":"results.items.[INDEX].name","typeLabel":"string"},"tenant_id":{"type":"string","description":"Will be deprecated in future. Use `id` instead.","example":"acme-corp","uniqueKey":"results.items.[INDEX].tenant_id","typeLabel":"string"},"tenant_name":{"type":"string","description":"Will be deprecated in future. Use `name` instead.","example":"Awesome Tenant","uniqueKey":"results.items.[INDEX].tenant_name","typeLabel":"string"},"logo":{"type":"string","format":"uri","description":"Tenant logo URL.","example":"https://logo.png","uniqueKey":"results.items.[INDEX].logo","typeLabel":"string\u003curi>"},"timezone":{"oneOf":[{"type":"string","description":"Tenant timezone. Used as a fallback when the recipient user has no timezone set.","example":"America/New_York","uniqueKey":"results.items.[INDEX].timezone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Tenant timezone. Used as a fallback when the recipient user has no timezone set.","example":"America/New_York","uniqueKey":"results.items.[INDEX].timezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].timezone","typeLabel":"string | null"},"blocked_channels":{"oneOf":[{"type":"string","examples":{"email":{"summary":"Email channel","value":"email"},"sms":{"summary":"SMS channel","value":"sms"}},"description":"Channels turned off for this tenant. Notifications on these channels won't be sent to any user of the tenant — including on [root categories](/docs/notification-category#root-categories) (which users normally can't unsubscribe from) — and users can't override this. If [sub-tenants](/docs/sub-tenants) are used, a block set here also applies to every sub-tenant below and can't be removed lower down.","uniqueKey":"results.items.[INDEX].blocked_channels.oneOf.0","typeLabel":"string"},{"type":"null","examples":{"email":{"summary":"Email channel","value":"email"},"sms":{"summary":"SMS channel","value":"sms"}},"description":"Channels turned off for this tenant. Notifications on these channels won't be sent to any user of the tenant — including on [root categories](/docs/notification-category#root-categories) (which users normally can't unsubscribe from) — and users can't override this. If [sub-tenants](/docs/sub-tenants) are used, a block set here also applies to every sub-tenant below and can't be removed lower down.","uniqueKey":"results.items.[INDEX].blocked_channels.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].blocked_channels","typeLabel":"string | null"},"embedded_preference_url":{"type":"string","format":"uri","description":"URL of your product's preference page.","example":"https://app.suprsend.com/en/user-settings/notifications","uniqueKey":"results.items.[INDEX].embedded_preference_url","typeLabel":"string\u003curi>"},"hosted_preference_domain":{"type":"string","description":"Domain of the SuprSend-hosted preference page.","example":"preferences.suprsend.com","uniqueKey":"results.items.[INDEX].hosted_preference_domain","typeLabel":"string"},"primary_color":{"type":"string","description":"Primary brand color, used in the tenant's email header, buttons, and footer. If left empty when creating a root tenant, it's set to SuprSend's default (`#777777`).","example":"#ff0000","uniqueKey":"results.items.[INDEX].primary_color","typeLabel":"string"},"secondary_color":{"oneOf":[{"type":"string","description":"Secondary brand color. Not part of the default tenant component but can be used in templates as `{{$tenant.secondary_color}}`. If both secondary and tertiary colors are left empty when creating a root tenant, they're copied from the default tenant.","example":"#ff0000","uniqueKey":"results.items.[INDEX].secondary_color.oneOf.0","typeLabel":"string"},{"type":"null","description":"Secondary brand color. Not part of the default tenant component but can be used in templates as `{{$tenant.secondary_color}}`. If both secondary and tertiary colors are left empty when creating a root tenant, they're copied from the default tenant.","example":"#ff0000","uniqueKey":"results.items.[INDEX].secondary_color.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].secondary_color","typeLabel":"string | null"},"tertiary_color":{"oneOf":[{"type":"string","description":"Tertiary brand color. Not part of the default tenant component but can be used in templates as `{{$tenant.tertiary_color}}`. If both secondary and tertiary colors are left empty when creating a root tenant, they're copied from the default tenant.","example":"#ff0000","uniqueKey":"results.items.[INDEX].tertiary_color.oneOf.0","typeLabel":"string"},{"type":"null","description":"Tertiary brand color. Not part of the default tenant component but can be used in templates as `{{$tenant.tertiary_color}}`. If both secondary and tertiary colors are left empty when creating a root tenant, they're copied from the default tenant.","example":"#ff0000","uniqueKey":"results.items.[INDEX].tertiary_color.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].tertiary_color","typeLabel":"string | null"},"social_links":{"type":"object","description":"Tenant's social media URLs.","properties":{"website":{"type":"string","example":"https://suprsend.com","uniqueKey":"results.items.[INDEX].social_links.website","typeLabel":"string"},"facebook":{"type":"string","example":"","uniqueKey":"results.items.[INDEX].social_links.facebook","typeLabel":"string"},"linkedin":{"type":"string","example":"","uniqueKey":"results.items.[INDEX].social_links.linkedin","typeLabel":"string"},"x":{"type":"string","example":"","uniqueKey":"results.items.[INDEX].social_links.x","typeLabel":"string"},"instagram":{"type":"string","example":"","uniqueKey":"results.items.[INDEX].social_links.instagram","typeLabel":"string"},"medium":{"type":"string","example":"","uniqueKey":"results.items.[INDEX].social_links.medium","typeLabel":"string"},"discord":{"type":"string","example":"","uniqueKey":"results.items.[INDEX].social_links.discord","typeLabel":"string"},"telegram":{"type":"string","example":"","uniqueKey":"results.items.[INDEX].social_links.telegram","typeLabel":"string"},"youtube":{"type":"string","example":"","uniqueKey":"results.items.[INDEX].social_links.youtube","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX].social_links","typeLabel":"object"},"properties":{"type":"object","description":"Custom tenant properties (local values only). Inherited values from ancestors are resolved at trigger time.","additionalProperties":true,"example":{"region":"US"},"uniqueKey":"results.items.[INDEX].properties","typeLabel":"object"},"parent_id":{"oneOf":[{"type":"string","description":"Parent tenant `id` when this tenant is a [sub-tenant](/docs/sub-tenants). `null` for root tenants (including flat tenants that aren't part of a hierarchy).","example":null,"uniqueKey":"results.items.[INDEX].parent_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Parent tenant `id` when this tenant is a [sub-tenant](/docs/sub-tenants). `null` for root tenants (including flat tenants that aren't part of a hierarchy).","example":null,"uniqueKey":"results.items.[INDEX].parent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].parent_id","typeLabel":"string | null"},"ancestors":{"type":"array","items":{"type":"string","uniqueKey":"results.items.[INDEX].ancestors.items.[INDEX]","typeLabel":"string"},"description":"For [sub-tenants](/docs/sub-tenants): ancestor tenant `id`s from root down to the immediate parent (excludes the tenant itself). Empty for root and flat tenants.","example":[],"uniqueKey":"results.items.[INDEX].ancestors","typeLabel":"string[]"},"level":{"type":"integer","description":"For [sub-tenants](/docs/sub-tenants): depth in the tree. Root = 0, max = 4. Flat tenants always report `0`.","example":0,"uniqueKey":"results.items.[INDEX].level","typeLabel":"integer"},"children_count":{"type":"integer","description":"For [sub-tenants](/docs/sub-tenants): number of direct children. `0` for tenants with no sub-tenants.","example":2,"uniqueKey":"results.items.[INDEX].children_count","typeLabel":"integer"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the tenant was last updated.","example":"2026-08-27T20:57:16.935605Z","uniqueKey":"results.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"results.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"edea4abf-44bd-49a8-91e4-d1d40cce3899":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API_Key","description":"Pass as `Bearer \u003cAPI_KEY>`. Get API Key from SuprSend dashboard Developers -> API Keys section.","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"eea7dbe4-4763-43a4-939e-87eba61d4470":{"url":"https://hub.suprsend.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API_Key","description":"Pass as `Bearer \u003cAPI_KEY>`. Get API Key from SuprSend dashboard Developers -> API Keys section.","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Pass as `Bearer \u003cAPI_KEY>`. Get API Key from SuprSend dashboard Developers -> API Keys section.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"suprsend","siteName":"SuprSend: API-first notification infrastructure","title":"List Tenants - SuprSend: API-first notification infrastructure","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-30T00:01:49.780Z","originalFileLocation":"reference/get-tenant-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=\"API to fetch a paginated list of tenants available in your workspace.\">\u003cmeta data-mint-head name=\"application-name\" content=\"SuprSend: API-first notification infrastructure\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/suprsend/FnIDjx0xTYX1D8EZ/_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/suprsend/FnIDjx0xTYX1D8EZ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/suprsend/FnIDjx0xTYX1D8EZ/_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/suprsend/FnIDjx0xTYX1D8EZ/_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/suprsend/FnIDjx0xTYX1D8EZ/_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/suprsend/FnIDjx0xTYX1D8EZ/_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/suprsend/FnIDjx0xTYX1D8EZ/_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/suprsend/FnIDjx0xTYX1D8EZ/_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/suprsend/FnIDjx0xTYX1D8EZ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Tenants - SuprSend: API-first notification infrastructure\">\u003cmeta data-mint-head property=\"og:description\" content=\"API to fetch a paginated list of tenants available in your workspace.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SuprSend: API-first notification infrastructure\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.suprsend.com/reference/get-tenant-list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://suprsend.mintlify.app/_mintlify/api/og/v2?division=TENANTS\u0026amp;title=List+Tenants\u0026amp;description=API+to+fetch+a+paginated+list+of+tenants+available+in+your+workspace.\u0026amp;theme=77e430d508312c14f721c90a\u0026amp;signature=1ff1eb2f4fd6c8ec6d5277949564cc1c3bb995273956a632d7d553aa7bdd7d9d\">\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 Tenants - SuprSend: API-first notification infrastructure\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"API to fetch a paginated list of tenants available in your workspace.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://suprsend.mintlify.app/_mintlify/api/og/v2?division=TENANTS\u0026amp;title=List+Tenants\u0026amp;description=API+to+fetch+a+paginated+list+of+tenants+available+in+your+workspace.\u0026amp;theme=77e430d508312c14f721c90a\u0026amp;signature=1ff1eb2f4fd6c8ec6d5277949564cc1c3bb995273956a632d7d553aa7bdd7d9d\">\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/suprsend/FnIDjx0xTYX1D8EZ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"SuprSend: API-first notification infrastructure\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2E70E8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.suprsend.com/reference/get-tenant-list\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/get-tenant-list.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.suprsend.com/#organization\",\"name\":\"SuprSend: API-first notification infrastructure\",\"url\":\"https://docs.suprsend.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/suprsend/CMaQBA3E8wM1DyFj/images/suprsend-logo.svg?fit=max\u0026auto=format\u0026n=CMaQBA3E8wM1DyFj\u0026q=85\u0026s=f325b9764c629a0b488476db369b8d47\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.suprsend.com#website\",\"name\":\"SuprSend: API-first notification infrastructure\",\"url\":\"https://docs.suprsend.com\",\"publisher\":{\"@id\":\"https://docs.suprsend.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.suprsend.com/reference/get-tenant-list#webpage\",\"url\":\"https://docs.suprsend.com/reference/get-tenant-list\",\"name\":\"List Tenants\",\"description\":\"API to fetch a paginated list of tenants available in your workspace.\",\"dateModified\":\"2026-08-30T00:01:49.780Z\",\"isPartOf\":{\"@id\":\"https://docs.suprsend.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.suprsend.com/reference/get-tenant-list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.suprsend.com/reference/get-tenant-list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"TENANTS\",\"item\":\"https://docs.suprsend.com/reference/create-update-tenants\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List Tenants\",\"item\":\"https://docs.suprsend.com/reference/get-tenant-list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.suprsend.com/reference/get-tenant-list#apireference\",\"headline\":\"List Tenants\",\"name\":\"List Tenants\",\"description\":\"API to fetch a paginated list of tenants available in your workspace.\",\"url\":\"https://docs.suprsend.com/reference/get-tenant-list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.suprsend.com/reference/get-tenant-list#webpage\"},\"dateModified\":\"2026-08-30T00:01:49.780Z\",\"publisher\":{\"@id\":\"https://docs.suprsend.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.suprsend.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"SuprSend: API-first notification infrastructure\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"SuprSend: API-first notification infrastructure","nav":{"global":{"anchors":[{"anchor":"Community","icon":"slack","color":{"light":"#f59f0b","dark":"#f59f0b"},"href":"https://join.slack.com/t/suprsendcommunity/shared_invite/zt-3932rw936-XNWY1RC8bsffh4if4ZyoXQ"},{"anchor":"Trust Center","icon":"shield-halved","color":{"light":"#2564eb","dark":"#2564eb"},"href":"https://trust.suprsend.com"},{"anchor":"Platform Status","icon":"wifi","color":{"light":"#2564eb","dark":"#2564eb"},"href":"https://status.suprsend.com"},{"anchor":"Postman Collection","icon":"code","color":{"light":"#2564eb","dark":"#2564eb"},"href":"https://www.postman.com/suprsend/suprsend/collection/16bdmwa/suprsend-apis"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/docs/what-is-suprsend"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/docs/guides/modelling-customers-workspace-vs-tenant"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"Overview","href":"/reference/overview"},{"title":"Authentication","href":"/reference/authentication"},{"title":"Idempotent Requests","href":"/reference/idempotent-requests"},{"title":"SuprSend APIs on Postman","href":"/reference/postman-collection"}]},{"group":"USERS","pages":[{"title":"Create / Update Users","openapi":"POST /v1/user/{distinct_id}/","sidebarTitle":"Create / Update Users","href":"/reference/create-update-users"},{"title":"Edit User Profile","openapi":"PATCH /v1/user/{distinct_id}/","sidebarTitle":"Edit User Profile","href":"/reference/edit-user-profile"},{"title":"Fetch User by id","openapi":"GET /v1/user/{distinct_id}/","sidebarTitle":"Fetch User by id","href":"/reference/get-user-profile"},{"title":"Upsert User Tenant Profile","openapi":"POST /v1/user/{distinct_id}/tenant/{tenant_id}/","sidebarTitle":"Upsert User Tenant Profile","href":"/reference/upsert-user-tenant-profile"},{"title":"Fetch User Tenant Profile","openapi":"GET /v1/user/{distinct_id}/tenant/{tenant_id}/","sidebarTitle":"Fetch User Tenant Profile","href":"/reference/fetch-user-tenant-profile"},{"title":"List User Tenant Profiles","openapi":"GET /v1/user/{distinct_id}/tenant/","sidebarTitle":"List User Tenant Profiles","href":"/reference/list-user-tenant-profiles"},{"title":"Delete User Tenant Mapping","openapi":"DELETE /v1/user/{distinct_id}/tenant/{tenant_id}/","sidebarTitle":"Delete User Tenant Mapping","href":"/reference/delete-user-tenant-mapping"},{"title":"Fetch User object subscriptions","openapi":"GET /v1/user/{distinct_id}/subscribed_to/object/","sidebarTitle":"Fetch User object subscriptions","href":"/reference/fetch-user-object-subscriptions"},{"title":"Fetch User list subscriptions","openapi":"GET /v1/user/{distinct_id}/subscribed_to/list/","sidebarTitle":"Fetch User list subscriptions","href":"/reference/fetch-user-list-subscriptions"},{"title":"List Users","openapi":"GET /v1/user/","sidebarTitle":"List Users","href":"/reference/list-users"},{"title":"Delete User","openapi":"DELETE /v1/user/{distinct_id}/","sidebarTitle":"Delete User","href":"/reference/delete-user"},{"title":"Merge User Profiles","openapi":"POST /v1/user/{distinct_id}/merge/","sidebarTitle":"Merge User Profiles","href":"/reference/merge-users"}]},{"group":"TRIGGER WORKFLOWS","pages":[{"title":"Trigger Workflow (single or bulk)","openapi":"POST /trigger/","sidebarTitle":"Trigger Workflow","href":"/reference/trigger-workflow-api"},{"title":"Trigger Workflow on a List","openapi":"POST /trigger/list/","sidebarTitle":"Trigger Workflow on List","href":"/reference/trigger-workflow-on-list"},{"title":"Dynamic Workflow Trigger","openapi":"POST /{workspace_key}/trigger/","sidebarTitle":"Dynamic Workflow Trigger","href":"/reference/dynamic-workflow-trigger"},{"title":"Cancel Workflow","openapi":"POST /v1/workflow_run/cancel/","sidebarTitle":"Cancel Workflow","href":"/reference/cancel-workflow"}]},{"group":"EVENTS","pages":[{"title":"Trigger an Event","openapi":"POST /event/","sidebarTitle":"Trigger an Event","href":"/reference/trigger-event"}]},{"group":"MESSAGES","pages":[{"title":"List Messages","openapi":"GET /v1/message/","sidebarTitle":"List Messages","href":"/reference/list-messages"},{"title":"Get Message Content","openapi":"GET /v1/message/{message_id}/content/","sidebarTitle":"Get Message Content","href":"/reference/get-message-content"},{"title":"Bulk Update Message Status","openapi":"PATCH /v1/bulk/message/","sidebarTitle":"Bulk Update Message Status","href":"/reference/bulk-update-messages"}]},{"group":"OBJECTS","pages":[{"title":"Create / Update Objects","openapi":"POST /v1/object/{object_type}/{id}/","sidebarTitle":"Create / Update Objects","href":"/reference/create-update-objects"},{"title":"Edit Object Profile","openapi":"PATCH /v1/object/{object_type}/{id}/","sidebarTitle":"Edit Object Profile","href":"/reference/edit-object-profile"},{"title":"Add Subscription","openapi":"POST /v1/object/{object_type}/{id}/subscription/","sidebarTitle":"Add Subscription","href":"/reference/add-object-subscription"},{"title":"Fetch Object by ID","openapi":"GET /v1/object/{object_type}/{id}/","sidebarTitle":"Fetch Object by ID","href":"/reference/get-object-by-id"},{"title":"Fetch Object Subscriptions","openapi":"GET /v1/object/{object_type}/{id}/subscribed_to/object/","sidebarTitle":"Fetch Object Subscriptions","href":"/reference/get-object-subscriptions"},{"title":"List Objects by Type","openapi":"GET /v1/object/{object_type}/","sidebarTitle":"List Objects by Type","href":"/reference/list-objects-by-type"},{"title":"List Object Subscriptions","openapi":"GET /v1/object/{object_type}/{id}/subscription/","sidebarTitle":"List Object Subscriptions","href":"/reference/list-object-subscriptions"},{"title":"Delete an Object","openapi":"DELETE /v1/object/{object_type}/{id}/","sidebarTitle":"Delete an Object","href":"/reference/delete-object"},{"title":"Remove Object Subscriptions","openapi":"DELETE /v1/object/{object_type}/{id}/subscription/","sidebarTitle":"Remove Object Subscriptions","href":"/reference/delete-object-subscription"}]},{"group":"TEMPLATES","pages":[{"title":"Fetch Template List","openapi":"GET /v1/template/","sidebarTitle":"Fetch Template List","href":"/reference/get-template-list"},{"title":"Fetch Template details","openapi":"GET /v1/template/{template_slug}/","sidebarTitle":"Fetch Template details","href":"/reference/get-template-details"},{"title":"Fetch Template content for a Channel","openapi":"GET /v1/template/{template_slug}/channel/{channel_slug}/","sidebarTitle":"Fetch Template content for a channel","href":"/reference/get-template-details-for-channel"}]},{"group":"TENANTS","pages":[{"title":"Create / Update Tenants","openapi":"POST /v1/tenant/{tenant_id}/","sidebarTitle":"Create / Update Tenants","href":"/reference/create-update-tenants"},{"title":"Update Tenant Properties","openapi":"PATCH /v1/tenant/{tenant_id}/properties/","sidebarTitle":"Update Tenant Properties","href":"/reference/update-tenant-properties"},{"title":"Get Tenant","openapi":"GET /v1/tenant/{tenant_id}/","sidebarTitle":"Get Tenant","description":"API to fetch properties and blocked channel settingcorresponding to a tenant_id. To create or update tenant data, use the [Create/Update Tenant](#operation/create-tenants) endpoint.","href":"/reference/get-tenant-data"},{"title":"List Tenants","openapi":"GET /v1/tenant/","sidebarTitle":"List Tenants","href":"/reference/get-tenant-list"},{"title":"Delete Tenant","openapi":"DELETE /v1/tenant/{tenant_id}/","sidebarTitle":"Delete Tenant","description":"Delete a tenant by passing it's ID. Deletion does not affect in-flight notifications, which complete with the settings that were in effect at trigger time. When the tenant has sub-tenants, use `children_action` in the request body to control what happens to them.","href":"/reference/delete-tenant"}]},{"group":"PREFERENCE","pages":[{"group":"Get User Preferences","pages":[{"title":"Full Preference","openapi":"GET /v1/user/{distinct_id}/preference/","sidebarTitle":"Full Preference","href":"/reference/get-user-full-preference"},{"title":"All Categories","openapi":"GET /v1/user/{distinct_id}/preference/category/","sidebarTitle":"All Categories","href":"/reference/user-category-preference"},{"title":"All Channels","openapi":"GET /v1/user/{distinct_id}/preference/channel_preference/","sidebarTitle":"All Channels","href":"/reference/get-user-channel-preferences"},{"title":"Single Category","openapi":"GET /v1/user/{distinct_id}/preference/category/{category_slug}/","sidebarTitle":"Single Category","href":"/reference/get-user-category-preferences"}]},{"group":"Update User Preferences","pages":[{"title":"Update User Full Preference","openapi":"PATCH /v1/user/{distinct_id}/preference/","sidebarTitle":"Update User Full Preference","href":"/reference/update-user-full-preference"},{"title":"Category and Channel within Category","openapi":"PATCH /v1/user/{distinct_id}/preference/category/{category_slug}/","sidebarTitle":"Category and Channel within Category","href":"/reference/update-user-category-preference"},{"title":"Overall Channel level","openapi":"PATCH /v1/user/{distinct_id}/preference/channel_preference/","sidebarTitle":"Overall Channel level","href":"/reference/update-user-channel-preference"},{"title":"Bulk Update","openapi":"PATCH /v1/bulk/user/preference/","sidebarTitle":"Bulk Update","href":"/reference/bulk-update-user-preference"},{"title":"Reset","openapi":"PATCH /v1/bulk/user/preference/reset/","sidebarTitle":"Reset","href":"/reference/reset-user-preferences"}]},{"group":"Manage Tenant Preferences","pages":[{"title":"Get Tenant Full Preference","openapi":"GET /v1/tenant/{tenant_id}/preference/","sidebarTitle":"Get Tenant Full Preference","href":"/reference/get-tenant-full-preference"},{"title":"Get Tenant Preference All Categories","openapi":"GET /v1/tenant/{tenant_id}/preference/category/","sidebarTitle":"Get Tenant Preference All Categories","href":"/reference/get-tenant-preference-all-categories"},{"title":"Get Tenant Preference Single Category","openapi":"GET /v1/tenant/{tenant_id}/preference/category/{category}/","sidebarTitle":"Get Tenant Preference Single Category","href":"/reference/get-tenant-preference-single-category"},{"title":"Update Tenant Preference Single Category","openapi":"PATCH /v1/tenant/{tenant_id}/preference/category/{category}/","sidebarTitle":"Update Tenant Preference Single Category","href":"/reference/update-tenant-preference-single-category"},{"title":"Get Tenant Default Preference","openapi":"GET /v1/tenant/{tenant_id}/category/","sidebarTitle":"Get Tenant Default Preference","href":"/reference/get-tenant-category-preferences"}]},{"group":"Get Object Preferences","pages":[{"title":"Full Preference","openapi":"GET /v1/object/{object_type}/{id}/preference/","sidebarTitle":"Full Preference","href":"/reference/get-object-full-preference"},{"title":"All Categories","openapi":"GET /v1/object/{object_type}/{id}/preference/category/","sidebarTitle":"All Categories","href":"/reference/get-object-category-preference"},{"title":"All Channels","openapi":"GET /v1/object/{object_type}/{id}/preference/channel_preference/","sidebarTitle":"All Channels","href":"/reference/get-object-channel-preferences"},{"title":"Single Category","openapi":"GET /v1/object/{object_type}/{id}/preference/category/{category_slug}/","sidebarTitle":"Single Category","href":"/reference/get-object-single-category-preference"}]},{"group":"Update Object Preferences","pages":[{"title":"Update Object Full Preference","openapi":"PATCH /v1/object/{object_type}/{id}/preference/","sidebarTitle":"Update Object Full Preference","href":"/reference/update-object-full-preference"},{"title":"Category and Channel within Category","openapi":"PATCH /v1/object/{object_type}/{id}/preference/category/{category_slug}/","sidebarTitle":"Category and Channel within Category","href":"/reference/object-preference-category"},{"title":"Overall Channel level","openapi":"PATCH /v1/object/{object_type}/{id}/preference/channel_preference/","sidebarTitle":"Overall Channel level","href":"/reference/update-object-channel-preference"}]}]},{"group":"LISTS","pages":[{"title":"Create a List","openapi":"POST /v1/subscriber_list/","sidebarTitle":"Create a List","href":"/reference/create-list"},{"title":"Add Users to List","openapi":"POST /v1/subscriber_list/{list_id}/subscriber/add/","sidebarTitle":"Add Users to List","href":"/reference/add-user-to-list"},{"title":"Remove Users from List","openapi":"POST /v1/subscriber_list/{list_id}/subscriber/remove/","sidebarTitle":"Remove Users from List","href":"/reference/remove-subscribers-from-list"},{"group":"Replace List Users","pages":[{"title":"Overview","href":"/reference/replace-list-subscribers"},{"title":"Start Sync","openapi":"POST /v1/subscriber_list/{list_id}/start_sync/","sidebarTitle":"Start Sync","href":"/reference/start-sync"},{"title":"Add Users to Draft List","openapi":"POST /v1/subscriber_list/{list_id}/version/{version_id}/subscriber/add/","sidebarTitle":"Add Users to Draft List","href":"/reference/add-subscribers-to-draft-list"},{"title":"Remove Users from Draft List","openapi":"POST /v1/subscriber_list/{list_id}/version/{version_id}/subscriber/remove/","sidebarTitle":"Remove Users from Draft List","href":"/reference/remove-subscribers-from-draft-list"},{"title":"Finish Sync","openapi":"PATCH /v1/subscriber_list/{list_id}/version/{version_id}/finish_sync/","sidebarTitle":"Finish Sync","href":"/reference/finish-sync"},{"title":"Delete Draft List","openapi":"PATCH /v1/subscriber_list/{list_id}/version/{version_id}/delete/","sidebarTitle":"Delete Draft List","href":"/reference/delete-draft-list"}]},{"group":"Segment Lists (dry-run)","pages":[{"title":"Dry-run a segment query (sample rows)","openapi":"POST /v1/subscriber_list/~/dry_run/","sidebarTitle":"Segment dry-run (rows)","href":"/reference/segment-dry-run"},{"title":"Dry-run a segment query (count only)","openapi":"POST /v1/subscriber_list/~/dry_run/count/","sidebarTitle":"Segment dry-run (count)","href":"/reference/segment-dry-run-count"}]},{"title":"Get all Lists","openapi":"GET /v1/subscriber_list/","sidebarTitle":"Get all Lists","href":"/reference/get-all-lists"},{"title":"Get List Configuration","openapi":"GET /v1/subscriber_list/{list_id}/","sidebarTitle":"Get List Configuration","href":"/reference/get-list-details"},{"title":"Get list users","openapi":"GET /v1/subscriber_list/{list_id}/subscriber/","sidebarTitle":"Get list users","href":"/reference/get-list-users"},{"title":"Delete a List","openapi":"PATCH /v1/subscriber_list/{list_id}/delete/","sidebarTitle":"Delete a List","href":"/reference/delete-list"}]},{"group":"BROADCAST","pages":[{"title":"Trigger Broadcast","openapi":"POST /{workspace_key}/broadcast/","sidebarTitle":"Trigger Broadcast","href":"/reference/trigger-broadcast"},{"title":"Cancel Broadcast","openapi":"POST /v1/broadcast_run/cancel/","sidebarTitle":"Cancel Broadcast","href":"/reference/cancel-broadcast"}]}]},{"tab":"Management API","pages":[{"title":"Management API","href":"/docs/management-api-overview"}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/reference/cli-intro"}]},{"tab":"Build with AI","pages":[{"title":"Build with AI","href":"/reference/build-with-ai"}]},{"tab":"Developer Resources","pages":[{"title":"Developer Resources","href":"/docs/developer/overview"}]},{"tab":"Self-Hosted","pages":[{"title":"Self-Hosted","href":"/docs/self-hosted/introduction"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/overview"}]}]},"title":"List Tenants - SuprSend: API-first notification infrastructure","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CT9uE8Ip.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}