Workspaces

Last updated 8 months ago

Was this helpful?

List workspaces

List the workspaces for the organization.

get

/organizations/{organizationId}/workspaces

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

Limits the number of results to return

pageTokenstring

Pagination token that keeps of track of the current position in the list

reverseboolean

Order in which to retrieve the results

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/organizations/{organizationId}/workspaces' \
  --header 'Authorization: Bearer jwt'

200

401

404

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "status": "active",
      "name": "text",
      "description": "text",
      "dataPolicy": {
        "group": "eu-west-1",
        "piiStrategy": "default",
        "regions": [
          {
            "region": "eu-west-1",
            "priority": 1
          }
        ]
      },
      "createdAt": "2025-02-21T18:15:03.378Z",
      "updatedAt": "2025-02-21T18:15:03.378Z",
      "statusTransitions": [
        {
          "fromStatus": "active",
          "toStatus": "active",
          "comment": "text",
          "transitionedAt": "2025-02-21T18:15:03.378Z",
          "transitionedBy": {
            "type": "user",
            "id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "reason": "org-banned"
        }
      ]
    }
  ],
  "nextPageToken": "text"
}

Create workspace

Create a workspace for the organization.

post

/organizations/{organizationId}/workspaces

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

Body

namestring · min: 1 · max: 256required

The display name for the workspace

descriptionstring · min: 1 · max: 256

The description for the workspace

dataPolicyDataPolicyrequired

The data storage policy for a resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/organizations/{organizationId}/workspaces' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","dataPolicy":{"group":"eu-west-1","regions":[{"region":"eu-west-1","priority":1}]}}'

201

404

422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "active",
  "name": "text",
  "description": "text",
  "dataPolicy": {
    "group": "eu-west-1",
    "piiStrategy": "default",
    "regions": [
      {
        "region": "eu-west-1",
        "priority": 1
      }
    ]
  },
  "createdAt": "2025-02-21T18:15:03.378Z",
  "updatedAt": "2025-02-21T18:15:03.378Z",
  "statusTransitions": [
    {
      "fromStatus": "active",
      "toStatus": "active",
      "comment": "text",
      "transitionedAt": "2025-02-21T18:15:03.378Z",
      "transitionedBy": {
        "type": "user",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "reason": "org-banned"
    }
  ]
}

Created

Get workspace

Get the workspace instance.

get

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

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

workspaceIdstring · uuidrequired

The workspace ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/organizations/{organizationId}/workspaces/{workspaceId}' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "active",
  "name": "text",
  "description": "text",
  "dataPolicy": {
    "group": "eu-west-1",
    "piiStrategy": "default",
    "regions": [
      {
        "region": "eu-west-1",
        "priority": 1
      }
    ]
  },
  "createdAt": "2025-02-21T18:15:03.378Z",
  "updatedAt": "2025-02-21T18:15:03.378Z",
  "statusTransitions": [
    {
      "fromStatus": "active",
      "toStatus": "active",
      "comment": "text",
      "transitionedAt": "2025-02-21T18:15:03.378Z",
      "transitionedBy": {
        "type": "user",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "reason": "org-banned"
    }
  ]
}

Delete workspace

Delete a workspace from the organization.

delete

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

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

workspaceIdstring · uuidrequired

The workspace ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/organizations/{organizationId}/workspaces/{workspaceId}' \
  --header 'Authorization: Bearer jwt'

204

403

404

410

No body

Delete successful

Update workspace

Update a workspace's properties.

patch

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

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

workspaceIdstring · uuidrequired

The workspace ID

Body

namestring · min: 1 · max: 256

The display name for the workspace

descriptionstring · min: 1 · max: 256

The description for the workspace

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/organizations/{organizationId}/workspaces/{workspaceId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json'

200

404

422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "active",
  "name": "text",
  "description": "text",
  "dataPolicy": {
    "group": "eu-west-1",
    "piiStrategy": "default",
    "regions": [
      {
        "region": "eu-west-1",
        "priority": 1
      }
    ]
  },
  "createdAt": "2025-02-21T18:15:03.378Z",
  "updatedAt": "2025-02-21T18:15:03.378Z",
  "statusTransitions": [
    {
      "fromStatus": "active",
      "toStatus": "active",
      "comment": "text",
      "transitionedAt": "2025-02-21T18:15:03.378Z",
      "transitionedBy": {
        "type": "user",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "reason": "org-banned"
    }
  ]
}