Sign inGet Started

Get a label

GET
/v1/labels/{label_id}
const label = await bird.labels.get("lbl_01krdgeqcxet5s7t44vh8rt9mg");
console.log(label.name, label.description);
Odpowiedź200
{
  "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 one label from the workspace's catalogue.

Parametry

label_idstring

The catalogue label to act on.

Treść odpowiedzi

id
string
wymagane

ID of the label, accepted by every operation that takes a label_id. It stays the same when the label is renamed.

name
string
wymagane

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.

color
nullable string
wymagane

The label colour as a #RRGGBB hex value, or null when none is set.

description
nullable string
wymagane

When to apply the label, or null when none is set.

created_at
string
wymagane
updated_at
string
wymagane

Przejdź do dokumentacji, przewodników i przykładów dotyczących tego tematu.