List labels in use

GET/api/v1/mailbox/labels
Requires amailbox token— it acts as one mailbox holder, not as the organization.

The labels on messages in this mailbox, for a filter or a label picker.

Errors

Status When
401 No token, or the session expired or was signed out. Sign in again with POST /mailbox-auth/login.
403 The account has a temporary password: until POST /security/password succeeds, every other call answers this with error_code: password_change_required.

Request

GET/api/v1/mailbox/labels
curl -X GET 'https://courier.mailyte.com/api/v1/mailbox/labels' \
  -H 'Authorization: Bearer MAILBOX_TOKEN'

Response

Successful Response

  • dataobject
    • labelsarray<string>
200application/json
{
  "type": "success",
  "msg": "Labels retrieved successfully",
  "data": {
    "labels": [
      "clients",
      "follow-up",
      "invoices"
    ]
  }
}

Returned inside the standard envelope.

Errors

StatusWhen
401No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`.
403The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`.

Every status, with what causes it and what to do, is on the error reference.