{
"error": {
"type": "authentication_error",
"code": "api_key_expired",
"message": "This API key expired on 3 Feb 2027. Create a new one under Settings → API keys.",
"doc_url": "https://docs.indm.social/errors#api_key_expired"
}
}
{
"error": {
"type": "rate_limited",
"code": "rate_limited",
"message": "That's more than 120 requests a minute on one key. Wait 18s and try again.",
"doc_url": "https://docs.indm.social/errors#rate_limited"
}
}
{
"error": {
"type": "api_error",
"code": "internal_error",
"message": "Something went wrong on our end. Try again; if it keeps happening, quote request req_8Qm2ZcY4vN7tLp1K to support@indm.social.",
"doc_url": "https://docs.indm.social/errors#internal_error"
}
}
Workspace
Get the workspace
Returns the workspace this key belongs to, its plan, and the key’s own scope and
expiry. A good first call: if it answers, your key works.
{
"error": {
"type": "authentication_error",
"code": "api_key_expired",
"message": "This API key expired on 3 Feb 2027. Create a new one under Settings → API keys.",
"doc_url": "https://docs.indm.social/errors#api_key_expired"
}
}
{
"error": {
"type": "rate_limited",
"code": "rate_limited",
"message": "That's more than 120 requests a minute on one key. Wait 18s and try again.",
"doc_url": "https://docs.indm.social/errors#rate_limited"
}
}
{
"error": {
"type": "api_error",
"code": "internal_error",
"message": "Something went wrong on our end. Try again; if it keeps happening, quote request req_8Qm2ZcY4vN7tLp1K to support@indm.social.",
"doc_url": "https://docs.indm.social/errors#internal_error"
}
}
An API key from Settings → API keys in the inDM app, sent as
Authorization: Bearer indm_.... Keys belong to one workspace and carry a scope:
read for GET routes and the validate dry run, full for everything. Keep keys on
your server; never ship one to a browser or a mobile app.
The key that made this request. The secret itself is never returned.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"inDM API","description":"Build, launch and read Instagram comment-to-DM automations from your own code.","colors":{"primary":"#B8452B","light":"#E0714F","dark":"#9E3A23"},"logo":{"light":"https://mintcdn.com/in-dm/dZECcUr6LPCo8pKP/logo/light.svg?fit=max\u0026auto=format\u0026n=dZECcUr6LPCo8pKP\u0026q=85\u0026s=930f4fd67b20c66f17a96391df0a7dc1","dark":"https://mintcdn.com/in-dm/dZECcUr6LPCo8pKP/logo/dark.svg?fit=max\u0026auto=format\u0026n=dZECcUr6LPCo8pKP\u0026q=85\u0026s=3d2b9b5785eea8b6502f0ec3e8c8901d","href":"https://indm.social"},"favicon":"https://mintcdn.com/in-dm/dZECcUr6LPCo8pKP/favicon.svg?fit=max\u0026auto=format\u0026n=dZECcUr6LPCo8pKP\u0026q=85\u0026s=b34dc1c87ed2b98febba7fc8b6c687bb","api":{"openapi":"openapi.yaml","playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","javascript","python"]}},"background":{"color":{"light":"#FDFCFC","dark":"#0B0B0A"}},"navbar":{"links":[{"href":"mailto:support@indm.social","label":"Support"}],"primary":{"type":"button","label":"Open inDM","href":"https://app.indm.social"}},"footer":{"socials":{"instagram":"https://www.instagram.com/indm.social","website":"https://indm.social"}},"seo":{"metatags":{"canonical":"https://docs.indm.social"},"indexing":"navigable"},"fonts":{"heading":{"family":"Fraunces","weight":600},"body":{"family":"Hanken Grotesk"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"in-dm","hasAudioNarration":false,"actualSubdomain":"in-dm","customDomains":["docs.indm.social"],"gitSource":{"type":"github","owner":"indm-social","repo":"project-social","deployBranch":"main","contentDirectory":"api-docs","isPrivate":true,"mountPath":"","label":"","_id":"6aec389be2217a8df5084569"},"chroma":{"latestBuiltDeploymentHistoryId":"6aec38b2e2217a8df50847ac","collectionId":"5558e828-a155-4053-ba25-bc656a472b13","liveDeploymentHistoryId":"6aec38b2e2217a8df50847ac","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aec477a754501e0c6b5577b","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"API Reference","count":17},{"language":"default","tag":"Guides","count":11},{"language":"default","tag":"Automations","count":7},{"language":"default","tag":"Working with the API","count":6},{"language":"default","tag":"Accounts","count":5},{"language":"default","tag":"Get started","count":3},{"language":"default","tag":"Media","count":2},{"language":"default","tag":"Recipes","count":2},{"language":"default","tag":"Workspace","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":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":"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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/workspace/get-workspace","slug":"/api-reference/workspace/get-workspace","pageMetadata":{"openapi":"get /workspace","title":"Get the workspace","description":"Returns the workspace this key belongs to, its plan, and the key's own scope and\nexpiry. A good first call: if it answers, your key works.\n\nNeeds a `read` or `full` key.\n","href":"/api-reference/workspace/get-workspace"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Returns the workspace this key belongs to, its plan, and the key’s own scope and\\nexpiry. A good first call: if it answers, your key works.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Needs a \", _jsx(_components.code, {\n children: \"read\"\n }), \" or \", _jsx(_components.code, {\n children: \"full\"\n }), \" key.\"]\n })]\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":{"config":{},"pageMetadata":{"openapi":"get /workspace","title":"Get the workspace","description":"Returns the workspace this key belongs to, its plan, and the key's own scope and\nexpiry. A good first call: if it answers, your key works.\n\nNeeds a `read` or `full` key.\n","href":"/api-reference/workspace/get-workspace"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getWorkspace","tags":["Workspace"],"summary":"Get the workspace","description":"Returns the workspace this key belongs to, its plan, and the key's own scope and\nexpiry. A good first call: if it answers, your key works.\n\nNeeds a `read` or `full` key.\n","x-indm-scope":"read","responses":{"200":"61821a12-bbb9-4334-9491-6b8f188f8f8b","401":"17e8679e-d36a-4b8f-9213-924165d3f2ea","429":"d7b87d31-1f6c-41d1-acb8-8689d916f190","500":"616a7151-066b-4976-9231-e41fe9e677a6"},"method":"get","type":"path","servers":["e5f23c24-da12-4d01-bf2f-38f8531a1e04"],"security":["2f3e715c-04e3-4543-bae9-44e7de536f28"],"path":"/workspace","baseUrlOptions":["https://api.indm.social/v1"],"title":"Get the workspace","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"61821a12-bbb9-4334-9491-6b8f188f8f8b":{"description":"The workspace behind this key.","headers":{"X-Request-Id":{"description":"A unique id for this request. Include it when you write to support and we can find the request at once.","schema":{"type":"string"},"example":"req_8Qm2ZcY4vN7tLp1K"},"RateLimit-Limit":{"description":"Requests this key may make per minute, across every route. Sent once the key is accepted.","schema":{"type":"integer"},"example":120},"RateLimit-Remaining":{"description":"Requests left in the current one-minute window. `0` when a write is refused for the write limit.","schema":{"type":"integer"},"example":117},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"type":"integer"},"example":42}},"content":{"application/json":{"schema":{"type":"object","required":["id","name","plan","key"],"properties":{"id":{"type":"string","format":"uuid","description":"The workspace id.","example":"2c5e8a1b-7f3d-4c9e-b0a2-5d6e7f8a9b0c","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"The workspace's name in inDM.","example":"Maya's Studio","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"plan":{"type":"string","enum":["free","growth"],"description":"The workspace's plan as the API reads it: `growth` for any paid plan, `free`\notherwise. The API works on every plan.\n","example":"growth","isRequired":true,"uniqueKey":"plan","typeLabel":"enum\u003cstring>"},"key":{"type":"object","description":"The key that made this request. The secret itself is never returned.","required":["id","name","scope","prefix","expires_at"],"properties":{"id":{"type":"string","format":"uuid","example":"5e7d9c1b-3a2f-4e6d-8b0c-9a1f2e3d4c5b","isRequired":true,"uniqueKey":"key.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"The name it was given in Settings.","example":"Content calendar sync","isRequired":true,"uniqueKey":"key.name","typeLabel":"string"},"scope":{"type":"string","enum":["read","full"],"description":"`read` covers GET routes and the validate dry run. `full` covers everything.","example":"full","isRequired":true,"uniqueKey":"key.scope","typeLabel":"enum\u003cstring>"},"prefix":{"type":"string","description":"The first characters of the key, to tell keys apart.","example":"indm_7Kq","isRequired":true,"uniqueKey":"key.prefix","typeLabel":"string"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the key stops working. `null` for a key with no expiry.","example":"2027-02-03T09:14:00Z","isRequired":true,"uniqueKey":"key.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the key stops working. `null` for a key with no expiry.","example":"2027-02-03T09:14:00Z","isRequired":true,"uniqueKey":"key.expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"key.expires_at","typeLabel":"string\u003cdate-time> | null"}},"isRequired":true,"uniqueKey":"key","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"2c5e8a1b-7f3d-4c9e-b0a2-5d6e7f8a9b0c","name":"Maya's Studio","plan":"growth","key":{"id":"5e7d9c1b-3a2f-4e6d-8b0c-9a1f2e3d4c5b","name":"Content calendar sync","scope":"full","prefix":"indm_7Kq","expires_at":"2027-02-03T09:14:00Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"17e8679e-d36a-4b8f-9213-924165d3f2ea":{"description":"The API key is missing, malformed, expired or revoked.","headers":{"X-Request-Id":{"description":"A unique id for this request. Include it when you write to support and we can find the request at once.","schema":{"type":"string"},"example":"req_8Qm2ZcY4vN7tLp1K"}},"content":{"application/json":{"schema":{"type":"object","description":"Every error has this shape.","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message","doc_url"],"properties":{"type":{"type":"string","description":"The family of error. Each maps to one HTTP status.","enum":["invalid_request","authentication_error","permission_error","plan_limit","not_found","conflict","rate_limited","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"A stable, specific code. Branch on this, never on `message`. Every code is\nlisted on [Errors](/errors).\n","example":"dm_message_too_long","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A sentence for a person, saying what happened and what to do next. It may change; don't parse it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","format":"uri","description":"A link to this code on the [Errors](/errors) page.","example":"https://docs.indm.social/errors#dm_message_too_long","isRequired":true,"uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"param":{"type":"string","description":"The request field the error is about. Left out when no single field is.","example":"dm_message","uniqueKey":"error.param","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"type":"authentication_error","code":"api_key_expired","message":"This API key expired on 3 Feb 2027. Create a new one under Settings → API keys.","doc_url":"https://docs.indm.social/errors#api_key_expired"}},"examples":{"Example":{"title":"Example","value":{"error":{"type":"authentication_error","code":"api_key_expired","message":"This API key expired on 3 Feb 2027. Create a new one under Settings → API keys.","doc_url":"https://docs.indm.social/errors#api_key_expired"}}}},"exampleType":"examples"}},"exampleType":"examples"},"d7b87d31-1f6c-41d1-acb8-8689d916f190":{"description":"This key went past its rate limit. Wait for `Retry-After` seconds, then try again.","headers":{"X-Request-Id":{"description":"A unique id for this request. Include it when you write to support and we can find the request at once.","schema":{"type":"string"},"example":"req_8Qm2ZcY4vN7tLp1K"},"Retry-After":{"description":"Seconds to wait before trying again.","schema":{"type":"integer"},"example":18},"RateLimit-Limit":{"description":"Requests this key may make per minute, across every route. Sent once the key is accepted.","schema":{"type":"integer"},"example":120},"RateLimit-Remaining":{"description":"Requests left in the current one-minute window. `0` when a write is refused for the write limit.","schema":{"type":"integer"},"example":117},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"type":"integer"},"example":42}},"content":{"application/json":{"schema":{"type":"object","description":"Every error has this shape.","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message","doc_url"],"properties":{"type":{"type":"string","description":"The family of error. Each maps to one HTTP status.","enum":["invalid_request","authentication_error","permission_error","plan_limit","not_found","conflict","rate_limited","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"A stable, specific code. Branch on this, never on `message`. Every code is\nlisted on [Errors](/errors).\n","example":"dm_message_too_long","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A sentence for a person, saying what happened and what to do next. It may change; don't parse it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","format":"uri","description":"A link to this code on the [Errors](/errors) page.","example":"https://docs.indm.social/errors#dm_message_too_long","isRequired":true,"uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"param":{"type":"string","description":"The request field the error is about. Left out when no single field is.","example":"dm_message","uniqueKey":"error.param","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"type":"rate_limited","code":"rate_limited","message":"That's more than 120 requests a minute on one key. Wait 18s and try again.","doc_url":"https://docs.indm.social/errors#rate_limited"}},"examples":{"Example":{"title":"Example","value":{"error":{"type":"rate_limited","code":"rate_limited","message":"That's more than 120 requests a minute on one key. Wait 18s and try again.","doc_url":"https://docs.indm.social/errors#rate_limited"}}}},"exampleType":"examples"}},"exampleType":"examples"},"616a7151-066b-4976-9231-e41fe9e677a6":{"description":"Something failed on our side. Retrying with backoff is safe for reads. The same body\ncomes with `503` when inDM briefly can't reach its database.\n","headers":{"X-Request-Id":{"description":"A unique id for this request. Include it when you write to support and we can find the request at once.","schema":{"type":"string"},"example":"req_8Qm2ZcY4vN7tLp1K"}},"content":{"application/json":{"schema":{"type":"object","description":"Every error has this shape.","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message","doc_url"],"properties":{"type":{"type":"string","description":"The family of error. Each maps to one HTTP status.","enum":["invalid_request","authentication_error","permission_error","plan_limit","not_found","conflict","rate_limited","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"A stable, specific code. Branch on this, never on `message`. Every code is\nlisted on [Errors](/errors).\n","example":"dm_message_too_long","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A sentence for a person, saying what happened and what to do next. It may change; don't parse it.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","format":"uri","description":"A link to this code on the [Errors](/errors) page.","example":"https://docs.indm.social/errors#dm_message_too_long","isRequired":true,"uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"},"param":{"type":"string","description":"The request field the error is about. Left out when no single field is.","example":"dm_message","uniqueKey":"error.param","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"type":"api_error","code":"internal_error","message":"Something went wrong on our end. Try again; if it keeps happening, quote request req_8Qm2ZcY4vN7tLp1K to support@indm.social.","doc_url":"https://docs.indm.social/errors#internal_error"}},"examples":{"Example":{"title":"Example","value":{"error":{"type":"api_error","code":"internal_error","message":"Something went wrong on our end. Try again; if it keeps happening, quote request req_8Qm2ZcY4vN7tLp1K to support@indm.social.","doc_url":"https://docs.indm.social/errors#internal_error"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"2f3e715c-04e3-4543-bae9-44e7de536f28":{"apiKey":{"type":"http","scheme":"bearer","bearerFormat":"indm_ API key","description":"An API key from **Settings → API keys** in the inDM app, sent as\n`Authorization: Bearer indm_...`. Keys belong to one workspace and carry a scope:\n`read` for GET routes and the validate dry run, `full` for everything. Keep keys on\nyour server; never ship one to a browser or a mobile app.\n","scopes":[],"schemeName":"apiKey"}}},"servers":{"e5f23c24-da12-4d01-bf2f-38f8531a1e04":{"url":"https://api.indm.social/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"indm_ API key","description":"An API key from **Settings → API keys** in the inDM app, sent as\n`Authorization: Bearer indm_...`. Keys belong to one workspace and carry a scope:\n`read` for GET routes and the validate dry run, `full` for everything. Keep keys on\nyour server; never ship one to a browser or a mobile app.\n","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key from **Settings → API keys** in the inDM app, sent as\n`Authorization: Bearer indm_...`. Keys belong to one workspace and carry a scope:\n`read` for GET routes and the validate dry run, `full` for everything. Keep keys on\nyour server; never ship one to a browser or a mobile app.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"in-dm","siteName":"inDM API","title":"Get the workspace - inDM API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T08:05:21.791Z","originalFileLocation":"api-reference/workspace/get-workspace.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=\"Returns the workspace this key belongs to, its plan, and the key\u0026#x27;s own scope and expiry. A good first call: if it answers, your key works. Needs a read or full key.\">\u003cmeta data-mint-head name=\"application-name\" content=\"inDM API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/in-dm/Bj_8VlqhxizGMWMU/_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/in-dm/Bj_8VlqhxizGMWMU/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/in-dm/Bj_8VlqhxizGMWMU/_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/in-dm/Bj_8VlqhxizGMWMU/_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/in-dm/Bj_8VlqhxizGMWMU/_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/in-dm/Bj_8VlqhxizGMWMU/_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/in-dm/Bj_8VlqhxizGMWMU/_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/in-dm/Bj_8VlqhxizGMWMU/_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/in-dm/Bj_8VlqhxizGMWMU/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get the workspace - inDM API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the workspace this key belongs to, its plan, and the key\u0026#x27;s own scope and expiry. A good first call: if it answers, your key works. Needs a read or full key.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"inDM API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.indm.social/api-reference/workspace/get-workspace\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://in-dm.mintlify.app/_mintlify/api/og/v2?division=Workspace\u0026amp;title=Get+the+workspace\u0026amp;description=Returns+the+workspace+this+key+belongs+to%2C+its+plan%2C+and+the+key%27s+own+scope+and%0Aexpiry.+A+good+first+call%3A+if+it+answers%2C+your+key+works.%0A%0ANeeds+a+%60read%60+or+%60f\u0026amp;theme=22118b16346918b8b2483116\u0026amp;signature=c91f8786d39456a5bb8a3fb00e7a27620e0e09f977b8a77f0e45bcdf1a0d4f17\">\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 the workspace - inDM API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the workspace this key belongs to, its plan, and the key\u0026#x27;s own scope and expiry. A good first call: if it answers, your key works. Needs a read or full key.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://in-dm.mintlify.app/_mintlify/api/og/v2?division=Workspace\u0026amp;title=Get+the+workspace\u0026amp;description=Returns+the+workspace+this+key+belongs+to%2C+its+plan%2C+and+the+key%27s+own+scope+and%0Aexpiry.+A+good+first+call%3A+if+it+answers%2C+your+key+works.%0A%0ANeeds+a+%60read%60+or+%60f\u0026amp;theme=22118b16346918b8b2483116\u0026amp;signature=c91f8786d39456a5bb8a3fb00e7a27620e0e09f977b8a77f0e45bcdf1a0d4f17\">\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/in-dm/Bj_8VlqhxizGMWMU/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"inDM API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#B8452B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.indm.social/api-reference/workspace/get-workspace\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/workspace/get-workspace.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.indm.social/#organization\",\"name\":\"inDM API\",\"url\":\"https://docs.indm.social\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/in-dm/dZECcUr6LPCo8pKP/logo/light.svg?fit=max\u0026auto=format\u0026n=dZECcUr6LPCo8pKP\u0026q=85\u0026s=930f4fd67b20c66f17a96391df0a7dc1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.indm.social#website\",\"name\":\"inDM API\",\"url\":\"https://docs.indm.social\",\"publisher\":{\"@id\":\"https://docs.indm.social/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.indm.social/api-reference/workspace/get-workspace#webpage\",\"url\":\"https://docs.indm.social/api-reference/workspace/get-workspace\",\"name\":\"Get the workspace\",\"description\":\"Returns the workspace this key belongs to, its plan, and the key's own scope and expiry. A good first call: if it answers, your key works. Needs a read or full key.\",\"dateModified\":\"2026-11-05T08:05:21.791Z\",\"isPartOf\":{\"@id\":\"https://docs.indm.social#website\"},\"breadcrumb\":{\"@id\":\"https://docs.indm.social/api-reference/workspace/get-workspace#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.indm.social/api-reference/workspace/get-workspace#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"inDM API\",\"item\":\"https://docs.indm.social\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get the workspace\",\"item\":\"https://docs.indm.social/api-reference/workspace/get-workspace\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.indm.social/api-reference/workspace/get-workspace#apireference\",\"headline\":\"Get the workspace\",\"name\":\"Get the workspace\",\"description\":\"Returns the workspace this key belongs to, its plan, and the key's own scope and expiry. A good first call: if it answers, your key works. Needs a read or full key.\",\"url\":\"https://docs.indm.social/api-reference/workspace/get-workspace\",\"mainEntityOfPage\":{\"@id\":\"https://docs.indm.social/api-reference/workspace/get-workspace#webpage\"},\"dateModified\":\"2026-11-05T08:05:21.791Z\",\"publisher\":{\"@id\":\"https://docs.indm.social/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.indm.social#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"inDM API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"inDM API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"API reference","sidebarTitle":"Overview","description":"Every endpoint in the inDM API, with a playground to try each one.","href":"/api-reference/introduction"}]},{"group":"Workspace","pages":[{"openapi":"get /workspace","title":"Get the workspace","href":"/api-reference/workspace/get-workspace"}]},{"group":"Accounts","pages":[{"openapi":"get /accounts","title":"List accounts","description":"Every Instagram account connected to the workspace, with its handle, follower count\nand connection status. This is where the `account_id` the other endpoints take\ncomes from.\n\nNeeds a `read` or `full` key.\n","href":"/api-reference/accounts/list-accounts"},{"openapi":"get /accounts/{account_id}","title":"Get an account","href":"/api-reference/accounts/get-account"},{"openapi":"get /accounts/{account_id}/health","title":"Check account health","href":"/api-reference/accounts/get-account-health"},{"openapi":"post /accounts/{account_id}/refresh","title":"Refresh content","href":"/api-reference/accounts/refresh-account"},{"openapi":"get /accounts/{account_id}/refresh/{job_id}","title":"Get a refresh","href":"/api-reference/accounts/get-refresh"}]},{"group":"Media","pages":[{"openapi":"get /media","title":"List media","href":"/api-reference/media/list-media"},{"openapi":"get /media/{media_id}","title":"Get a media item","href":"/api-reference/media/get-media"}]},{"group":"Automations","pages":[{"openapi":"get /automations","title":"List automations","href":"/api-reference/automations/list-automations"},{"openapi":"get /automations/{automation_id}","title":"Get an automation","href":"/api-reference/automations/get-automation"},{"openapi":"post /automations","title":"Create an automation","href":"/api-reference/automations/create-automation"},{"openapi":"patch /automations/{automation_id}","title":"Update an automation","href":"/api-reference/automations/update-automation"},{"openapi":"post /automations/{automation_id}/status","title":"Set automation status","href":"/api-reference/automations/set-automation-status"},{"openapi":"get /automations/{automation_id}/stats","title":"Get automation stats","href":"/api-reference/automations/get-automation-stats"},{"openapi":"post /automations/validate","title":"Validate an automation","href":"/api-reference/automations/validate-automation"}]}]}]},"basePath":"","title":"Get the workspace - inDM API","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}