List labels
/v1/labelsconst labels = await bird.labels.list();
console.log(labels.data.map((label) => label.name));labels = client.labels.list()
for label in labels.data:
print(label.id, label.name)labels, err := client.Labels.List(context.Background())
if err != nil {
log.Fatal(err)
}
for _, l := range labels.Data {
fmt.Println(l.Id, l.Name)
}$labels = $bird->labels->list();
foreach ($labels->getData() ?? [] as $label) {
echo $label->getId(), ' ', $label->getName(), "\n";
}bird labels listcurl -X GET "https://us1.platform.bird.com/v1/labels" \
-H "Authorization: Bearer $TOKEN"{
"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.
Response Payload
dataEvery label in the workspace, ordered by name.
Show child attributes
data.idID of the label, accepted by every operation that takes a label_id. It stays the same when the label is renamed.
data.nameThe 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.
data.colorThe label colour as a #RRGGBB hex value, or null when none is set.
data.descriptionWhen to apply the label, or null when none is set.
data.created_atdata.updated_atRelated resources
Continue with the documentation, guides and examples for this topic.