Documentation
Sign inGet started

List a mailbox's labels

GET
/v1/email/mailboxes/{mailbox_id}/labels
curl -X GET "https://us1.platform.bird.com/v1/email/mailboxes/{mailbox_id}/labels" \
  -H "Authorization: Bearer $TOKEN"
Returns the labels available in a mailbox: the built-in system labels — the placements inbox, archive, spam, blocked, and sent, plus trash and unread — followed by every custom label currently in use on its conversations and messages. Apply and remove labels through the conversation and message update endpoints; custom labels exist by being applied, so this list is discovery, not management.
Payload de resposta
data
array of object
obrigatório
Mostrar atributos secundários
data.name
string
obrigatório
The label name, as it appears on conversations and messages.
data.type
string
obrigatório
system labels are built in and carry state — the placements inbox, archive, spam, blocked, and sent, plus trash and unread. custom labels are the workspace's own tags.
Possible values: system, custom