v51

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-02172186551.1 KB

List contacts

List contacts with their communication channels.

get/v1/contacts

Query parameters

phoneNumberstring

limitinteger

cursorstring

Response

List of contacts.

nextCursorstring nullable

Example response

{
  "items": [
    {
      "displayName": "John Doe",
      "phoneNumber": "+56912345678",
      "primaryPhone": "+56912345678",
      "primaryEmail": "john@example.com",
      "countryCode": "CL",
      "profileName": "John Doe",
      "channels": [
        {
          "identifier": "+14155551234",
          "countryCode": "US",
          "label": "work"
        }
      ]
    }
  ]
}