Returns the workspace with the specified id.

GET

Returns the workspace with the specified id.

Required Permissions: Any authenticated user.

Path parameters

workspaceIdstringRequired
The id of the workspace.

Response

This endpoint returns an object
allowSocialLoginboolean
Whether the social login via apple and google is allowed.
allowCredentialsLoginboolean
Whether the user can login with username and password.
namestringOptional
The workspace name. Optional.
descriptionstringOptional
The workspace description. Optional.
languagestringOptional
The workspace language. Optional.
typestringOptional
The workspace type. Optional.
sizestringOptional
The workspace size. Optional.
goalslist of stringsOptional
The workspace team goals. Optional.
selfAttributionstringOptional
The way the workspace noticed awork, set during the onboarding.
previousToolstringOptional
The project management tool used before awork, set during the onboarding.
allowAutomaticScimUserBookingbooleanOptional
Whether the SCIM integration should be able to book additional user seats when provisioning and activating new users, or should return BadRequest. Only admins are allowed to change this setting.
sameDomainSignupEnabledbooleanOptional
Whether same domain signup feature is enabled. Only admins are allowed to change this setting.
sameDomainSignupRoleIdstringOptional
Default Role for users who sign up through same domain signup. Only admins are allowed to change this setting.
sameDomainSignupDomainslist of stringsOptional
Domains enabled for same domain signup feature. Only admins are allowed to change this setting.
skipCreateDefaultWorkspaceDatabooleanOptional
Whether to skip the creation of default workspace data.
idstringOptional
The id of the workspace.
subdomainslist of objectsOptional
The workspace's subdomains. Read-only.
memberCountintegerOptional
The amount of workspace members. Only visible when the user is authenticated. Read-only.
lastUsedbooleanOptional
Whether this is the workspace the current user last logged in with.
lastLogindatetimeOptional
The date and time the current user last logged in with this workspace.
accountIdslist of stringsOptional
The ids of identities assigned to this workspace. Read-only.
hasImagebooleanOptional
Whether the workspace has uploaded a workspace image.
createdOndatetimeOptional
The date this workspace was created.
createdBystringOptional
The id of the user who created this workspace. Only set after the first invitation succeeded.
updatedOndatetimeOptional
The date this workspace was last modified.
updatedBystringOptional
The id of the user who last updated this workspace. Only set after the first invitation succeeded.
isTestWorkspacebooleanOptional
Indicates if the workspace is a test workspace.
isApprovedbooleanOptional
Indicates if the user accepted the invitation to the workspace.
allowSSOLoginbooleanOptional
Whether the user can login via an external SSO provider.
isScimActivatedbooleanOptional
Whether the workspace has SCIM user provisioning enabled.
virtualMRRdoubleOptional
The virtual MRR calculated during onborading.
isMobileSignupbooleanOptional
The type of sign-up set during the onboarding. Can be: web, mobile, ...
isFreeMailbooleanOptional
Whether the domain of the account of the workspace creator is a freemail or a business domain.
isJoinablebooleanOptional
Whether this workspace has same domain sign up enabled and the account's email matches the permitted domains.
isFullbooleanOptional
Whether this workspace is full and no more users can join. Used in same domain sign up flow.
Built with