---
title: "Get the current workspace"
method: GET
path: "/v1/workspace"
tags: ["workspaces"]
---

# Get the current workspace

`GET /v1/workspace`

## Request

- Base URL: `https://us1.platform.bird.com`
- URL: `https://us1.platform.bird.com/v1/workspace`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `bird_session`

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.

## Headers

- `X-Workspace-Id` string
- `X-Organization-Id` string

## Response `200`

The current workspace.

- Workspace
  - `id` string, required
  - `organization_id` string, required
  - `name` string, required
  - `notification_emails` WorkspaceNotificationEmails, required
    - `operational` 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` string, uri, nullable: HTTPS URL to the current workspace logo. `null` when unset.
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Insufficient permissions
- `404`: Resource not found
- `422`: The request has invalid field values, violates a business rule, or carries a query parameter the endpoint does not declare. Field validation errors use `type: validation_error` and include the affected fields in `details`. Business-rule errors identify the failed rule in `type`.
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/messagebird/apis/bird-api.md) · [All operations](https://skmtc.dev/messagebird/apis/bird-api/llms.txt) · [OpenAPI document](https://skmtc.dev/messagebird/apis/bird-api/revisions/6cec81ac4862?raw)
