Skip to Content

List mailbox labels

Returns every label defined on a mailbox, ordered by name. A mailbox holds at most 100 labels, so the list is never paged.

GET
/v1/mailboxes/{id}/labels

Returns every label defined on a mailbox, ordered by name. A mailbox holds at most 100 labels, so the list is never paged.

Authorization

apiKey
headerx-api-key<token>

Path Parameters

id*string
Match^mbx_[0-9a-hjkmnp-tv-z]{16,24}$

Response Body

MailboxLabelList

application/json
  1. response
items*array<>
Example Request
import { createClient } from "samva";

const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });

const result = await samva.mailboxes.listLabels({
  "id": "example"
});
Example Response
{
  "items": [
    {
      "id": "string",
      "slug": "string",
      "displayName": "string",
      "color": "billing",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}

Related documentation