List labels in the mailbox
GET {{baseUrl}}/emails/mailboxes/:email/labels?format=full
Lists all labels in the mailbox.
Scopes: mail:read
Rate Limit Label: MEDIUM
Not supported in Gov cluster
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
format | string | Enum value to control how much label information is returned. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"labels":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","parentId":"\u003cstring\u003e","labelLevel":"\u003cinteger\u003e","messageListVisibility":"show","labelListVisibility":"hide","messagesTotal":"\u003cinteger\u003e","messagesUnread":"\u003cinteger\u003e","threadsTotal":"\u003cinteger\u003e","threadsUnread":"\u003cinteger\u003e","color":{"textColor":"\u003cstring\u003e","backgroundColor":"\u003cstring\u003e"},"type":"user"},{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","parentId":"\u003cstring\u003e","labelLevel":"\u003cinteger\u003e","messageListVisibility":"show","labelListVisibility":"hide","messagesTotal":"\u003cinteger\u003e","messagesUnread":"\u003cinteger\u003e","threadsTotal":"\u003cinteger\u003e","threadsUnread":"\u003cinteger\u003e","color":{"textColor":"\u003cstring\u003e","backgroundColor":"\u003cstring\u003e"},"type":"system"}]}