Workspaces

List workspaces

get

List the workspaces for the organization.

Authorizations

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

organizationIdstringRequired

The organization ID

Query parameters

limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10

pageTokenstringOptional

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

reversebooleanOptional

Order in which to retrieve the results

Default: false

Responses

200

application/json

Responseall of

401

unauthorized request

application/json

404

Resource not found

application/json

get

/organizations/{organizationId}/workspaces

GET /organizations/{organizationId}/workspaces HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
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-11-27T04:41:53.669Z",
          "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-11-27T04:41:53.669Z",
      "updatedAt": "2025-11-27T04:41:53.669Z"
    }
  ],
  "nextPageToken": "text"
}

Create workspace

post

Create a workspace for the organization.

Authorizations

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

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 | nullableOptional

The username of the user that is creating the workspace.

Pattern: ^[a-z0-9._-]+$

flavorsstring[] | nullableOptional

Responses

201

Created

application/json

404

Resource not found

application/json

422

Request validation failed

application/json

post

/organizations/{organizationId}/workspaces

POST /organizations/{organizationId}/workspaces HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
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-11-27T04:41:53.669Z",
      "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-11-27T04:41:53.669Z",
  "updatedAt": "2025-11-27T04:41:53.669Z"
}

Get workspace

get

Get the workspace instance.

Authorizations

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

organizationIdstringRequired

The organization ID

workspaceIdstring · uuidRequired

The workspace ID

Responses

200

application/json

404

Resource not found

application/json

get

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

GET /organizations/{organizationId}/workspaces/{workspaceId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
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-11-27T04:41:53.669Z",
      "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-11-27T04:41:53.669Z",
  "updatedAt": "2025-11-27T04:41:53.669Z"
}

Delete workspace

delete

Delete a workspace from the organization.

Authorizations

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

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

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

DELETE /organizations/{organizationId}/workspaces/{workspaceId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

No content

Update workspace

patch

Update a workspace's properties.

Authorizations

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

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

application/json

404

Resource not found

application/json

422

Request validation failed

application/json

patch

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

PATCH /organizations/{organizationId}/workspaces/{workspaceId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
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-11-27T04:41:53.669Z",
      "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-11-27T04:41:53.669Z",
  "updatedAt": "2025-11-27T04:41:53.669Z"
}

Last updated 1 month ago

Was this helpful?