Suggest recipients

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

Addresses this mailbox has written to or heard from, most frequent first — for autocomplete. Saved contacts are under the address book (/address-book/contacts).

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

Response

Successful Response

  • dataarray<object>
    • namestring or null
    • emailstring
    • countinteger

      How often they appear.

200application/json
{
  "type": "success",
  "msg": "Contacts retrieved successfully",
  "data": [
    {
      "name": "Tunde Bello",
      "email": "tunde@example.com",
      "count": 42
    }
  ]
}

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.