Workspaces

Create Workspace

post
/workspaces
Authorizations
AuthorizationstringRequired

Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)

Body
idstring ยท min: 1 ยท max: 34RequiredPattern: ^[a-z0-9]+(?:[-_][a-z0-9]+)*$
namestringRequired
Responses
200

Successful Response

application/json
Responseany
post
/workspaces

No content

List Workspaces

get
/workspaces
Authorizations
AuthorizationstringRequired

Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)

Responses
200

Successful Response

application/json
get
/workspaces

Get Workspace

get
/workspaces/{workspace_id}
Authorizations
AuthorizationstringRequired

Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)

Path parameters
workspace_idstringRequired

The ID of the workspace to get.

Responses
200

Successful Response

application/json
get
/workspaces/{workspace_id}

Delete Workspace

delete
/workspaces/{workspace_id}
Authorizations
AuthorizationstringRequired

Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)

Path parameters
workspace_idstringRequired

The ID of the workspace to delete.

Responses
200

Successful Response

application/json
Responseany
delete
/workspaces/{workspace_id}

No content

Add User To Workspace

post
/workspaces/{workspace_id}/user
Authorizations
AuthorizationstringRequired

Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)

Path parameters
workspace_idstringRequired

The ID of the workspace to add user to.

Body
userstringRequired
accessstring ยท enumRequiredPossible values:
Responses
200

Successful Response

application/json
Responseany
post
/workspaces/{workspace_id}/user

No content

Update User In Workspace

put
/workspaces/{workspace_id}/user
Authorizations
AuthorizationstringRequired

Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)

Path parameters
workspace_idstringRequired

The ID of the workspace to update user info.

Body
userstringRequired
accessstring ยท enumRequiredPossible values:
Responses
200

Successful Response

application/json
Responseany
put
/workspaces/{workspace_id}/user

No content

Remove User From Workspace

delete
/workspaces/{workspace_id}/user/{user_id}
Authorizations
AuthorizationstringRequired

Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)

Path parameters
workspace_idstringRequired

The ID of the workspace to remove user from.

user_idstringRequired

The ID of the user.

Responses
200

Successful Response

application/json
Responseany
delete
/workspaces/{workspace_id}/user/{user_id}

No content

List Workspace Users

get
/workspaces/{workspace_id}/users
Authorizations
AuthorizationstringRequired

Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)

Path parameters
workspace_idstringRequired

The ID of the workspace to list users from.

Responses
200

Successful Response

application/json
get
/workspaces/{workspace_id}/users

Last updated