Sign in

v2

latestOpenAPI 3.0.02026-07-31355176194.7 KB
v1Contacts

List all contacts

get/v1/contacts

Query parameters

limitnumber

A limit on the number of objects to be returned. Limit can range between 1 and 100.

cursorstring

A cursor for use in pagination. The cursor is the id of the last object returned in the previous request.

created_at_fromstring

Only return contacts that were created after this date.

created_at_tostring

Only return contacts that were created before this date.

phonestring

Only return contacts that have this phone number.

emailstring

Only return contacts that have this email address.

Response

nextCursorobject nullable required

Cursor for the next page. Null if there are no more results.

Example response

{
  "data": [
    {
      "name": "João Silva",
      "email": "joaosilva@gmail.com",
      "phone": "5585997281648",
      "customFields": {
        "cpf": {
          "value": "060.715.303-54"
        }
      }
    }
  ]
}