Skip to content
Esc
↑↓navigate↵open⌘Jpreview

List an inbox's labels

Oldest first, every label (at most 100), unpaged.

GET/inboxes/{inbox_id}/labels
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Path parameters
inbox_idstringrequired

The inbox ID or its email address, such as support@example.com

Responses
200

Labels

objectstringrequired
Allowed:list
dataobject[]required
Show properties
Array of object
idstring<uuid>required
namestringrequired
colorstringrequired

Uppercase #RRGGBB

created_atstringrequired
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Not found

statusCodenumberrequired
namestringrequired
messagestringrequired
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.billionsend.com/inboxes/string/labels' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "list",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "color": "string",
      "created_at": "string"
    }
  ]
}

Was this page helpful?