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
Returns every label defined on a mailbox, ordered by name. A mailbox holds at most 100 labels, so the list is never paged.
apiKeyheader
x-api-key<token>id*stringMatch
^mbx_[0-9a-hjkmnp-tv-z]{16,24}$MailboxLabelList
application/json- response
items*array<>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"
}
]
}