Get your whole Ringg Space family in one call: the primary’s summary, each Ringg Space’s allocation, members and month-to-date usage, and family totals.
GET
/
workspace
/
sub
Get Ringg Spaces
curl --request GET \ --url https://prod-api.ringg.ai/ca/api/v0/workspace/sub \ --header 'X-API-KEY: <api-key>'
Use it for a tenant dashboard in your own admin tool, to check headroom before allocating concurrency or credit, and to reconcile per-client usage at month end.
family.is_individual_entity tells you the billing mode: true for individual (each Ringg Space has its own wallet or limit), false for common (one pool on the primary). The keys present in family and in each row’s billing depend on it; the response schema below lists them per mode.
usage_this_period is the value of completed calls since the 1st of the current month in the Asia/Kolkata timezone, in the workspace’s billing currency.
Amounts are JSON numbers here (200000.0); the two allocation endpoints return decimal strings.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ringg AI","description":"Build AI agents that make and answer phone calls, talk on your website and chat on WhatsApp, then run them from the Ringg AI dashboard or REST API.","colors":{"primary":"#0A0A0B","light":"#FFFFFF","dark":"#0A0A0B"},"logo":{"light":"https://mintcdn.com/ringgai-0da73d20/ZLVFI55VhZ4gmYrF/logo/light.svg?fit=max\u0026auto=format\u0026n=ZLVFI55VhZ4gmYrF\u0026q=85\u0026s=053f22dbaf5140cd8e5dadb1d4d057cd","dark":"https://mintcdn.com/ringgai-0da73d20/ZLVFI55VhZ4gmYrF/logo/dark.svg?fit=max\u0026auto=format\u0026n=ZLVFI55VhZ4gmYrF\u0026q=85\u0026s=cf9075384ec572e1a19b939d5a8674af","href":"https://www.ringg.ai"},"favicon":"https://mintcdn.com/ringgai-0da73d20/ZLVFI55VhZ4gmYrF/favicon.svg?fit=max\u0026auto=format\u0026n=ZLVFI55VhZ4gmYrF\u0026q=85\u0026s=e612fcf76df43d6468baa340dc3fde50","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","python","javascript"]},"mdx":{"auth":{"method":"key","name":"X-API-KEY"},"server":"https://prod-api.ringg.ai/ca/api/v0"}},"appearance":{"default":"dark"},"background":{"decoration":"grid"},"navbar":{"links":[{"href":"/resources/learn/all-lessons","label":"Learn"},{"href":"mailto:admin@ringg.ai","label":"Contact us"}],"primary":{"type":"button","label":"Dashboard","href":"https://www.ringg.ai/dashboard"}},"footer":{"socials":{"x":"https://x.com/ringg_ai","linkedin":"https://www.linkedin.com/company/ringg","youtube":"https://www.youtube.com/@RinggAI","instagram":"https://www.instagram.com/ringg_ai","discord":"https://discord.gg/YuEnb8Vsca"},"links":[{"header":"For AI agents","items":[{"label":"llms.txt","href":"https://docs.ringg.ai/llms.txt"},{"label":"skill.md","href":"https://docs.ringg.ai/skill.md"},{"label":"OpenAPI spec","href":"https://docs.ringg.ai/api-reference/openapi.json"},{"label":"MCP server","href":"/resources/mcp-server/docs-mcp-server/mcp-for-ai-assistants"}]}]},"search":{"prompt":"Search the docs"},"seo":{"metatags":{"canonical":"https://docs.ringg.ai","og:site_name":"Ringg AI Docs","twitter:site":"@ringg_ai"},"organization":{"id":"https://www.ringg.ai/#organization","legalName":"Stoic AI Private Limited","url":"https://www.ringg.ai","logo":"https://assets.ringg.ai/images/logo/logo.svg","sameAs":["https://x.com/ringg_ai","https://www.linkedin.com/company/ringg","https://www.youtube.com/@RinggAI","https://www.instagram.com/ringg_ai","https://discord.gg/YuEnb8Vsca"]}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","latex":false},"errors":{"404":{"redirect":false,"title":"This page doesn't exist","description":"It may have moved in the docs rebuild. The suggestions below usually have it; otherwise start from [the introduction](/get-started/ringg-ai) or search above."}},"contextual":{"options":["copy","view","chatgpt","claude","mcp","download-spec"],"display":"header"},"markdown":{"instructions":["To search or read these docs, connect the Ringg docs MCP server at https://docs.ringg.ai/mcp (no key needed; tools search_ringg_ai and query_docs_filesystem_ringg_ai) instead of browsing pages one by one. Setup for each client: https://docs.ringg.ai/resources/mcp-server/docs-mcp-server/mcp-for-ai-assistants.md","The dashboard labels agents \"Assistants\"; these docs say \"agent\". Both mean the same object, identified by agent_id.","API base URL: https://prod-api.ringg.ai/ca/api/v0. Send the workspace API key in the X-API-KEY header, from server-side code only.","Placing a call dials a real phone number and spends credits. Confirm the number with the user before calling.","To act on a Ringg workspace (place calls, edit agents, read transcripts), use the separate Ringg workspace MCP server at https://mcp.ringg.ai/mcp: https://docs.ringg.ai/resources/mcp-server/workspace-mcp-server/overview.md"]},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ringgai-0da73d20","hasAudioNarration":false,"actualSubdomain":"ringgai-0da73d20","customDomains":["docs.ringg.ai"],"gitSource":{"type":"github","owner":"stonkr","repo":"ringg-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true,"edits":true,"issues":true},"entitlements":{},"buildId":"6adb52e21a579503f2299e23","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"Documentation","count":90},{"language":"default","tag":"API reference","count":52},{"language":"default","tag":"Build agents","count":37},{"language":"default","tag":"Resources","count":34},{"language":"default","tag":"Learn","count":27},{"language":"default","tag":"Inventory","count":23},{"language":"default","tag":"Deploy","count":22},{"language":"default","tag":"Customize agent behaviour","count":19},{"language":"default","tag":"Agents","count":17},{"language":"default","tag":"Calling","count":15}],"searchSettings":{"showContentSnippets":true,"maxResults":8}},"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}],"privacy":{"consentBanner":{"enabled":false}},"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"img.nav-logo{height:1.375rem!important;width:auto!important}.figure-card{display:flex;flex-direction:column;margin:0.5rem 0;overflow:hidden;border:1px solid rgb(10 10 11 / 0.08);border-radius:1rem;background:#ffffff;text-decoration:none!important;transition:border-color 150ms}.figure-card:hover{border-color:rgb(10 10 11 / 0.2)}.dark .figure-card{border-color:rgb(255 255 255 / 0.08);background:rgb(var(--background-dark))}.dark .figure-card:hover{border-color:rgb(255 255 255 / 0.2)}.figure-card-panel{display:flex;justify-content:center;height:12rem;margin:0.375rem 0.375rem 0;border-radius:0.75rem;-webkit-mask-image:linear-gradient(to bottom, #000 62%, transparent);mask-image:linear-gradient(to bottom, #000 62%, transparent);background:#f6f6f7 url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='384' height='256' fill='none' stroke='%230a0a0b' stroke-opacity='0.03' stroke-width='1.5'%3E%3Ccircle cx='32' cy='32' r='25'/%3E%3Ccircle cx='96' cy='32' r='25'/%3E%3Crect x='135' y='7' width='50' height='50' rx='8'/%3E%3Ccircle cx='224' cy='32' r='25'/%3E%3Ccircle cx='288' cy='32' r='25'/%3E%3Ccircle cx='352' cy='32' r='25'/%3E%3Ccircle cx='32' cy='96' r='25'/%3E%3Ccircle cx='96' cy='96' r='25'/%3E%3Ccircle cx='160' cy='96' r='25'/%3E%3Ccircle cx='224' cy='96' r='25'/%3E%3Ccircle cx='288' cy='96' r='25'/%3E%3Ccircle cx='352' cy='96' r='25'/%3E%3Ccircle cx='32' cy='160' r='25'/%3E%3Crect x='71' y='135' width='50' height='50' rx='8'/%3E%3Ccircle cx='160' cy='160' r='25'/%3E%3Ccircle cx='224' cy='160' r='25'/%3E%3Crect x='263' y='135' width='50' height='50' rx='8'/%3E%3Crect x='327' y='135' width='50' height='50' rx='8'/%3E%3Crect x='7' y='199' width='50' height='50' rx='8'/%3E%3Ccircle cx='96' cy='224' r='25'/%3E%3Crect x='135' y='199' width='50' height='50' rx='8'/%3E%3Ccircle cx='224' cy='224' r='25'/%3E%3Crect x='263' y='199' width='50' height='50' rx='8'/%3E%3Ccircle cx='352' cy='224' r='25'/%3E%3C/svg%3E\") center / 192px 128px}.dark .figure-card-panel{background:#0f0f11 url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='384' height='256' fill='none' stroke='%23ffffff' stroke-opacity='0.025' stroke-width='1.5'%3E%3Ccircle cx='32' cy='32' r='25'/%3E%3Ccircle cx='96' cy='32' r='25'/%3E%3Crect x='135' y='7' width='50' height='50' rx='8'/%3E%3Ccircle cx='224' cy='32' r='25'/%3E%3Ccircle cx='288' cy='32' r='25'/%3E%3Ccircle cx='352' cy='32' r='25'/%3E%3Ccircle cx='32' cy='96' r='25'/%3E%3Ccircle cx='96' cy='96' r='25'/%3E%3Ccircle cx='160' cy='96' r='25'/%3E%3Ccircle cx='224' cy='96' r='25'/%3E%3Ccircle cx='288' cy='96' r='25'/%3E%3Ccircle cx='352' cy='96' r='25'/%3E%3Ccircle cx='32' cy='160' r='25'/%3E%3Crect x='71' y='135' width='50' height='50' rx='8'/%3E%3Ccircle cx='160' cy='160' r='25'/%3E%3Ccircle cx='224' cy='160' r='25'/%3E%3Crect x='263' y='135' width='50' height='50' rx='8'/%3E%3Crect x='327' y='135' width='50' height='50' rx='8'/%3E%3Crect x='7' y='199' width='50' height='50' rx='8'/%3E%3Ccircle cx='96' cy='224' r='25'/%3E%3Crect x='135' y='199' width='50' height='50' rx='8'/%3E%3Ccircle cx='224' cy='224' r='25'/%3E%3Crect x='263' y='199' width='50' height='50' rx='8'/%3E%3Ccircle cx='352' cy='224' r='25'/%3E%3C/svg%3E\") center / 192px 128px}.figure-card-panel{--hairline-plate: #f6f6f7}.dark .figure-card-panel{--hairline-plate: #0f0f11}.figure-card-panel>[data-hairline]{width:13.75rem}.figure-card-text{flex:1;padding:0.25rem 1.25rem 1.25rem}.figure-card-title{font-weight:600;color:rgb(17 24 39)}.dark .figure-card-title{color:rgb(255 255 255)}.figure-card-body{margin-top:0.25rem;font-size:0.9375rem;line-height:1.6;color:rgb(75 85 99)}.dark .figure-card-body{color:rgb(161 161 170)}"}],"page":{"pagePath":"api-reference/account/ringg-spaces/get-sub-workspaces","slug":"/api-reference/account/ringg-spaces/get-sub-workspaces","pageMetadata":{"openapi":"get /workspace/sub","description":"Get your whole Ringg Space family in one call: the primary's summary, each Ringg Space's allocation, members and month-to-date usage, and family totals.","related":[{"Ringg Spaces API overview":"/documentation/manage-account/ringg-spaces/ringg-spaces-by-api#manage-the-family-by-api"}],"title":"Get Ringg Spaces","href":"/api-reference/account/ringg-spaces/get-sub-workspaces"},"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: \"Get your whole Ringg Space family in one call: the primary’s summary, each Ringg Space’s allocation, members and month-to-date usage, and family totals.\"\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];const RelatedTopics=({items})=>{const _components={a:`a`,..._provideComponents()},{Icon}=_components;if(!Icon)_missingMdxReference(`Icon`,true);return _jsxs(`div`,{className:`not-prose mint-mt-12`,children:[_jsx(`div`,{className:`mint-text-sm mint-font-medium mint-text-gray-500 dark:mint-text-zinc-400 mint-mb-3`,children:`Related topics`}),_jsx(`div`,{className:`mint-flex mint-flex-col mint-gap-2.5`,children:items.map(([title,href])=>_jsxs(_components.a,{href,className:`mint-flex mint-items-center mint-gap-2.5 mint-text-sm mint-text-gray-700 hover:mint-text-gray-950 dark:mint-text-zinc-300 dark:hover:mint-text-white`,children:[_jsx(Icon,{icon:`file-text`,size:16,color:`currentColor`}),title]},href))})]})};function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components},{Heading,_MdxComponentBoundary}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Use it for a tenant dashboard in your own admin tool, to check headroom before allocating concurrency or credit, and to reconcile per-client usage at month end.`}),`\n`,_jsx(Heading,{level:`2`,id:`reading-the-response`,children:`Reading the response`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`family.concurrency_available`}),` is what `,_jsx(_components.a,{href:`/api-reference/account/ringg-spaces/allocate-concurrency`,children:`Allocate Concurrency`}),` can still hand out; `,_jsx(_components.code,{children:`family.available_pot`}),` (prepaid) is what `,_jsx(_components.a,{href:`/api-reference/account/ringg-spaces/reallocate-credit-balances`,children:`Reallocate Credit Balances`}),` can still move out of the primary.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`family.is_individual_entity`}),` tells you the billing mode: `,_jsx(_components.code,{children:`true`}),` for individual (each Ringg Space has its own wallet or limit), `,_jsx(_components.code,{children:`false`}),` for common (one pool on the primary). The keys present in `,_jsx(_components.code,{children:`family`}),` and in each row’s `,_jsx(_components.code,{children:`billing`}),` depend on it; the response schema below lists them per mode.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`usage_this_period`}),` is the value of completed calls since the 1st of the current month in the `,_jsx(_components.code,{children:`Asia/Kolkata`}),` timezone, in the workspace’s billing currency.`]}),`\n`,_jsxs(_components.li,{children:[`Amounts are JSON numbers here (`,_jsx(_components.code,{children:`200000.0`}),`); the two allocation endpoints return decimal strings.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`notes`,children:`Notes`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Works on a primary with no Ringg Spaces yet; `,_jsx(_components.code,{children:`sub_workspaces`}),` is then an empty list.`]}),`\n`,_jsx(_components.li,{children:`Archived Ringg Spaces are not listed.`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`400`}),`: `,_jsx(_components.code,{children:`Sub-workspaces cannot have their own sub-workspaces.`}),` — the key belongs to a Ringg Space that has Ringg Spaces enabled.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`401`}),`: Invalid or missing API key.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`403`}),`: `,_jsx(_components.code,{children:`Sub-workspaces are not enabled for this workspace.`}),` — Ringg Spaces are not enabled on the primary, or the key belongs to a Ringg Space.`]}),`\n`]}),`\n`,_jsx(_MdxComponentBoundary,{name:`RelatedTopics`,children:_jsx(RelatedTopics,{items:[[`Ringg Spaces API overview`,`/documentation/manage-account/ringg-spaces/ringg-spaces-by-api#manage-the-family-by-api`]]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{RelatedTopics,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":{"openapi":"get /workspace/sub","description":"Get your whole Ringg Space family in one call: the primary's summary, each Ringg Space's allocation, members and month-to-date usage, and family totals.","related":[{"Ringg Spaces API overview":"/documentation/manage-account/ringg-spaces/ringg-spaces-by-api#manage-the-family-by-api"}],"title":"Get Ringg Spaces","href":"/api-reference/account/ringg-spaces/get-sub-workspaces"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[149,855,")=>null;function _cr"]]},"mdxExtracts":{"tableOfContents":[{"title":"Reading the response","slug":"reading-the-response","depth":2,"children":[]},{"title":"Notes","slug":"notes","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ringgai-0da73d20/45c33e65ef05fabf/hairline.js"],"dynamicCss":".mint-mb-3 {\n margin-bottom: 0.75rem\n}\n.mint-mt-12 {\n margin-top: 3rem\n}\n.mint-flex {\n display: flex\n}\n.mint-flex-col {\n flex-direction: column\n}\n.mint-items-center {\n align-items: center\n}\n.mint-gap-2\\.5 {\n gap: 0.625rem\n}\n.mint-text-sm {\n font-size: 0.875rem;\n line-height: 1.25rem\n}\n.mint-font-medium {\n font-weight: 500\n}\n.mint-text-gray-500 {\n --tw-text-opacity: 1;\n color: rgb(107 114 128 / var(--tw-text-opacity, 1))\n}\n.mint-text-gray-700 {\n --tw-text-opacity: 1;\n color: rgb(55 65 81 / var(--tw-text-opacity, 1))\n}\n.hover\\:mint-text-gray-950:hover {\n --tw-text-opacity: 1;\n color: rgb(3 7 18 / var(--tw-text-opacity, 1))\n}\n.dark\\:mint-text-zinc-300:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(212 212 216 / var(--tw-text-opacity, 1))\n}\n.dark\\:mint-text-zinc-400:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(161 161 170 / var(--tw-text-opacity, 1))\n}\n.dark\\:hover\\:mint-text-white:hover:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(255 255 255 / var(--tw-text-opacity, 1))\n}","openApiReferenceData":{"operation":{"tags":["workspace"],"summary":"Get Ringg Spaces","x-mint":{"metadata":{"og:title":"Get Ringg Spaces | Ringg AI"}},"description":"Get your whole Ringg Space family in one call: the primary's summary, each Ringg Space's allocation, members and month-to-date usage, and family totals.","operationId":"getSubWorkspaces","responses":{"200":"cd1a78bb-bfe4-458e-9d63-f50896c913e3","400":"edbbb51d-fa09-483d-8d33-6db5515bcadb","401":"dd08cba7-759c-45bf-8ef0-9c03b0d6f09d","403":"f1128317-147a-4e52-870d-4e576456f491","500":"5b86bb9e-c393-46fd-b371-e853262abe71"},"method":"get","type":"path","servers":["4e60091d-90fb-4aa4-8774-bd7b6fd296da"],"security":["8d4782e7-e89d-48a8-81fa-302bad6331cd"],"path":"/workspace/sub","baseUrlOptions":["https://prod-api.ringg.ai/ca/api/v0"],"title":"Get Ringg Spaces","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"cd1a78bb-bfe4-458e-9d63-f50896c913e3":{"description":"Successful Response: The family overview.","content":{"application/json":{"schema":{"type":"object","properties":{"primary":{"type":"object","properties":{"id":{"type":"string","example":"00000000-0000-4000-8000-000000000107","uniqueKey":"primary.id","typeLabel":"string"},"name":{"type":"string","example":"Acme Collections HQ","uniqueKey":"primary.name","typeLabel":"string"},"concurrency":{"type":"integer","example":50,"uniqueKey":"primary.concurrency","typeLabel":"integer"},"limit_concurrency":{"type":"integer","example":50,"uniqueKey":"primary.limit_concurrency","typeLabel":"integer"},"member_count":{"type":"integer","description":"Direct members of the primary.","example":4,"uniqueKey":"primary.member_count","typeLabel":"integer"},"billing":{"type":"object","description":"Money block of one workspace. Prepaid: account_type, currency, total_available_credits. Postpaid: account_type, currency, credit_limit, utilized_limit (both null for a sub in a common-billing family, whose charges pool on the primary).","properties":{"account_type":{"type":"string","enum":["prepaid","postpaid"],"example":"postpaid","uniqueKey":"primary.billing.account_type","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","enum":["INR","USD"],"example":"INR","uniqueKey":"primary.billing.currency","typeLabel":"enum\u003cstring>"},"total_available_credits":{"oneOf":[{"type":"number","description":"Prepaid only: the workspace's own wallet.","example":5000,"uniqueKey":"primary.billing.total_available_credits.oneOf.0","typeLabel":"number"},{"type":"null","description":"Prepaid only: the workspace's own wallet.","example":5000,"uniqueKey":"primary.billing.total_available_credits.oneOf.1","typeLabel":"null"}],"uniqueKey":"primary.billing.total_available_credits","typeLabel":"number | null"},"credit_limit":{"oneOf":[{"type":"number","description":"Postpaid only.","example":200000,"uniqueKey":"primary.billing.credit_limit.oneOf.0","typeLabel":"number"},{"type":"null","description":"Postpaid only.","example":200000,"uniqueKey":"primary.billing.credit_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"primary.billing.credit_limit","typeLabel":"number | null"},"utilized_limit":{"oneOf":[{"type":"number","description":"Postpaid only.","example":34210.5,"uniqueKey":"primary.billing.utilized_limit.oneOf.0","typeLabel":"number"},{"type":"null","description":"Postpaid only.","example":34210.5,"uniqueKey":"primary.billing.utilized_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"primary.billing.utilized_limit","typeLabel":"number | null"}},"uniqueKey":"primary.billing","typeLabel":"object"},"usage_this_period":{"type":"number","example":0,"uniqueKey":"primary.usage_this_period","typeLabel":"number"}},"uniqueKey":"primary","typeLabel":"object"},"sub_workspaces":{"type":"array","description":"Active Ringg Spaces, oldest first.","items":{"type":"object","properties":{"id":{"type":"string","example":"00000000-0000-4000-8000-000000000101","uniqueKey":"sub_workspaces.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","example":"Mumbai Collections","uniqueKey":"sub_workspaces.items.[INDEX].name","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","example":"2026-09-01T06:41:12.884312+00:00","uniqueKey":"sub_workspaces.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"concurrency":{"type":"integer","description":"Concurrent calls allocated to this Ringg Space.","example":20,"uniqueKey":"sub_workspaces.items.[INDEX].concurrency","typeLabel":"integer"},"limit_concurrency":{"type":"integer","description":"The Ringg Space's ceiling: its own allocation in an individual-billing family, the family total in a common-billing family.","example":20,"uniqueKey":"sub_workspaces.items.[INDEX].limit_concurrency","typeLabel":"integer"},"member_counts":{"type":"object","properties":{"direct":{"type":"integer","example":2,"uniqueKey":"sub_workspaces.items.[INDEX].member_counts.direct","typeLabel":"integer"},"inherited":{"type":"integer","example":4,"uniqueKey":"sub_workspaces.items.[INDEX].member_counts.inherited","typeLabel":"integer"}},"uniqueKey":"sub_workspaces.items.[INDEX].member_counts","typeLabel":"object"},"billing":{"type":"object","description":"Money block of one workspace. Prepaid: account_type, currency, total_available_credits. Postpaid: account_type, currency, credit_limit, utilized_limit (both null for a sub in a common-billing family, whose charges pool on the primary).","properties":{"account_type":{"type":"string","enum":["prepaid","postpaid"],"example":"postpaid","uniqueKey":"sub_workspaces.items.[INDEX].billing.account_type","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","enum":["INR","USD"],"example":"INR","uniqueKey":"sub_workspaces.items.[INDEX].billing.currency","typeLabel":"enum\u003cstring>"},"total_available_credits":{"oneOf":[{"type":"number","description":"Prepaid only: the workspace's own wallet.","example":5000,"uniqueKey":"sub_workspaces.items.[INDEX].billing.total_available_credits.oneOf.0","typeLabel":"number"},{"type":"null","description":"Prepaid only: the workspace's own wallet.","example":5000,"uniqueKey":"sub_workspaces.items.[INDEX].billing.total_available_credits.oneOf.1","typeLabel":"null"}],"uniqueKey":"sub_workspaces.items.[INDEX].billing.total_available_credits","typeLabel":"number | null"},"credit_limit":{"oneOf":[{"type":"number","description":"Postpaid only.","example":200000,"uniqueKey":"sub_workspaces.items.[INDEX].billing.credit_limit.oneOf.0","typeLabel":"number"},{"type":"null","description":"Postpaid only.","example":200000,"uniqueKey":"sub_workspaces.items.[INDEX].billing.credit_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"sub_workspaces.items.[INDEX].billing.credit_limit","typeLabel":"number | null"},"utilized_limit":{"oneOf":[{"type":"number","description":"Postpaid only.","example":34210.5,"uniqueKey":"sub_workspaces.items.[INDEX].billing.utilized_limit.oneOf.0","typeLabel":"number"},{"type":"null","description":"Postpaid only.","example":34210.5,"uniqueKey":"sub_workspaces.items.[INDEX].billing.utilized_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"sub_workspaces.items.[INDEX].billing.utilized_limit","typeLabel":"number | null"}},"uniqueKey":"sub_workspaces.items.[INDEX].billing","typeLabel":"object"},"usage_this_period":{"type":"number","description":"Charges for completed calls this calendar month (Asia/Kolkata), in the workspace's billing currency.","example":34210.5,"uniqueKey":"sub_workspaces.items.[INDEX].usage_this_period","typeLabel":"number"}},"uniqueKey":"sub_workspaces.items.[INDEX]","typeLabel":"object"},"uniqueKey":"sub_workspaces","typeLabel":"object[]"},"family":{"type":"object","description":"Family totals. Always: the concurrency keys and is_individual_entity. Postpaid families add credit_limit, utilized_total, available_total. Prepaid individual families add available_pot, allocated_balance_total, family_available_total. Prepaid common families add available_pot and family_available_total.","properties":{"concurrency_capacity":{"type":"integer","description":"Concurrent calls the family owns (bought on the primary).","example":50,"uniqueKey":"family.concurrency_capacity","typeLabel":"integer"},"concurrency_allocated":{"type":"integer","description":"Sum of the Ringg Spaces' allocations.","example":20,"uniqueKey":"family.concurrency_allocated","typeLabel":"integer"},"concurrency_available":{"type":"integer","example":30,"uniqueKey":"family.concurrency_available","typeLabel":"integer"},"is_individual_entity":{"type":"boolean","description":"true = individual billing (each sub has its own wallet or limit); false = common billing (one pool on the primary).","example":true,"uniqueKey":"family.is_individual_entity","typeLabel":"boolean"},"credit_limit":{"oneOf":[{"type":"number","description":"Postpaid: the family total.","example":500000,"uniqueKey":"family.credit_limit.oneOf.0","typeLabel":"number"},{"type":"null","description":"Postpaid: the family total.","example":500000,"uniqueKey":"family.credit_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"family.credit_limit","typeLabel":"number | null"},"utilized_total":{"oneOf":[{"type":"number","description":"Postpaid: primary + Ringg Spaces utilized.","example":46710.5,"uniqueKey":"family.utilized_total.oneOf.0","typeLabel":"number"},{"type":"null","description":"Postpaid: primary + Ringg Spaces utilized.","example":46710.5,"uniqueKey":"family.utilized_total.oneOf.1","typeLabel":"null"}],"uniqueKey":"family.utilized_total","typeLabel":"number | null"},"available_total":{"oneOf":[{"type":"number","description":"Postpaid: credit_limit - utilized_total.","example":453289.5,"uniqueKey":"family.available_total.oneOf.0","typeLabel":"number"},{"type":"null","description":"Postpaid: credit_limit - utilized_total.","example":453289.5,"uniqueKey":"family.available_total.oneOf.1","typeLabel":"null"}],"uniqueKey":"family.available_total","typeLabel":"number | null"},"available_pot":{"oneOf":[{"type":"number","description":"Prepaid: the primary's unallocated balance.","example":12000,"uniqueKey":"family.available_pot.oneOf.0","typeLabel":"number"},{"type":"null","description":"Prepaid: the primary's unallocated balance.","example":12000,"uniqueKey":"family.available_pot.oneOf.1","typeLabel":"null"}],"uniqueKey":"family.available_pot","typeLabel":"number | null"},"allocated_balance_total":{"oneOf":[{"type":"number","description":"Prepaid individual: sum of the Ringg Spaces' wallets.","example":8000,"uniqueKey":"family.allocated_balance_total.oneOf.0","typeLabel":"number"},{"type":"null","description":"Prepaid individual: sum of the Ringg Spaces' wallets.","example":8000,"uniqueKey":"family.allocated_balance_total.oneOf.1","typeLabel":"null"}],"uniqueKey":"family.allocated_balance_total","typeLabel":"number | null"},"family_available_total":{"oneOf":[{"type":"number","description":"Prepaid: pot + allocated wallets.","example":20000,"uniqueKey":"family.family_available_total.oneOf.0","typeLabel":"number"},{"type":"null","description":"Prepaid: pot + allocated wallets.","example":20000,"uniqueKey":"family.family_available_total.oneOf.1","typeLabel":"null"}],"uniqueKey":"family.family_available_total","typeLabel":"number | null"}},"uniqueKey":"family","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"primary":{"id":"00000000-0000-4000-8000-000000000107","name":"Acme Collections HQ","concurrency":50,"limit_concurrency":50,"member_count":4,"billing":{"account_type":"postpaid","currency":"INR","credit_limit":500000,"utilized_limit":12500},"usage_this_period":0},"sub_workspaces":[{"id":"00000000-0000-4000-8000-000000000101","name":"Mumbai Collections","created_at":"2026-09-01T06:41:12.884312+00:00","concurrency":20,"limit_concurrency":20,"member_counts":{"direct":2,"inherited":4},"billing":{"account_type":"postpaid","currency":"INR","credit_limit":200000,"utilized_limit":34210.5},"usage_this_period":34210.5}],"family":{"concurrency_capacity":50,"concurrency_allocated":20,"concurrency_available":30,"is_individual_entity":true,"credit_limit":500000,"utilized_total":46710.5,"available_total":453289.5}},"examples":{"Example":{"title":"Example","value":{"primary":{"id":"00000000-0000-4000-8000-000000000107","name":"Acme Collections HQ","concurrency":50,"limit_concurrency":50,"member_count":4,"billing":{"account_type":"postpaid","currency":"INR","credit_limit":500000,"utilized_limit":12500},"usage_this_period":0},"sub_workspaces":[{"id":"00000000-0000-4000-8000-000000000101","name":"Mumbai Collections","created_at":"2026-09-01T06:41:12.884312+00:00","concurrency":20,"limit_concurrency":20,"member_counts":{"direct":2,"inherited":4},"billing":{"account_type":"postpaid","currency":"INR","credit_limit":200000,"utilized_limit":34210.5},"usage_this_period":34210.5}],"family":{"concurrency_capacity":50,"concurrency_allocated":20,"concurrency_available":30,"is_individual_entity":true,"credit_limit":500000,"utilized_total":46710.5,"available_total":453289.5}}}},"exampleType":"examples"}},"exampleType":"examples"},"edbbb51d-fa09-483d-8d33-6db5515bcadb":{"description":"Bad Request - The API key belongs to a Ringg Space that has Ringg Spaces enabled.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Sub-workspaces cannot have their own sub-workspaces.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Sub-workspaces cannot have their own sub-workspaces."}}},"exampleType":"generated"}},"exampleType":"generated"},"dd08cba7-759c-45bf-8ef0-9c03b0d6f09d":{"description":"Unauthorized - Invalid or missing API key.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Invalid credentials","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Invalid credentials"}}},"exampleType":"generated"}},"exampleType":"generated"},"f1128317-147a-4e52-870d-4e576456f491":{"description":"Forbidden - Ringg Spaces are not enabled for this workspace (also what a Ringg Space's own key gets), or the caller is not an active member of the primary.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Sub-workspaces are not enabled for this workspace.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Sub-workspaces are not enabled for this workspace."}}},"exampleType":"generated"}},"exampleType":"generated"},"5b86bb9e-c393-46fd-b371-e853262abe71":{"description":"Internal Server Error - Something went wrong on our end.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"An unexpected error occurred. Please try again later.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"An unexpected error occurred. Please try again later."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"8d4782e7-e89d-48a8-81fa-302bad6331cd":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"4e60091d-90fb-4aa4-8774-bd7b6fd296da":{"url":"https://prod-api.ringg.ai/ca/api/v0"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-KEY","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-API-KEY","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-KEY"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"ringgai-0da73d20","siteName":"Ringg AI","title":"Get Ringg Spaces - Ringg AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-13T11:53:26.753Z","originalFileLocation":"api-reference/account/ringg-spaces/get-sub-workspaces.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=\"dark\"}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=\"Get your whole Ringg Space family in one call: the primary\u0026#x27;s summary, each Ringg Space\u0026#x27;s allocation, members and month-to-date usage, and family totals.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ringg AI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ringgai-0da73d20/p7P0VdTXwvUPgoLE/_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/ringgai-0da73d20/p7P0VdTXwvUPgoLE/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ringgai-0da73d20/p7P0VdTXwvUPgoLE/_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/ringgai-0da73d20/p7P0VdTXwvUPgoLE/_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/ringgai-0da73d20/p7P0VdTXwvUPgoLE/_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/ringgai-0da73d20/p7P0VdTXwvUPgoLE/_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/ringgai-0da73d20/p7P0VdTXwvUPgoLE/_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/ringgai-0da73d20/p7P0VdTXwvUPgoLE/_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/ringgai-0da73d20/p7P0VdTXwvUPgoLE/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Ringg Spaces - Ringg AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get your whole Ringg Space family in one call: the primary\u0026#x27;s summary, each Ringg Space\u0026#x27;s allocation, members and month-to-date usage, and family totals.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ringg AI Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ringg.ai/api-reference/account/ringg-spaces/get-sub-workspaces\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ringgai-0da73d20.mintlify.site/_mintlify/api/og/v2?division=Ringg+Spaces\u0026amp;title=Get+Ringg+Spaces\u0026amp;description=Get+your+whole+Ringg+Space+family+in+one+call%3A+the+primary%27s+summary%2C+each+Ringg+Space%27s+allocation%2C+members+and+month-to-date+usage%2C+and+family+totals.\u0026amp;theme=737b8671029ef070100737b1\u0026amp;signature=d8d00bcb7b762921105ad9b52933898ef32c331fef16b23a408a26c1936c34cf\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Ringg Spaces - Ringg AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get your whole Ringg Space family in one call: the primary\u0026#x27;s summary, each Ringg Space\u0026#x27;s allocation, members and month-to-date usage, and family totals.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ringgai-0da73d20.mintlify.site/_mintlify/api/og/v2?division=Ringg+Spaces\u0026amp;title=Get+Ringg+Spaces\u0026amp;description=Get+your+whole+Ringg+Space+family+in+one+call%3A+the+primary%27s+summary%2C+each+Ringg+Space%27s+allocation%2C+members+and+month-to-date+usage%2C+and+family+totals.\u0026amp;theme=737b8671029ef070100737b1\u0026amp;signature=d8d00bcb7b762921105ad9b52933898ef32c331fef16b23a408a26c1936c34cf\">\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/ringgai-0da73d20/p7P0VdTXwvUPgoLE/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ringg AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0A0A0B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ringg.ai/api-reference/account/ringg-spaces/get-sub-workspaces\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/account/ringg-spaces/get-sub-workspaces.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.ringg.ai/#organization\",\"name\":\"Ringg AI\",\"legalName\":\"Stoic AI Private Limited\",\"url\":\"https://www.ringg.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://assets.ringg.ai/images/logo/logo.svg\"},\"sameAs\":[\"https://x.com/ringg_ai\",\"https://www.linkedin.com/company/ringg\",\"https://www.youtube.com/@RinggAI\",\"https://www.instagram.com/ringg_ai\",\"https://discord.gg/YuEnb8Vsca\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ringg.ai#website\",\"name\":\"Ringg AI\",\"url\":\"https://docs.ringg.ai\",\"publisher\":{\"@id\":\"https://www.ringg.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ringg.ai/api-reference/account/ringg-spaces/get-sub-workspaces#webpage\",\"url\":\"https://docs.ringg.ai/api-reference/account/ringg-spaces/get-sub-workspaces\",\"name\":\"Get Ringg Spaces\",\"description\":\"Get your whole Ringg Space family in one call: the primary's summary, each Ringg Space's allocation, members and month-to-date usage, and family totals.\",\"dateModified\":\"2026-10-13T11:53:26.753Z\",\"isPartOf\":{\"@id\":\"https://docs.ringg.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ringg.ai/api-reference/account/ringg-spaces/get-sub-workspaces#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ringg.ai/api-reference/account/ringg-spaces/get-sub-workspaces#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Account\",\"item\":\"https://docs.ringg.ai/api-reference/account/get-workspace-info\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Ringg Spaces\",\"item\":\"https://docs.ringg.ai/api-reference/account/ringg-spaces/create-sub-workspace\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Ringg Spaces\",\"item\":\"https://docs.ringg.ai/api-reference/account/ringg-spaces/get-sub-workspaces\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ringg.ai/api-reference/account/ringg-spaces/get-sub-workspaces#apireference\",\"headline\":\"Get Ringg Spaces\",\"name\":\"Get Ringg Spaces\",\"description\":\"Get your whole Ringg Space family in one call: the primary's summary, each Ringg Space's allocation, members and month-to-date usage, and family totals.\",\"url\":\"https://docs.ringg.ai/api-reference/account/ringg-spaces/get-sub-workspaces\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ringg.ai/api-reference/account/ringg-spaces/get-sub-workspaces#webpage\"},\"dateModified\":\"2026-10-13T11:53:26.753Z\",\"publisher\":{\"@id\":\"https://www.ringg.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ringg.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ringg AI\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Ringg AI\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/account/ringg-spaces/get-sub-workspaces.md","siteName":"Ringg AI","nav":{"global":null,"tabs":[{"tab":"Get started","pages":[{"title":"Get started","href":"/get-started/introduction"}]},{"tab":"Documentation","pages":[{"title":"Documentation","href":"/documentation/introduction"}]},{"tab":"Analytics platform","pages":[{"title":"Analytics platform","href":"/analytics-platform/introduction"}]},{"tab":"API reference","groups":[{"group":"Introduction","icon":"book-open","pages":[{"title":"API quickstart","sidebarTitle":"Quickstart","href":"/api-reference/introduction/quickstart"},{"title":"Authentication","href":"/api-reference/introduction/authentication"},{"title":"API Overview","href":"/api-reference/introduction/api-overview"}]},{"group":"Agents","icon":"bot","pages":[{"openapi":"get /agent/all","title":"List Agents","href":"/api-reference/agents/get-assistants"},{"openapi":"get /agent/{agent_id}","title":"Get Agent","href":"/api-reference/agents/get-assistant-by-id"},{"openapi":"post /public/agent","title":"Create Agent","href":"/api-reference/agents/create-agent"},{"openapi":"patch /agent/v1","title":"Edit Agent Settings","href":"/api-reference/agents/edit-assistant"},{"openapi":"get /agent/voices","title":"List Voices","href":"/api-reference/agents/get-assistant-voices"}]},{"group":"Inventory","icon":"package","pages":[{"group":"Knowledge bases","expanded":true,"pages":[{"openapi":"post /external/kb","title":"Create Knowledge Base","href":"/api-reference/inventory/knowledge-bases/create-knowledge-base"},{"openapi":"get /external/kb/all","title":"Get All Knowledge Bases","href":"/api-reference/inventory/knowledge-bases/get-all-knowledge-bases"},{"openapi":"get /external/kb/{kb_id}","title":"Get Knowledge Base by ID","href":"/api-reference/inventory/knowledge-bases/get-knowledge-base-by-id"},{"openapi":"patch /external/kb","title":"Edit Knowledge Base","href":"/api-reference/inventory/knowledge-bases/edit-knowledge-base"},{"openapi":"delete /external/kb/{kb_id}","title":"Delete Knowledge Base","href":"/api-reference/inventory/knowledge-bases/delete-knowledge-base"}]},{"group":"Numbers","expanded":true,"pages":[{"openapi":"get /workspace/numbers","title":"Get Workspace Numbers","href":"/api-reference/inventory/numbers/get-workspace-numbers"}]}]},{"group":"Calling","icon":"phone","pages":[{"group":"Individual calls","expanded":true,"pages":[{"openapi":"post /calling/outbound/individual","title":"Initiate Individual Call","href":"/api-reference/calling/individual-calls/initiate-individual-call"},{"openapi":"post /calling/v2/outbound/individual","title":"Initiate Individual Call (Number Pool)","href":"/api-reference/calling/individual-calls/initiate-individual-call-v2"},{"title":"Terminate Calls by Call IDs","sidebarTitle":"Stop calls by ID","api":"PATCH /campaign/terminate","href":"/api-reference/calling/individual-calls/stop-calls-by-id"},{"title":"Terminate Calls by Numbers","sidebarTitle":"Stop calls to numbers","api":"PATCH /campaign/terminate","href":"/api-reference/calling/individual-calls/stop-calls-to-numbers"},{"title":"Terminate All Calls by Agent ID","sidebarTitle":"Stop an agent's calls","api":"PATCH /campaign/terminate","href":"/api-reference/calling/individual-calls/stop-agent-calls"}]},{"group":"Campaigns","expanded":true,"pages":[{"openapi":"post /campaign/save","title":"Upload Campaign Contact List","href":"/api-reference/calling/campaigns/upload-campaign-contact-list"},{"openapi":"post /campaign/start","title":"Start Campaign","href":"/api-reference/calling/campaigns/start-campaign"},{"openapi":"post /campaign/v2/start","title":"Start Campaign (Number Pool)","href":"/api-reference/calling/campaigns/start-campaign-v2"},{"openapi":"get /campaign/all","title":"Get All Campaigns","href":"/api-reference/calling/campaigns/get-all-campaigns"},{"title":"Terminate Calls by Campaign ID","sidebarTitle":"Stop a campaign","api":"PATCH /campaign/terminate","href":"/api-reference/calling/campaigns/stop-campaign"},{"title":"Terminate Calls by Campaign Numbers","sidebarTitle":"Stop numbers in a campaign","api":"PATCH /campaign/terminate","href":"/api-reference/calling/campaigns/stop-campaign-numbers"}]},{"group":"Large campaigns","tag":"BETA","expanded":true,"pages":[{"title":"Upload large campaign CSV (Beta)","openapi":"post /campaign/upload-csv","href":"/api-reference/calling/large-campaigns/upload-large-campaign-csv"},{"title":"Get large campaign upload status (Beta)","openapi":"get /campaign/upload-status/{bulk_list_id}","href":"/api-reference/calling/large-campaigns/get-large-campaign-upload-status"},{"title":"Check large campaign balance (Beta)","openapi":"post /campaign/check-balance/{bulk_list_id}","href":"/api-reference/calling/large-campaigns/check-large-campaign-balance"},{"title":"Make large campaign calls async (Beta)","openapi":"post /campaign/make-call-async","href":"/api-reference/calling/large-campaigns/make-large-campaign-calls-async"}]}]},{"group":"Monitoring","icon":"chart-column","pages":[{"group":"Call history","expanded":true,"pages":[{"openapi":"get /calling/history","title":"Get Call History","href":"/api-reference/monitoring/call-history/get-call-history"},{"openapi":"get /calling/call-details","title":"Get Call Details","href":"/api-reference/monitoring/call-history/get-call-details"},{"openapi":"post /calling/history/download","title":"Download Call History","href":"/api-reference/monitoring/call-history/download-call-history"}]},{"group":"Analytics","tag":"NEW","expanded":true,"pages":[{"openapi":"get /analytics/v4/volume-graph","title":"Get Volume Analytics","href":"/api-reference/monitoring/analytics/get-volume-analytics"},{"openapi":"get /analytics/v4/connectivity","title":"Get Connectivity Analytics","href":"/api-reference/monitoring/analytics/get-connectivity-analytics"},{"openapi":"get /analytics/v4/agent-performance","title":"Get Agent Performance","href":"/api-reference/monitoring/analytics/get-agent-performance"},{"openapi":"get /analytics/v4/latency-trend","title":"Get Latency Trend","href":"/api-reference/monitoring/analytics/get-latency-trend"},{"openapi":"get /analytics/v4/concurrency-trend","title":"Get Concurrency Trend","href":"/api-reference/monitoring/analytics/get-concurrency-trend"},{"openapi":"get /analytics/v4/cohort/dimensions","title":"Get Cohort Dimensions","href":"/api-reference/monitoring/analytics/get-cohort-dimensions"},{"openapi":"get /analytics/v4/cohort/values","title":"Get Cohort Values","href":"/api-reference/monitoring/analytics/get-cohort-values"},{"openapi":"get /analytics/v4/cohort/breakdown","title":"Get Cohort Breakdown","href":"/api-reference/monitoring/analytics/get-cohort-breakdown"},{"openapi":"get /analytics/v4/campaigns","title":"Get Active Campaigns","href":"/api-reference/monitoring/analytics/get-active-campaigns"},{"openapi":"get /analytics/v4/data-freshness","title":"Get Data Freshness","href":"/api-reference/monitoring/analytics/get-data-freshness"},{"openapi":"get /analytics/v4/chat-analytics","title":"Get Chat Analytics","href":"/api-reference/monitoring/analytics/get-chat-analytics"}]}]},{"group":"Account","icon":"settings","pages":[{"openapi":"get /workspace","title":"Get Workspace Info","href":"/api-reference/account/get-workspace-info"},{"openapi":"get /workspace/users","title":"List Workspace Users","href":"/api-reference/account/list-workspace-users"},{"openapi":"get /workspace/all","title":"Get All User Workspaces","href":"/api-reference/account/get-all-user-workspaces"},{"group":"Ringg Spaces","expanded":true,"pages":[{"openapi":"post /workspace/sub","description":"Create a Ringg Space under your primary workspace with one API call; it starts with no balance, concurrency or API key until you allocate to it.","title":"Create Ringg Space","href":"/api-reference/account/ringg-spaces/create-sub-workspace"},{"openapi":"get /workspace/sub","title":"Get Ringg Spaces","href":"/api-reference/account/ringg-spaces/get-sub-workspaces"},{"openapi":"get /workspace/sub/members","description":"List everyone with access to your Ringg Space family, whether they inherit access from the primary or were added to one Ringg Space, with permissions.","title":"List Family Members","href":"/api-reference/account/ringg-spaces/list-family-members"},{"openapi":"patch /workspace/sub/{sub_workspace_id}/concurrency","title":"Allocate Concurrency to a Ringg Space","href":"/api-reference/account/ringg-spaces/allocate-concurrency"},{"openapi":"patch /workspace/sub/credit-limits","title":"Reallocate Credit Limits","href":"/api-reference/account/ringg-spaces/reallocate-credit-limits"},{"openapi":"patch /workspace/sub/credit-balances","title":"Reallocate Credit Balances","href":"/api-reference/account/ringg-spaces/reallocate-credit-balances"}]}]}]},{"tab":"Resources","menu":[{"item":"MCP server","description":"Let Claude, ChatGPT or Cursor work in your workspace, or search these docs","pages":[{"title":"MCP server","href":"/resources/mcp-server/docs-mcp-server/mcp-for-ai-assistants"}]},{"item":"Learn","description":"Lessons that build a payment-reminder system end to end","pages":[{"title":"Learn","href":"/resources/learn/all-lessons"}]},{"item":"Security","description":"How Ringg protects your data, and what to do on your side","pages":[{"title":"Security","href":"/resources/security/security"}]},{"item":"Changelog","description":"New features, API changes and new guides","pages":[{"title":"Changelog","href":"/resources/changelog/changelog"}]}],"pages":[{"title":"Resources","href":"/resources/mcp-server/docs-mcp-server/mcp-for-ai-assistants"}]}]},"basePath":"","title":"Get Ringg Spaces - Ringg AI","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"]}