List saved contacts

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

Contacts in one address book (book, default default).

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.
404 Address book not found.

Parameters

NameInTypeDescription
bookquerystring

Request

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

Response

Successful Response

  • dataarray<object>
    • idstring
    • etagstring
    • bookstring
    • read_onlyboolean
    • uidstring or null
    • full_namestring or null
    • first_namestring or null
    • last_namestring or null
    • emailsarray<object>
      • addressstring
      • typestring or null
    • phonesarray<object>
      • numberstring
      • typestring or null
    • organizationstring or null
    • titlestring or null
    • addressstring or null
    • notestring or null
    • birthdaystring or null

      YYYY-MM-DD.

200application/json
{
  "type": "success",
  "msg": "Contacts retrieved successfully",
  "data": [
    {
      "id": "5d41402a.vcf",
      "etag": "\"c0ffee\"",
      "book": "default",
      "read_only": false,
      "uid": "5d41402a",
      "full_name": "Tunde Bello",
      "first_name": "Tunde",
      "last_name": "Bello",
      "emails": [
        {
          "address": "tunde@example.com",
          "type": "work"
        }
      ],
      "phones": [
        {
          "number": "+234 803 000 0000",
          "type": "mobile"
        }
      ],
      "organization": "Example Ltd",
      "title": "CFO",
      "address": null,
      "note": null,
      "birthday": null
    }
  ]
}

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`.
404Address book not found.
422Validation Error

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