Workspaces

List workspaces

List the workspaces for the organization.

GET/organizations/{organizationId}/workspaces

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

Query parameters

Response

200401404

OK

Body

application/json

results*array of Workspace

List of results.

nextPageTokenstring

The token to fetch the next page of results. If empty, there are no more results to fetch.

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/workspaces', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200401404

{
  "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-01-21T01:28:48.753Z",
          "transitionedBy": {
            "type": "user",
            "id": "123e4567-e89b-12d3-a456-426614174000"
          }
        }
      ],
      "name": "text",
      "description": "text",
      "dataPolicy": {
        "group": "eu-west-1",
        "regions": [
          {
            "region": "eu-west-1",
            "priority": 0
          }
        ],
        "piiStrategy": "default"
      },
      "createdAt": "2025-01-21T01:28:48.753Z",
      "updatedAt": "2025-01-21T01:28:48.753Z"
    }
  ],
  "nextPageToken": "text"
}

Create workspace

Create a workspace for the organization.

POST/organizations/{organizationId}/workspaces

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

Body

application/json

name*WorkspaceName (string)

The display name for the workspace

descriptionWorkspaceDescription (string)

The description for the workspace

dataPolicy*DataPolicy

The data storage policy for a resource.

Response

201404422

Created

Body

application/json

id*string (uuid)

Workspace ID.

organizationId*string (uuid)

ID of the organization this workspace is part of.

status*WorkspaceStatus (enum)

Status of the workspace

activedisabledterminateddeleted

statusTransitionsarray of WorkspaceStatusTransition (object)

name*WorkspaceName (string)

The display name for the workspace

descriptionWorkspaceDescription (string)

The description for the workspace

dataPolicy*DataPolicy

The data storage policy for a resource.

createdAt*string (date-time)

When the workspace was created.

updatedAt*string (date-time)

When the workspace was last updated.

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/workspaces', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "dataPolicy": {
        "group": "eu-west-1",
        "regions": [
          {
            "region": "eu-west-1",
            "priority": 0
          }
        ]
      }
    }),
});
const data = await response.json();

Response

201404422

{
  "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-01-21T01:28:48.753Z",
      "transitionedBy": {
        "type": "user",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ],
  "name": "text",
  "description": "text",
  "dataPolicy": {
    "group": "eu-west-1",
    "regions": [
      {
        "region": "eu-west-1",
        "priority": 0
      }
    ],
    "piiStrategy": "default"
  },
  "createdAt": "2025-01-21T01:28:48.753Z",
  "updatedAt": "2025-01-21T01:28:48.753Z"
}

Get workspace

Get the workspace instance.

GET/organizations/{organizationId}/workspaces/{workspaceId}

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

workspaceId*string (uuid)

The workspace ID

Response

200404

OK

Body

application/json

id*string (uuid)

Workspace ID.

organizationId*string (uuid)

ID of the organization this workspace is part of.

status*WorkspaceStatus (enum)

Status of the workspace

activedisabledterminateddeleted

statusTransitionsarray of WorkspaceStatusTransition (object)

name*WorkspaceName (string)

The display name for the workspace

descriptionWorkspaceDescription (string)

The description for the workspace

dataPolicy*DataPolicy

The data storage policy for a resource.

createdAt*string (date-time)

When the workspace was created.

updatedAt*string (date-time)

When the workspace was last updated.

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/workspaces/{workspaceId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "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-01-21T01:28:48.753Z",
      "transitionedBy": {
        "type": "user",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ],
  "name": "text",
  "description": "text",
  "dataPolicy": {
    "group": "eu-west-1",
    "regions": [
      {
        "region": "eu-west-1",
        "priority": 0
      }
    ],
    "piiStrategy": "default"
  },
  "createdAt": "2025-01-21T01:28:48.753Z",
  "updatedAt": "2025-01-21T01:28:48.753Z"
}

Delete workspace

Delete a workspace from the organization.

DELETE/organizations/{organizationId}/workspaces/{workspaceId}

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

workspaceId*string (uuid)

The workspace ID

Response

204403404410

Delete successful

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/workspaces/{workspaceId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

403404

{
  "code": "text",
  "message": "text"
}

Update workspace

Update a workspace's properties.

PATCH/organizations/{organizationId}/workspaces/{workspaceId}

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

workspaceId*string (uuid)

The workspace ID

Body

application/json

nameWorkspaceName (string)

The display name for the workspace

descriptionWorkspaceDescription (string)

The description for the workspace

Response

200404422

OK

Body

application/json

id*string (uuid)

Workspace ID.

organizationId*string (uuid)

ID of the organization this workspace is part of.

status*WorkspaceStatus (enum)

Status of the workspace

activedisabledterminateddeleted

statusTransitionsarray of WorkspaceStatusTransition (object)

name*WorkspaceName (string)

The display name for the workspace

descriptionWorkspaceDescription (string)

The description for the workspace

dataPolicy*DataPolicy

The data storage policy for a resource.

createdAt*string (date-time)

When the workspace was created.

updatedAt*string (date-time)

When the workspace was last updated.

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/workspaces/{workspaceId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404422

{
  "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-01-21T01:28:48.753Z",
      "transitionedBy": {
        "type": "user",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ],
  "name": "text",
  "description": "text",
  "dataPolicy": {
    "group": "eu-west-1",
    "regions": [
      {
        "region": "eu-west-1",
        "priority": 0
      }
    ],
    "piiStrategy": "default"
  },
  "createdAt": "2025-01-21T01:28:48.753Z",
  "updatedAt": "2025-01-21T01:28:48.753Z"
}