Sign in
contacts

List contacts with optional filtering by mailbox and search query. For a mailbox, it returns all contacts in the mailbox and all contacts in the same domain as the mailbox.

Query parameters:

  • mailbox_id: Optional UUID to filter contacts by mailbox
  • q: Optional search query for name or email (case insensitive)
get/api/v1.0/contacts/

Query parameters

mailbox_idstring uuid

Filter contacts by mailbox ID.

qstring

Search contacts by name or email (case insensitive).

Response

idstring uuid required

primary key for the record as UUID

namestring nullable
emailstring required

Changes

Changed in 1 of the 54 revisions of this API.1

  • ba0c140b76dd1See the full diff
    • ▲

      the items/email response's property type/format changed from string/email to string/ for status 200

      response-property-type-changed