GET {{baseUrl}}/emails/mailboxes/:email/labels?format=full
Lists all labels in the mailbox. Scopes: Rate Limit Label: Not supported in Gov cluster mail:read
MEDIUM
Body
PARAM
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": "<string>",
"name": "<string>",
"parentId": "<string>",
"labelLevel": "<integer>",
"messageListVisibility": "show",
"labelListVisibility": "hide",
"messagesTotal": "<integer>",
"messagesUnread": "<integer>",
"threadsTotal": "<integer>",
"threadsUnread": "<integer>",
"color": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"type": "user"
},
{
"id": "<string>",
"name": "<string>",
"parentId": "<string>",
"labelLevel": "<integer>",
"messageListVisibility": "show",
"labelListVisibility": "hide",
"messagesTotal": "<integer>",
"messagesUnread": "<integer>",
"threadsTotal": "<integer>",
"threadsUnread": "<integer>",
"color": {
"textColor": "<string>",
"backgroundColor": "<string>"
},
"type": "system"
}
]
} |
ENDPOINTS