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"

Resposta200

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

Parâmetros

workspace_idstring

Workspace identifier. Starts with ws_.

Payload de resposta

id

string

obrigatório

organization_id

string

obrigatório

name

string

obrigatório

notification_emails

object

obrigatório

Mostrar atributos secundários

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

obrigatório

updated_at

string

obrigatório

Continue com a documentação, guias e exemplos sobre este tópico.

Obtenha um resumo de implementação

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"

Resposta200

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

Parâmetros

Payload de resposta

Recursos relacionados