<Intro>

<EndpointHeader />

<Description>

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.

</Description>

</Intro>

<Payload kind="response">

<Field name="data" type="array of object" required>

<FieldChildren kind="response">

<Field name="name" type="string" prefix="data." required>

<Description>

The label name, as it appears on conversations and messages.

</Description>

</Field>

<Field name="type" type="string" prefix="data." required>

<Description>

`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.

</Description>

<Description>

Possible values: `system`, `custom`

</Description>

</Field>

</FieldChildren>

</Field>

</Payload>