v1

latestOpenAPI 3.0.12026-07-266184114.0 KB

Contacts

List contacts

Get user contacts with optional filters, pagination, or retrieve specific contacts by IDs (Permitted scopes: fax:all:read)

get/accounts/self/contacts

Query parameters

idsstring

Comma-separated list of contact IDs to retrieve (max 50). When provided, other search/pagination parameters are ignored.

namestring

Filter contacts by name

fax_numberstring

Filter contacts by fax number

groupsstring

Filter contacts by group name

notestring

Filter contacts by note (comment)

offsetinteger

Offset for pagination

limitinteger

Limit for pagination (max 50)

sort'name' | 'creation_date' | 'modification_date'

Field to sort by

direction'asc' | 'desc'

Sort direction

sharedboolean

If true, return shared/corporate contacts. If false, return personal contacts

Response

Response containing a list of contacts

total_countinteger

Total number of contacts matching the query

Example response

{
  "records": [
    {
      "id": "5f7a8b9c0d1e2f3a4b5c6d7e",
      "name": "John Doe",
      "fax_number": "+12025551234",
      "groups": [
        "sales",
        "department 001"
      ],
      "email": "john.doe@example.com",
      "cellphone": "+12025551235",
      "phone": "+12025551236",
      "notes": "VIP client, prefers email communication",
      "creation_date": "2024-01-15T10:30:00Z",
      "modification_date": "2024-03-20T14:45:00Z"
    }
  ]
}