email-threads

List a mailbox's labels

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.

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

Headers

X-Workspace-Idstring

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-Idstring

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

The mailbox's labels.

Example response

{
  "data": [
    {
      "name": "inbox"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.