Sign in

v1

latestOpenAPI 3.0.22026-08-045831103.6 KB
Contacts

List contacts

Retrieve a paginated list of contacts

get/v1/contacts

Query parameters

limitinteger

Max number of rows returned

offsetinteger

Number of rows skipped of the result

pageinteger

Select the page of the result

origin_idstring uuid
Example:8feade82-d77b-4e8b-9d35-fd43e972b5c8

Filter by origin ID

namestring
Example:Contact name

Filter by contact name

ddistring
Example:55

Filter by contact ddi

phonestring
Example:999999999

Filter by contact phone

emailstring
Example:contact@email.com

Filter by contact e-mail

tag_idsstring
Example:8feade82-d77b-4e8b-9d35-fd43e972b5c8,99999999-d77b-4e8b-9d35-fd43e972b999

Filter by contact tag IDs using OR operator. Separated by ','

tag_namesstring
Example:tag1,tag2,tag3

Filter by contact tag names using OR operator. Separated by ','

fieldsobject

Filter by contact fields. Can be used multiple times for each field

Headers

api-tokenstring required

API Token

Response

A list of contacts

statusinteger

Response status

totalCountinteger

Total items based on current filters

pageinteger

Current page

totalPagesinteger

Total pages based on current filters

hasNextboolean

Indicates that has next page

hasPreviousboolean

Indicates that has previous page

Example response

{
  "data": [
    {
      "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
      "created_at": "2020-01-01T14:15:00.000000+00:00",
      "updated_at": "2020-01-01T14:15:00.000000+00:00",
      "name": "Contact name",
      "email": "contact@email.com",
      "organization": "Organization name",
      "instagram": "Instagram ID",
      "tags": [
        {
          "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
          "name": "Tag name",
          "created_at": "2026-01-15T10:30:00.000Z"
        }
      ],
      "fullPhone": "+5548999999999"
    }
  ]
}