Get the current workspace

GET

/v1/workspace

const workspace = await bird.workspace.get();
console.log(workspace.id, workspace.name); // "ws_…" "Production"

workspace = client.workspace.get()
print(workspace.id, workspace.name)

workspace, err := client.Workspace.Get(context.Background())
if err != nil {
	log.Fatal(err)
}
fmt.Println(workspace.Id, workspace.Name)

$workspace = $bird->workspace->get();
echo $workspace->getId() . ' ' . $workspace->getName() . PHP_EOL;

bird workspace get

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

Respuesta200

{
  "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: its ID, name, the ID of the organization that owns it, and its notification and logo settings. The organization's own name and members are not included. Requires at least read access to the workspace.

Carga de respuesta

string

obligatorio

organization_id

string

obligatorio

name

string

obligatorio

notification_emails

object

obligatorio

Mostrar atributos secundarios

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

obligatorio

updated_at

string

obligatorio

Recursos relacionados

Continúa con la documentación, guías y ejemplos sobre este tema. Los recursos están en inglés.

Comprender el conceptoShould I use an API key or an OAuth token, and how do I rotate one?Guía de implementaciónAuthentication & API keys

Obtener un resumen de implementación

const workspace = await bird.workspace.get();
console.log(workspace.id, workspace.name); // "ws_…" "Production"

workspace = client.workspace.get()
print(workspace.id, workspace.name)

workspace, err := client.Workspace.Get(context.Background())
if err != nil {
	log.Fatal(err)
}
fmt.Println(workspace.Id, workspace.Name)

$workspace = $bird->workspace->get();
echo $workspace->getId() . ' ' . $workspace->getName() . PHP_EOL;

bird workspace get

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

Respuesta200

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