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);
响应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.

参数

label_idstring

The catalogue label to act on.

响应载荷

id
string
必填

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

name
string
必填

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
必填

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

description
nullable string
必填

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

created_at
string
必填
updated_at
string
必填

继续查看此主题的文档、指南和示例。