Logo
Zoom Public API Documentation

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

 

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" } ] }



Curl
curl -X GET 'https://api.zoom.us/v2/emails/mailboxes/:email/labels?format=full?format=full' -H 'Accept: application/json'

ENDPOINTS