Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Phone Book Entries

List all contacts

Retrieves a paginated list of all contacts for the authenticated user's account.

get/contacts

Query parameters

qstring

Search term for fullName, emails, or phones

fieldsstring

Fields to include in the response

sortstring

Field to sort by, e.g., "fullName"

skipnumber

Number of records to skip

limitnumber

Number of records to return

string
OR
string[]
Example:507f1f77bcf86cd799439011,507f191e810c19729de860ea

Limit results to these ids (can be provided as comma-separated string or as multiple values)

Response

List of contacts retrieved successfully.

countnumber required

Total number of contacts matching the query

fieldsstring required

Fields included in the response

limitnumber required

Number of records to return

skipnumber required

Number of records to skip

Example response

{
  "results": [
    {
      "_id": "60d21b4667d0d8992e610c85",
      "accountId": "5a5786a0c526211500d261d9",
      "fullName": "John Doe",
      "email": "john.doe@example.com",
      "phone": "+1234567890"
    }
  ],
  "count": 1,
  "fields": "fullName email phone",
  "limit": 200
}