Sign inGet Started

List labels

GET
/v1/labels
const labels = await bird.labels.list();
console.log(labels.data.map((label) => label.name));
Antwort200
{
  "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"
    }
  ]
}

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.

Antwort-Payload

data
array of object
erforderlich

Every label in the workspace, ordered by name.

Untergeordnete Attribute anzeigen

Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.