List calendars

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

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/calendars
curl -X GET 'https://courier.mailyte.com/api/v1/mailbox/calendars' \
  -H 'Authorization: Bearer MAILBOX_TOKEN'

Response

Successful Response

  • dataarray<object>
    • uristring

      Use as {calendar} in event URLs.

    • namestring
    • colorstring or null
    • descriptionstring or null
    • read_onlyboolean
    • is_defaultboolean
200application/json
{
  "type": "success",
  "msg": "Calendars retrieved successfully",
  "data": [
    {
      "uri": "default",
      "name": "Calendar",
      "color": "#4f46e5",
      "description": null,
      "read_only": false,
      "is_default": true
    }
  ]
}

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.