---
title: "List a mailbox's labels"
method: GET
path: "/v1/email/mailboxes/{mailbox_id}/labels"
tags: ["email-threads"]
---

# List a mailbox's labels

`GET /v1/email/mailboxes/{mailbox_id}/labels`

## Request

- Base URL: `https://us1.platform.bird.com`
- URL: `https://us1.platform.bird.com/v1/email/mailboxes/{mailbox_id}/labels`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `bird_session`

Returns the labels available in a mailbox. First, the built-in system
labels:

- The placements `inbox`, `archive`, `spam`, `blocked`, and `sent`.
- `trash`.
- `unread`.

Then, every custom label currently in use on its conversations and
messages. Apply and remove labels through the conversation and message
update endpoints. These actions also create and remove custom labels. A
custom label exists while at least one message or conversation uses it.

## Headers

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

## Response `200`

The mailbox's labels.

- EmailMailboxLabelList: The labels available in a mailbox.
  - `data` EmailMailboxLabel[], required
    - `name` string, required: The label name, as it appears on conversations and messages.
    - `type` 'system' | 'custom', required: `system` labels are the built-in placements a message can be in: - Inbox. - Archive. - Spam. - Blocked. - Sent. - Trash. - Unread. `custom` labels are the workspace's own tags.

## 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/6dfce1179799?raw)