latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Workspace

Join

Join a workspace via link or via workspace ID, if the user can auto-join the workspace by domain.

This is possible if:

The user is verified
The user has a user e-mail belonging to a domain that is set as a domain name for a workspace
That workspace has the auto-join by domain feature enabled

post/api/v1/workspaces/join

invite_codestring nullable

Workspace invite code to join with. Provide either invite_code or workspace_id, not both.

workspace_idinteger nullable

Workspace ID to join by verified email domain. Provide either invite_code or workspace_id, not both.

{
  "invite_code": "26d332457f16dc67f18385194be148f62c2b4317",
  "workspace_id": 123456
}

Successful Response

user_idstring required

String ID of the workspace user.

workspace_idstring required

String ID of the workspace.

role'ADMIN' | 'MEMBER' | 'GUEST'

Role of the user inside the workspace

custom_sorting_appliedboolean

Whether the user has custom project sorting enabled.

project_sort_preference'MANUAL' | 'A_TO_Z' | 'Z_TO_A'

User preference for workspace project sorting

{
  "user_id": "1234567",
  "workspace_id": "123456"
}