Skip to main content
GET
List contacts

Authorizations

Authorization
string
header
required

API token in the sk_live_… format.

Query Parameters

page
integer
default:1

Page number, starting at 1. An invalid value is treated as 1.

Required range: x >= 1
perPage
integer
default:20

Number of items per page. The maximum depends on the environment (default 100).

Required range: 1 <= x <= 100

Free search by name, number, code or LID. A digits-only term also finds the contact by id.

tagsIds
string

Tag ids, separated by commas. Returns the contacts that have a ticket with any of these tags. A tag that is not from your company returns 422 (ERR_API_INVALID_REFERENCE).

channelsIds
string

Channel ids, separated by commas. Returns the contacts whose last conversation channel is one of these. A channel that is not from your company returns 422 (ERR_API_INVALID_REFERENCE).

name
string

Filters by name.

number
string

Filters by phone number. Only the digits are compared: +55 (11) 99999 is the same as 5511999999. Without any digit, returns 422.

email
string

Filters by email.

code
string

Filters by the contact's code in your system.

origin
string

Filters by origin.

cpfCnpj
string

Filters by CPF or CNPJ.

lid
string

Filters by the WhatsApp LID.

instagramUsername
string

Filters by Instagram username. The @ is optional.

sourceUrl
string

Marketing — filters by the source page.

sourceId
string

Marketing — filters by the source id (e.g. the ad id).

headline
string

Marketing — filters by the ad headline.

mediaType
string

Marketing — filters by the source media type.

mediaUrl
string

Marketing — filters by the source media URL.

utmSource
string

Marketing — filters by utm_source.

utmMedium
string

Marketing — filters by utm_medium.

utmCampaign
string

Marketing — filters by utm_campaign.

utmId
string

Marketing — filters by utm_id.

fbclid
string

Marketing — filters by fbclid (click on a Meta ad).

gclid
string

Marketing — filters by gclid (click on a Google ad).

ctwaClid
string

Marketing — filters by ctwa_clid (click on a Click to WhatsApp ad).

customFields
object

Filters by a contact custom field, in the format customFields[<key>]=<value> — the key is the same one returned by GET /custom-fields?application=contact and in each contact's customFields list. You can send several fields; the contact must match all of them.

Text, long text, email, phone and link fields match part of the value. The others (number, currency, date, select and yes/no) require the exact value — dates in the DD/MM/YYYY format.

A key that is not a contact field of your company returns 422 (ERR_API_INVALID_REFERENCE); a value that does not match the field type, 422 (ERR_API_VALIDATION).

from
string<date>

Returns contacts created on or after this date, in the company's time zone.

to
string<date>

Returns contacts created up to this date, in the company's time zone.

Response

OK

data
object[]
meta
object
Example: