Get the current workspace

GET

/v1/workspace

bird workspace get

curl -X GET "https://us1.platform.bird.com/v1/workspace" \
  -H "Authorization: Bearer $TOKEN"

Response200

{
  "id": "ws_01krdgeqcxet5s7t44vh8rt9mg",
  "organization_id": "org_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "Production",
  "notification_emails": {
    "operational": [
      "alerts@example.com"
    ]
  },
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}

Returns the workspace the current credentials are scoped to. Requires at least read access to that workspace.

Response Payload

string

आवश्यक

organization_id

string

आवश्यक

name

string

आवश्यक

notification_emails

object

आवश्यक

चाइल्ड एट्रिब्यूट दिखाएँ

notification_emails.operational

array of string

Addresses for operational notifications about this workspace (sending domain authentication failures, webhook endpoint degradation). When empty, these notifications go to the organization owners. Maximum 10 addresses.

logo_url

nullable string

HTTPS URL to the current workspace logo. null when unset.

created_at

string

आवश्यक

updated_at

string

आवश्यक

bird workspace get

curl -X GET "https://us1.platform.bird.com/v1/workspace" \
  -H "Authorization: Bearer $TOKEN"

Response200

{
  "id": "ws_01krdgeqcxet5s7t44vh8rt9mg",
  "organization_id": "org_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "Production",
  "notification_emails": {
    "operational": [
      "alerts@example.com"
    ]
  },
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}