List address books

GET/api/v1/mailbox/address-book/books
Requires amailbox token— it acts as one mailbox holder, not as the organization.

The personal collection, plus anything shared with the mailbox.

read_only is reported off the server's own privilege set rather than guessed from the name, so a UI can hide editing controls on a collection the server would refuse to write anyway — the company directory being the case that matters.

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

Response

Successful Response

  • dataarray<object>
    • uristring

      Use as book in the contact calls.

    • namestring
    • descriptionstring or null
    • read_onlyboolean
200application/json
{
  "type": "success",
  "msg": "Address books retrieved successfully",
  "data": [
    {
      "uri": "default",
      "name": "Contacts",
      "description": null,
      "read_only": false
    }
  ]
}

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.