workspaces

Returns the workspace with the specified id.

Changed on

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

get/workspaces/{workspaceId}

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/workspaces/{workspaceId}
  • Auth: HTTP bearer

Path parameters

workspaceIdstring uuid required

The id of the workspace.

Response

OK

namestring nullable

The workspace name. Optional.

descriptionstring nullable

The workspace description. Optional.

languagestring nullable

The workspace language. Optional.

typestring nullable

The workspace type / industry set during onboarding. Optional.

sizestring nullable

The workspace size. Optional.

goalsstring[] nullable

The workspace team goals. Optional.

selfAttributionstring nullable

The way the workspace creator learned awork, set during the onboarding. Optional.

previousToolstring nullable

The project management tool used before awork, set during the onboarding. Optional.

aiUsagestring nullable

How the team uses AI, set during the onboarding. Optional.

departmentstring nullable

The workspace creator's department, set during the onboarding. Optional.

allowSocialLoginboolean required

Whether the social login via apple and google is allowed.

allowCredentialsLoginboolean required

Whether the user can login with username and password.

allowAutomaticScimUserBookingboolean nullable

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.

sameDomainSignupEnabledboolean nullable

Whether same domain signup feature is enabled. Only admins are allowed to change this setting.

sameDomainSignupRoleIdstring uuid nullable

Default Role for users who sign up through same domain signup. Only admins are allowed to change this setting.

sameDomainSignupDomainsstring[] nullable

Domains enabled for same domain signup feature. Only admins are allowed to change this setting.

requireMfaboolean

Whether the workspace requires multi-factor authentication for all users.

skipCreateDefaultWorkspaceDataboolean nullable

Whether to skip the creation of default workspace data.

productsstring[] nullable

The products available in this workspace. Read-only.

idstring uuid

The id of the workspace.

memberCountinteger nullable

The amount of workspace members. Only visible when the user is authenticated. Read-only.

lastUsedboolean

Whether this is the workspace the current user last logged in with.

lastLoginstring date-time nullable

The date and time the user last logged in with this workspace, or the workspace was last accessed.

accountIdsstring[] nullable

The ids of identities assigned to this workspace. Read-only.

hasImageboolean

Whether the workspace has uploaded a workspace image.

createdOnstring date-time

The date this workspace was created.

createdBystring uuid nullable

The id of the user who created this workspace. Only set after the first invitation succeeded.

updatedOnstring date-time

The date this workspace was last modified.

updatedBystring uuid nullable

The id of the user who last updated this workspace. Only set after the first invitation succeeded.

isTestWorkspaceboolean

Whether the workspace is a test workspace.

isApprovedboolean

Whether the user accepted the invitation to the workspace.

allowSSOLoginboolean

Whether the user can login via an external SSO provider.

isScimActivatedboolean

Whether the workspace has SCIM user provisioning enabled.

virtualMRRnumber double nullable

The virtual MRR calculated during onborading.

isMobileSignupboolean nullable

The type of sign-up set during the onboarding. Can be: web, mobile, ...

isFreeMailboolean nullable

Whether the domain of the account of the workspace creator is a freemail or a business domain.

isJoinableboolean

Whether this workspace has same domain sign up enabled and the account's email matches the permitted domains.

isFullboolean nullable

Whether this workspace is full and no more users can join. Used in same domain sign up flow.

Changes