Workspaces
List the workspaces for the organization.
The organization ID
Limits the number of results to return
10
Pagination token that keeps of track of the current position in the list
Order in which to retrieve the results
false
OK
unauthorized request
Resource not found
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-08-24T20:23:02.632Z",
"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-08-24T20:23:02.632Z",
"updatedAt": "2025-08-24T20:23:02.632Z"
}
],
"nextPageToken": "text"
}
Create a workspace for the organization.
The organization ID
The display name for the workspace
The description for the workspace
The username of the user that is creating the workspace.
^[a-z0-9._-]+$
Created
Resource not found
Request validation failed
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-08-24T20:23:02.632Z",
"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-08-24T20:23:02.632Z",
"updatedAt": "2025-08-24T20:23:02.632Z"
}
Get the workspace instance.
The organization ID
The workspace ID
OK
Resource not found
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-08-24T20:23:02.632Z",
"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-08-24T20:23:02.632Z",
"updatedAt": "2025-08-24T20:23:02.632Z"
}
Delete a workspace from the organization.
The organization ID
The workspace ID
Delete successful
Forbidden operation
Resource not found
Does not exist or already deleted
DELETE /organizations/{organizationId}/workspaces/{workspaceId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
No content
Update a workspace's properties.
The organization ID
The workspace ID
The display name for the workspace
The description for the workspace
OK
Resource not found
Request validation failed
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-08-24T20:23:02.632Z",
"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-08-24T20:23:02.632Z",
"updatedAt": "2025-08-24T20:23:02.632Z"
}
Last updated
Was this helpful?