Workspaces
List the workspaces for the organization.
Authorizations
Path parameters
organizationIdstringRequired
The organization ID
Query parameters
limitinteger · min: 1 · max: 100OptionalDefault:
Limits the number of results to return
10
pageTokenstringOptional
Pagination token that keeps of track of the current position in the list
reversebooleanOptionalDefault:
Order in which to retrieve the results
false
Responses
200
OK
application/json
Responseall of
and
401
unauthorized request
application/json
404
Resource not found
application/json
get
GET /organizations/{organizationId}/workspaces HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"results": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"organizationId": "123e4567-e89b-12d3-a456-426614174000",
"status": "active",
"statusTransitions": [
{
"fromStatus": "active",
"toStatus": "active",
"reason": "org-banned",
"comment": "text",
"transitionedAt": "2025-07-12T04:12:03.373Z",
"transitionedBy": {
"type": "user",
"id": "123e4567-e89b-12d3-a456-426614174000"
}
}
],
"name": "text",
"description": "text",
"dataPolicy": {
"group": "eu-west-1",
"regions": [
{
"region": "eu-west-1",
"priority": 1
}
],
"piiStrategy": "default"
},
"configuration": {
"domain": "example.com"
},
"createdAt": "2025-07-12T04:12:03.373Z",
"updatedAt": "2025-07-12T04:12:03.373Z"
}
],
"nextPageToken": "text"
}
Create a workspace for the organization.
Authorizations
Path parameters
organizationIdstringRequired
The organization ID
Body
namestring · min: 1 · max: 256Required
The display name for the workspace
descriptionstring · min: 1 · max: 256Optional
The description for the workspace
userUsernamestring | nullableOptionalPattern:
The username of the user that is creating the workspace.
^[a-z0-9._-]+$
flavorsstring[] | nullableOptional
Responses
201
Created
application/json
404
Resource not found
application/json
422
Request validation failed
application/json
post
POST /organizations/{organizationId}/workspaces HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 201
{
"name": "text",
"description": "text",
"dataPolicy": {
"group": "eu-west-1",
"regions": [
{
"region": "eu-west-1",
"priority": 1
}
]
},
"configuration": {
"domain": "example.com"
},
"userUsername": "text",
"flavors": [
"text"
]
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"organizationId": "123e4567-e89b-12d3-a456-426614174000",
"status": "active",
"statusTransitions": [
{
"fromStatus": "active",
"toStatus": "active",
"reason": "org-banned",
"comment": "text",
"transitionedAt": "2025-07-12T04:12:03.373Z",
"transitionedBy": {
"type": "user",
"id": "123e4567-e89b-12d3-a456-426614174000"
}
}
],
"name": "text",
"description": "text",
"dataPolicy": {
"group": "eu-west-1",
"regions": [
{
"region": "eu-west-1",
"priority": 1
}
],
"piiStrategy": "default"
},
"configuration": {
"domain": "example.com"
},
"createdAt": "2025-07-12T04:12:03.373Z",
"updatedAt": "2025-07-12T04:12:03.373Z"
}
Get the workspace instance.
Authorizations
Path parameters
organizationIdstringRequired
The organization ID
workspaceIdstring · uuidRequired
The workspace ID
Responses
200
OK
application/json
404
Resource not found
application/json
get
GET /organizations/{organizationId}/workspaces/{workspaceId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"organizationId": "123e4567-e89b-12d3-a456-426614174000",
"status": "active",
"statusTransitions": [
{
"fromStatus": "active",
"toStatus": "active",
"reason": "org-banned",
"comment": "text",
"transitionedAt": "2025-07-12T04:12:03.373Z",
"transitionedBy": {
"type": "user",
"id": "123e4567-e89b-12d3-a456-426614174000"
}
}
],
"name": "text",
"description": "text",
"dataPolicy": {
"group": "eu-west-1",
"regions": [
{
"region": "eu-west-1",
"priority": 1
}
],
"piiStrategy": "default"
},
"configuration": {
"domain": "example.com"
},
"createdAt": "2025-07-12T04:12:03.373Z",
"updatedAt": "2025-07-12T04:12:03.373Z"
}
Delete a workspace from the organization.
Authorizations
Path parameters
organizationIdstringRequired
The organization ID
workspaceIdstring · uuidRequired
The workspace ID
Responses
204
Delete successful
403
Forbidden operation
application/json
404
Resource not found
application/json
410
Does not exist or already deleted
delete
DELETE /organizations/{organizationId}/workspaces/{workspaceId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
No content
Update a workspace's properties.
Authorizations
Path parameters
organizationIdstringRequired
The organization ID
workspaceIdstring · uuidRequired
The workspace ID
Body
namestring · min: 1 · max: 256Optional
The display name for the workspace
descriptionstring · min: 1 · max: 256Optional
The description for the workspace
Responses
200
OK
application/json
404
Resource not found
application/json
422
Request validation failed
application/json
patch
PATCH /organizations/{organizationId}/workspaces/{workspaceId} HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"name": "text",
"description": "text"
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"organizationId": "123e4567-e89b-12d3-a456-426614174000",
"status": "active",
"statusTransitions": [
{
"fromStatus": "active",
"toStatus": "active",
"reason": "org-banned",
"comment": "text",
"transitionedAt": "2025-07-12T04:12:03.373Z",
"transitionedBy": {
"type": "user",
"id": "123e4567-e89b-12d3-a456-426614174000"
}
}
],
"name": "text",
"description": "text",
"dataPolicy": {
"group": "eu-west-1",
"regions": [
{
"region": "eu-west-1",
"priority": 1
}
],
"piiStrategy": "default"
},
"configuration": {
"domain": "example.com"
},
"createdAt": "2025-07-12T04:12:03.373Z",
"updatedAt": "2025-07-12T04:12:03.373Z"
}
Last updated
Was this helpful?