{
"defined": true,
"code": "BAD_REQUEST",
"status": 400,
"message": "Invalid request parameters. Check the request body and query parameters. See https://docs.userplane.io/api/error-handling",
"data": "<unknown>"
}
{
"defined": true,
"code": "API_KEY_REQUIRED",
"status": 401,
"message": "API key is required. Include it as Authorization: Bearer <your-api-key>. See https://docs.userplane.io/api/authentication",
"data": "<unknown>"
}
{
"defined": true,
"code": "API_KEY_DISABLED",
"status": 403,
"message": "The API key is disabled. Enable it or create a new key. See https://docs.userplane.io/api/authentication",
"data": "<unknown>"
}
{
"defined": true,
"code": "BAD_REQUEST",
"status": 400,
"message": "Invalid request parameters. Check the request body and query parameters. See https://docs.userplane.io/api/error-handling",
"data": "<unknown>"
}
{
"defined": true,
"code": "API_KEY_REQUIRED",
"status": 401,
"message": "API key is required. Include it as Authorization: Bearer <your-api-key>. See https://docs.userplane.io/api/authentication",
"data": "<unknown>"
}
{
"defined": true,
"code": "API_KEY_DISABLED",
"status": 403,
"message": "The API key is disabled. Enable it or create a new key. See https://docs.userplane.io/api/authentication",
"data": "<unknown>"
}
API key with uspl_ prefix. Create keys at dash.userplane.io/_/account?tab=developers
Path Parameters
workspaceId
string
required
Minimum string length: 1
Response
OK
message
string
required
data
object
required
Show child attributes
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Userplane Docs","colors":{"primary":"#000000","light":"#FAFAFA","dark":"#000000"},"logo":{"light":"https://mintcdn.com/userplane/e34bWffW8FdiqmQz/static/logo-light.svg?fit=max\u0026auto=format\u0026n=e34bWffW8FdiqmQz\u0026q=85\u0026s=b60f979b7800d446f3f5d5274c095cb2","dark":"https://mintcdn.com/userplane/e34bWffW8FdiqmQz/static/logo-dark.svg?fit=max\u0026auto=format\u0026n=e34bWffW8FdiqmQz\u0026q=85\u0026s=f638b932d019423317aaca6685f22ea6"},"favicon":"https://mintcdn.com/userplane/e34bWffW8FdiqmQz/static/favicon.svg?fit=max\u0026auto=format\u0026n=e34bWffW8FdiqmQz\u0026q=85\u0026s=fd9fbcc5e1783343c767381ce1744d03","api":{"playground":{"display":"interactive"}},"appearance":{"default":"light","strict":true},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://dash.userplane.io"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"userplane","hasAudioNarration":false,"actualSubdomain":"userplane","customDomains":["docs.userplane.io"],"gitSource":{"type":"github","owner":"0xnyn","repo":"userplane","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae9479ba0daa1d41e011a0f:success","clientVersion":"0.0.4149","searchFilterCounts":[{"language":"default","tag":"Integrations","count":62},{"language":"default","tag":"Guide","count":47},{"language":"default","tag":"Extensions \u0026 Plugins","count":34},{"language":"default","tag":"API","count":28},{"language":"default","tag":"Developer","count":24},{"language":"default","tag":"Recordings","count":21},{"language":"default","tag":"Help Desk","count":16},{"language":"default","tag":"Claude Code","count":14},{"language":"default","tag":"Framework Guides","count":13},{"language":"default","tag":"Getting Started","count":12}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api/workspaces/get-invite-url","slug":"/api/workspaces/get-invite-url","pageMetadata":{"title":"Get Invite URL","description":"Retrieve the invite URL for a workspace","openapi":"GET /public/workspace/{workspaceId}/invite-url","href":"/api/workspaces/get-invite-url"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve the invite URL for a workspace\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Card,CardGroup,Heading,Table}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Returns the invite URL for a workspace. Requires the authenticated user to be an active member of the workspace.`}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Error code`}),_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Description`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`WORKSPACE_NOT_FOUND`})}),_jsx(_components.td,{\"data-numeric\":`true`,children:`404`}),_jsx(_components.td,{children:`Workspace does not exist`})]})})]}),`\n`,_jsxs(_components.p,{children:[`Also returns `,_jsx(_components.a,{href:`/api/error-handling#authentication-errors`,children:`common authentication errors`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`related`,children:`Related`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Get Workspace`,icon:`building`,href:`/api/workspaces/get-workspace`,children:_jsx(_components.p,{children:`Retrieve workspace details`})}),_jsx(Card,{title:`List Workspaces`,icon:`list`,href:`/api/workspaces/list-workspaces`,children:_jsx(_components.p,{children:`List all workspaces you belong to`})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Invite URL","description":"Retrieve the invite URL for a workspace","openapi":"GET /public/workspace/{workspaceId}/invite-url","href":"/api/workspaces/get-invite-url"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Errors","slug":"errors","depth":2,"children":[]},{"title":"Related","slug":"related","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/userplane/95cb985acf23057a/eslint.config.js"],"openApiReferenceData":{"operation":{"operationId":"workspace.inviteUrl","summary":"Get invite URL","description":"Retrieve the invite URL for a workspace","tags":["Workspace"],"parameters":["7e5099c2-7fbe-4557-8a2f-80a65dd0fa93"],"responses":{"200":"43a66a62-b4da-43f6-9ca4-2bc98df956c9","400":"346c67bd-dd47-425f-a5c8-e1efe40690a8","401":"e6963c6b-b1c9-4a73-8aeb-c9b1d6d69b62","403":"a80917a5-f276-4c86-9ed9-2d62dd524633","404":"bf6bfcbe-bc19-468c-8f14-b9b2b3b89a17","410":"3273ddde-ff88-4781-9866-dfe6ee4498a2","429":"2c7d9d92-c1a8-4943-997d-b74119fffc4a","503":"56d06695-0f67-4d4b-b7b5-06c1143b2f72"},"method":"get","type":"path","servers":["f004a4eb-fff3-4354-bafd-11db31f94f3c"],"security":["4bfd8b8b-4344-4682-8b3a-dddb2e5ed7f5"],"path":"/public/workspace/{workspaceId}/invite-url","baseUrlOptions":["https://api.userplane.io/api/v1"],"title":"Get invite URL","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"7e5099c2-7fbe-4557-8a2f-80a65dd0fa93":{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"43a66a62-b4da-43f6-9ca4-2bc98df956c9":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","properties":{"inviteUrl":{"type":"string","isRequired":true,"uniqueKey":"data.inviteUrl","typeLabel":"string"},"workspaceId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"data.workspaceId","typeLabel":"string"}},"required":["inviteUrl","workspaceId"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["message","data"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","data":{"inviteUrl":"\u003cstring>","workspaceId":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"346c67bd-dd47-425f-a5c8-e1efe40690a8":{"description":"400","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["defined","code","status","message"],"properties":{"defined":{"const":true,"isRequired":true,"uniqueKey":"oneOf.0.defined","typeLabel":"any"},"code":{"const":"BAD_REQUEST","isRequired":true,"uniqueKey":"oneOf.0.code","typeLabel":"any"},"status":{"const":400,"isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"any"},"message":{"type":"string","default":"Invalid request parameters. Check the request body and query parameters. See https://docs.userplane.io/api/error-handling","isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"string"},"data":{"oneOf":[{}],"uniqueKey":"oneOf.0.data","typeLabel":"any"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["defined","code","status","message"],"properties":{"defined":{"const":false,"isRequired":true,"uniqueKey":"oneOf.1.defined","typeLabel":"any"},"code":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.code","typeLabel":"string"},"status":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"number"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.message","typeLabel":"string"},"data":{"oneOf":[{}],"uniqueKey":"oneOf.1.data","typeLabel":"any"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"defined":true,"code":"BAD_REQUEST","status":400,"message":"Invalid request parameters. Check the request body and query parameters. See https://docs.userplane.io/api/error-handling","data":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"},"e6963c6b-b1c9-4a73-8aeb-c9b1d6d69b62":{"description":"401","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["defined","code","status","message"],"properties":{"defined":{"const":true,"isRequired":true,"uniqueKey":"oneOf.0.defined","typeLabel":"any"},"code":{"const":"API_KEY_REQUIRED","isRequired":true,"uniqueKey":"oneOf.0.code","typeLabel":"any"},"status":{"const":401,"isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"any"},"message":{"type":"string","default":"API key is required. Include it as Authorization: Bearer \u003cyour-api-key>. See https://docs.userplane.io/api/authentication","isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"string"},"data":{"oneOf":[{}],"uniqueKey":"oneOf.0.data","typeLabel":"any"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["defined","code","status","message"],"properties":{"defined":{"const":true,"isRequired":true,"uniqueKey":"oneOf.1.defined","typeLabel":"any"},"code":{"const":"API_KEY_INVALID","isRequired":true,"uniqueKey":"oneOf.1.code","typeLabel":"any"},"status":{"const":401,"isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"any"},"message":{"type":"string","default":"The provided API key is not valid. Verify the key and try again. See https://docs.userplane.io/api/authentication","isRequired":true,"uniqueKey":"oneOf.1.message","typeLabel":"string"},"data":{"oneOf":[{}],"uniqueKey":"oneOf.1.data","typeLabel":"any"}},"uniqueKey":"oneOf.1","typeLabel":"object"},{"type":"object","required":["defined","code","status","message"],"properties":{"defined":{"const":true,"isRequired":true,"uniqueKey":"oneOf.2.defined","typeLabel":"any"},"code":{"const":"API_KEY_EXPIRED","isRequired":true,"uniqueKey":"oneOf.2.code","typeLabel":"any"},"status":{"const":401,"isRequired":true,"uniqueKey":"oneOf.2.status","typeLabel":"any"},"message":{"type":"string","default":"The API key has expired. Rotate or create a new key. See https://docs.userplane.io/api/authentication","isRequired":true,"uniqueKey":"oneOf.2.message","typeLabel":"string"},"data":{"oneOf":[{}],"uniqueKey":"oneOf.2.data","typeLabel":"any"}},"uniqueKey":"oneOf.2","typeLabel":"object"},{"type":"object","required":["defined","code","status","message"],"properties":{"defined":{"const":false,"isRequired":true,"uniqueKey":"oneOf.3.defined","typeLabel":"any"},"code":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.code","typeLabel":"string"},"status":{"type":"number","isRequired":true,"uniqueKey":"oneOf.3.status","typeLabel":"number"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.3.message","typeLabel":"string"},"data":{"oneOf":[{}],"uniqueKey":"oneOf.3.data","typeLabel":"any"}},"uniqueKey":"oneOf.3","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"defined":true,"code":"API_KEY_REQUIRED","status":401,"message":"API key is required. Include it as Authorization: Bearer \u003cyour-api-key>. See https://docs.userplane.io/api/authentication","data":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"},"a80917a5-f276-4c86-9ed9-2d62dd524633":{"description":"403","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["defined","code","status","message"],"properties":{"defined":{"const":true,"isRequired":true,"uniqueKey":"oneOf.0.defined","typeLabel":"any"},"code":{"const":"API_KEY_DISABLED","isRequired":true,"uniqueKey":"oneOf.0.code","typeLabel":"any"},"status":{"const":403,"isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"any"},"message":{"type":"string","default":"The API key is disabled. Enable it or create a new key. See https://docs.userplane.io/api/authentication","isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"string"},"data":{"oneOf":[{}],"uniqueKey":"oneOf.0.data","typeLabel":"any"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["defined","code","status","message"],"properties":{"defined":{"const":true,"isRequired":true,"uniqueKey":"oneOf.1.defined","typeLabel":"any"},"code":{"const":"NOT_A_MEMBER","isRequired":true,"uniqueKey":"oneOf.1.code","typeLabel":"any"},"status":{"const":403,"isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"any"},"message":{"type":"string","default":"The API key owner is not a member of this workspace. See https://docs.userplane.io/api/error-handling","isRequired":true,"uniqueKey":"oneOf.1.message","typeLabel":"string"},"data":{"oneOf":[{}],"uniqueKey":"oneOf.1.data","typeLabel":"any"}},"uniqueKey":"oneOf.1","typeLabel":"object"},{"type":"object","required":["defined","code","status","message"],"properties":{"defined":{"const":false,"isRequired":true,"uniqueKey":"oneOf.2.defined","typeLabel":"any"},"code":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.code","typeLabel":"string"},"status":{"type":"number","isRequired":true,"uniqueKey":"oneOf.2.status","typeLabel":"number"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.message","typeLabel":"string"},"data":{"oneOf":[{}],"uniqueKey":"oneOf.2.data","typeLabel":"any"}},"uniqueKey":"oneOf.2","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"defined":true,"code":"API_KEY_DISABLED","status":403,"message":"The API key is disabled. Enable it or create a new key. See https://docs.userplane.io/api/authentication","data":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"},"bf6bfcbe-bc19-468c-8f14-b9b2b3b89a17":{"description":"404","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["defined","code","status","message"],"properties":{"defined":{"const":true,"isRequired":true,"uniqueKey":"oneOf.0.defined","typeLabel":"any"},"code":{"const":"WORKSPACE_NOT_FOUND","isRequired":true,"uniqueKey":"oneOf.0.code","typeLabel":"any"},"status":{"const":404,"isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"any"},"message":{"type":"string","default":"Workspace not found","isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"string"},"data":{"oneOf":[{}],"uniqueKey":"oneOf.0.data","typeLabel":"any"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["defined","code","status","message"],"properties":{"defined":{"const":false,"isRequired":true,"uniqueKey":"oneOf.1.defined","typeLabel":"any"},"code":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.code","typeLabel":"string"},"status":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"number"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.message","typeLabel":"string"},"data":{"oneOf":[{}],"uniqueKey":"oneOf.1.data","typeLabel":"any"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"defined":true,"code":"WORKSPACE_NOT_FOUND","status":404,"message":"Workspace not found","data":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"},"3273ddde-ff88-4781-9866-dfe6ee4498a2":{"description":"410","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["defined","code","status","message"],"properties":{"defined":{"const":true,"isRequired":true,"uniqueKey":"oneOf.0.defined","typeLabel":"any"},"code":{"const":"WORKSPACE_GONE","isRequired":true,"uniqueKey":"oneOf.0.code","typeLabel":"any"},"status":{"const":410,"isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"any"},"message":{"type":"string","default":"Workspace has been deleted","isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"string"},"data":{"oneOf":[{}],"uniqueKey":"oneOf.0.data","typeLabel":"any"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["defined","code","status","message"],"properties":{"defined":{"const":false,"isRequired":true,"uniqueKey":"oneOf.1.defined","typeLabel":"any"},"code":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.code","typeLabel":"string"},"status":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"number"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.message","typeLabel":"string"},"data":{"oneOf":[{}],"uniqueKey":"oneOf.1.data","typeLabel":"any"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"defined":true,"code":"WORKSPACE_GONE","status":410,"message":"Workspace has been deleted","data":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"},"2c7d9d92-c1a8-4943-997d-b74119fffc4a":{"description":"429","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["defined","code","status","message"],"properties":{"defined":{"const":true,"isRequired":true,"uniqueKey":"oneOf.0.defined","typeLabel":"any"},"code":{"const":"RATE_LIMITED","isRequired":true,"uniqueKey":"oneOf.0.code","typeLabel":"any"},"status":{"const":429,"isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"any"},"message":{"type":"string","default":"Rate limit exceeded. Wait and retry with exponential backoff. See https://docs.userplane.io/api/rate-limits","isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"string"},"data":{"oneOf":[{}],"uniqueKey":"oneOf.0.data","typeLabel":"any"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["defined","code","status","message"],"properties":{"defined":{"const":false,"isRequired":true,"uniqueKey":"oneOf.1.defined","typeLabel":"any"},"code":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.code","typeLabel":"string"},"status":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"number"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.message","typeLabel":"string"},"data":{"oneOf":[{}],"uniqueKey":"oneOf.1.data","typeLabel":"any"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"defined":true,"code":"RATE_LIMITED","status":429,"message":"Rate limit exceeded. Wait and retry with exponential backoff. See https://docs.userplane.io/api/rate-limits","data":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"},"56d06695-0f67-4d4b-b7b5-06c1143b2f72":{"description":"503","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["defined","code","status","message"],"properties":{"defined":{"const":true,"isRequired":true,"uniqueKey":"oneOf.0.defined","typeLabel":"any"},"code":{"const":"SERVICE_UNAVAILABLE","isRequired":true,"uniqueKey":"oneOf.0.code","typeLabel":"any"},"status":{"const":503,"isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"any"},"message":{"type":"string","default":"API key verification service is temporarily unavailable. Please try again later. See https://docs.userplane.io/api/error-handling","isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"string"},"data":{"oneOf":[{}],"uniqueKey":"oneOf.0.data","typeLabel":"any"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["defined","code","status","message"],"properties":{"defined":{"const":false,"isRequired":true,"uniqueKey":"oneOf.1.defined","typeLabel":"any"},"code":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.code","typeLabel":"string"},"status":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"number"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.message","typeLabel":"string"},"data":{"oneOf":[{}],"uniqueKey":"oneOf.1.data","typeLabel":"any"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"defined":true,"code":"SERVICE_UNAVAILABLE","status":503,"message":"API key verification service is temporarily unavailable. Please try again later. See https://docs.userplane.io/api/error-handling","data":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"4bfd8b8b-4344-4682-8b3a-dddb2e5ed7f5":{"bearerAuth":{"type":"http","scheme":"bearer","description":"API key with uspl_ prefix. Create keys at dash.userplane.io/_/account?tab=developers","scopes":[]}}},"servers":{"f004a4eb-fff3-4354-bafd-11db31f94f3c":{"url":"https://api.userplane.io/api/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key with uspl_ prefix. Create keys at dash.userplane.io/_/account?tab=developers","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key with uspl_ prefix. Create keys at dash.userplane.io/_/account?tab=developers","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"userplane","siteName":"Userplane Docs","title":"Get Invite URL - Userplane Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-08T14:27:39.966Z","originalFileLocation":"api/workspaces/get-invite-url.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve the invite URL for a workspace\">\u003cmeta data-mint-head name=\"application-name\" content=\"Userplane Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/userplane/fDBjjV0nXQ3P7r2U/_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/userplane/fDBjjV0nXQ3P7r2U/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/userplane/fDBjjV0nXQ3P7r2U/_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/userplane/fDBjjV0nXQ3P7r2U/_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/userplane/fDBjjV0nXQ3P7r2U/_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/userplane/fDBjjV0nXQ3P7r2U/_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/userplane/fDBjjV0nXQ3P7r2U/_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/userplane/fDBjjV0nXQ3P7r2U/_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/userplane/fDBjjV0nXQ3P7r2U/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Invite URL - Userplane Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve the invite URL for a workspace\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Userplane Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.userplane.io/api/workspaces/get-invite-url\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://userplane.mintlify.site/_mintlify/api/og/v2?division=Workspaces\u0026amp;title=Get+Invite+URL\u0026amp;description=Retrieve+the+invite+URL+for+a+workspace\u0026amp;theme=57a7adfd14ffc0fa093d4a9f\u0026amp;signature=d23a09c04b50fdebcbcd04798405803495cbe0d461d15199f96e0ba41b46dfdd\">\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 Invite URL - Userplane Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve the invite URL for a workspace\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://userplane.mintlify.site/_mintlify/api/og/v2?division=Workspaces\u0026amp;title=Get+Invite+URL\u0026amp;description=Retrieve+the+invite+URL+for+a+workspace\u0026amp;theme=57a7adfd14ffc0fa093d4a9f\u0026amp;signature=d23a09c04b50fdebcbcd04798405803495cbe0d461d15199f96e0ba41b46dfdd\">\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/userplane/fDBjjV0nXQ3P7r2U/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Userplane Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.userplane.io/api/workspaces/get-invite-url\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/workspaces/get-invite-url.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.userplane.io/#organization\",\"name\":\"Userplane Docs\",\"url\":\"https://docs.userplane.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/userplane/e34bWffW8FdiqmQz/static/logo-light.svg?fit=max\u0026auto=format\u0026n=e34bWffW8FdiqmQz\u0026q=85\u0026s=b60f979b7800d446f3f5d5274c095cb2\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.userplane.io#website\",\"name\":\"Userplane Docs\",\"url\":\"https://docs.userplane.io\",\"publisher\":{\"@id\":\"https://docs.userplane.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.userplane.io/api/workspaces/get-invite-url#webpage\",\"url\":\"https://docs.userplane.io/api/workspaces/get-invite-url\",\"name\":\"Get Invite URL\",\"description\":\"Retrieve the invite URL for a workspace\",\"dateModified\":\"2026-04-08T14:27:39.966Z\",\"isPartOf\":{\"@id\":\"https://docs.userplane.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.userplane.io/api/workspaces/get-invite-url#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.userplane.io/api/workspaces/get-invite-url#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Workspaces\",\"item\":\"https://docs.userplane.io/api/workspaces/list-workspaces\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Invite URL\",\"item\":\"https://docs.userplane.io/api/workspaces/get-invite-url\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.userplane.io/api/workspaces/get-invite-url#apireference\",\"headline\":\"Get Invite URL\",\"name\":\"Get Invite URL\",\"description\":\"Retrieve the invite URL for a workspace\",\"url\":\"https://docs.userplane.io/api/workspaces/get-invite-url\",\"mainEntityOfPage\":{\"@id\":\"https://docs.userplane.io/api/workspaces/get-invite-url#webpage\"},\"dateModified\":\"2026-04-08T14:27:39.966Z\",\"publisher\":{\"@id\":\"https://docs.userplane.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.userplane.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Userplane Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Userplane Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/workspaces/get-invite-url.md","siteName":"Userplane Docs","nav":{"global":null,"tabs":[{"tab":"Guide","pages":[{"title":"Guide","href":"/introduction"}]},{"tab":"Developer","pages":[{"title":"Developer","href":"/developer/installation"}]},{"tab":"API","groups":[{"group":"Getting Started","icon":"rocket","pages":[{"title":"API Overview","href":"/api/introduction"},{"title":"Authentication","href":"/api/authentication"},{"group":"API Keys","pages":[{"title":"API Keys","href":"/api/api-keys"},{"title":"Create API Key","href":"/api/api-keys/create-api-key"},{"title":"Manage API Keys","href":"/api/api-keys/list-api-keys"},{"title":"Rotate API Key","href":"/api/api-keys/rotate-api-key"},{"title":"Revoke API Key","href":"/api/api-keys/revoke-api-key"}]},{"title":"Quickstart","href":"/api/quickstart"}]},{"group":"Concepts","icon":"book","pages":[{"title":"Rate Limits","href":"/api/rate-limits"},{"title":"Error Handling","href":"/api/error-handling"},{"title":"Pagination","href":"/api/pagination"},{"title":"Best Practices","href":"/api/best-practices"}]},{"group":"User","icon":"user","pages":[{"title":"Get Current User","openapi":"GET /public/me","href":"/api/user/get-me"}]},{"group":"Workspaces","icon":"building","pages":[{"title":"List Workspaces","openapi":"GET /public/workspaces","href":"/api/workspaces/list-workspaces"},{"title":"Get Workspace","description":"Retrieve workspace details by ID","openapi":"GET /public/workspace/{workspaceId}","href":"/api/workspaces/get-workspace"},{"title":"Get Invite URL","openapi":"GET /public/workspace/{workspaceId}/invite-url","href":"/api/workspaces/get-invite-url"}]},{"group":"Projects","icon":"folder","pages":[{"title":"List Projects","description":"Retrieve a paginated list of projects in a workspace","openapi":"GET /public/workspace/{workspaceId}/projects","href":"/api/projects/list-projects"},{"title":"Get Project","openapi":"GET /public/workspace/{workspaceId}/projects/{projectId}","href":"/api/projects/get-project"}]},{"group":"Links","icon":"link","pages":[{"title":"List Links","openapi":"GET /public/workspace/{workspaceId}/links","href":"/api/links/list-links"},{"title":"Create Link","openapi":"POST /public/workspace/{workspaceId}/links","href":"/api/links/create-link"},{"title":"Get Link","openapi":"GET /public/workspace/{workspaceId}/links/{linkId}","href":"/api/links/get-link"},{"title":"Update Link","openapi":"PUT /public/workspace/{workspaceId}/links/{linkId}","href":"/api/links/update-link"},{"title":"Delete Link","openapi":"DELETE /public/workspace/{workspaceId}/links/{linkId}","href":"/api/links/delete-link"}]},{"group":"Recordings","icon":"video","pages":[{"title":"List Recordings","openapi":"GET /public/workspace/{workspaceId}/recordings","href":"/api/recordings/list-recordings"},{"title":"Get Recording","openapi":"GET /public/workspace/{workspaceId}/recordings/{recordingId}","href":"/api/recordings/get-recording"},{"title":"Delete Recording","openapi":"DELETE /public/workspace/{workspaceId}/recordings/{recordingId}","href":"/api/recordings/delete-recording"},{"title":"Recording Resources","href":"/api/recordings/get-recording-resources"}]},{"group":"Search","icon":"magnifying-glass","pages":[{"title":"Search Workspace","openapi":"GET /public/workspace/{workspaceId}/search","href":"/api/search/search-workspace"}]}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/intercom"}]}]},"basePath":"","title":"Get Invite URL - Userplane Docs","buildId":"dpl_4D8r1dHg6bQcRuBgQyL3z9waJJtn","deploymentId":"dpl_4D8r1dHg6bQcRuBgQyL3z9waJJtn","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-dD8DedlW.js","utils-BgJ6PauS.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-m4sNRkou.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dg97LVEU.js","snippetPresets-C6CxWGOo.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-CKiRf67B.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CDY0tBIx.js","shallow-BHHaYlmm.js","getApiPlaygroundDisplay-D6K3-cVX.js","CodeSnippet-BrS3fDep.js","CodeSnippets-Dkf1llUu.js","Page-DOwQSAHT.js","getPastedJson-3JcMsaes.js","icon-CWSTKRsN.js","MethodPill-t_TXGK5I.js","DuplicateIcon-DcjhdAbh.js","createIcon-2JHmGxKn.js","DynamicMarkdown-DMUWO-az.js","SectionHeading-DxvGHAss.js","axios-vUo_bRtp.js","Markdown-cyvaulBW.js","clsx-DzViKcUj.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CU0Gjyt0.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CuigkklY.js"]}