Get a workspace in the organization

GET

/v1/organization/workspaces/{workspace_id}

const workspace = await bird.organization.workspaces.get(
  "ws_01krdgeqcxet5s7t44vh8rt9mg",
);
console.log(workspace.name);

workspace = client.organization.workspaces.get("ws_01krdgeqcxet5s7t44vh8rt9mg")
print(workspace.name)

workspace, err := client.Organization.Workspaces.Get(context.Background(), "ws_01krdgeqcxet5s7t44vh8rt9mg")
if err != nil {
	log.Fatal(err)
}
fmt.Println(workspace.Name)

$workspace = $bird->organization->workspaces->get('ws_01krdgeqcxet5s7t44vh8rt9mg');
echo $workspace->getName() . PHP_EOL;

bird organization workspaces get <workspace-id>

curl -X GET "https://us1.platform.bird.com/v1/organization/workspaces/{workspace_id}" \
  -H "Authorization: Bearer $TOKEN"

Odpowiedź200

{
  "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 any workspace in the organization by ID. Organization administrators can read workspaces without holding a workspace-level role. Organization master keys and authorized CLI or MCP access tokens need organization workspace read access. Workspace API keys cannot call this operation.

Parametry

workspace_idstring

Workspace identifier. Starts with ws_.

Treść odpowiedzi

id

string

wymagane

organization_id

string

wymagane

name

string

wymagane

notification_emails

object

wymagane

Pokaż atrybuty podrzędne

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

wymagane

updated_at

string

wymagane

Przejdź do dokumentacji, przewodników i przykładów dotyczących tego tematu.

Uzyskaj brief wdrożeniowy

const workspace = await bird.organization.workspaces.get(
  "ws_01krdgeqcxet5s7t44vh8rt9mg",
);
console.log(workspace.name);

workspace = client.organization.workspaces.get("ws_01krdgeqcxet5s7t44vh8rt9mg")
print(workspace.name)

workspace, err := client.Organization.Workspaces.Get(context.Background(), "ws_01krdgeqcxet5s7t44vh8rt9mg")
if err != nil {
	log.Fatal(err)
}
fmt.Println(workspace.Name)

$workspace = $bird->organization->workspaces->get('ws_01krdgeqcxet5s7t44vh8rt9mg');
echo $workspace->getName() . PHP_EOL;

bird organization workspaces get <workspace-id>

curl -X GET "https://us1.platform.bird.com/v1/organization/workspaces/{workspace_id}" \
  -H "Authorization: Bearer $TOKEN"

Odpowiedź200

{
  "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"
}

Get a workspace in the organization

Parametry

Treść odpowiedzi

Powiązane zasoby