---
title: "List labels"
canonical: "https://bird.com/docs/api/reference/list-labels"
---

# List labels

`GET /v1/labels`

Returns every label in the workspace, ordered by name, in one list without
pagination. Each label carries its colour and a description of when to
apply it. A workspace creates no new label once it has 100 or more.

Mailbox system labels are a fixed set that every mailbox has, so they are
not in this list: `inbox`, `archive`, `spam`, `blocked`, `sent`, `trash`
and `unread`. A thread's `folder` sets `inbox`, `archive` or `spam`, and
its `read` field sets `unread`. Deleting a thread moves it to `trash` and
restoring it moves it back. `sent` and `blocked` are assigned automatically.

## Servers

- `https://{region}.platform.bird.com`: Regional API endpoint. Use the host for the region your organization is hosted in. Official Bird SDKs and the CLI select it automatically from your API key, so you rarely need to set it by hand.
  - `region`: `us1`, `eu1`. Default: `us1`. The region your organization's data is hosted in.

## Authentication

Use one authentication option:

- `BearerAuth`: HTTP bearer authentication. Pass the API key as a bearer token in the `Authorization` header. Workspace
keys use `bk_{region}_*`; organization master keys use `bm_{region}_*`.
The prefix identifies the region and selects the
API endpoint. Official Bird SDKs and the CLI derive the region from the key.

## Code samples

**TypeScript**

```ts
const labels = await bird.labels.list();
console.log(labels.data.map((label) => label.name));
```

Examples: [TypeScript](/docs/api/reference/list-labels.ts.md) · [Python](/docs/api/reference/list-labels.py.md) · [Go](/docs/api/reference/list-labels.go.md) · [PHP](/docs/api/reference/list-labels.php.md) · [CLI](/docs/api/reference/list-labels.cli.md) · [MCP](/docs/api/reference/list-labels.mcp.md) · [cURL](/docs/api/reference/list-labels.curl.md)

## Example response `200`

```json
{
  "data": [
    {
      "id": "lbl_01krdgeqcxet5s7t44vh8rt9mg",
      "name": "Hot lead",
      "color": "#E5484D",
      "description": "Inbound sales enquiry from a company. Not support requests or vendors.",
      "created_at": "2026-05-20T09:14:52Z",
      "updated_at": "2026-05-25T16:42:01Z"
    }
  ]
}
```

## Header parameters

- `X-Workspace-Id` (string, optional): Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.
- `X-Organization-Id` (string, optional): Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

## Response body

- `data` (array of object, required): Every label in the workspace, ordered by name.
- `data.id` (string, required): ID of the label, accepted by every operation that takes a `label_id`. It stays the same when the label is renamed.
- `data.name` (string, required): The label name, unique in the workspace regardless of case. No commas, control characters, or leading or trailing whitespace. System names such as `inbox`, `sent`, `unread`, `open` or `assigned` are reserved.
- `data.color` (nullable string, required): The label colour as a `#RRGGBB` hex value, or `null` when none is set.
- `data.description` (nullable string, required): When to apply the label, or `null` when none is set.
- `data.created_at` (string, required)
- `data.updated_at` (string, required)

## Related resources

- [What is omnichannel vs multichannel messaging?](/explained/engagement/what-is-omnichannel-vs-multichannel) (answer)
- [Build your first integration](/learn/paths/integration) (course)

[Get an implementation brief](/learn/workspace?topic=omnichannel)
