Skip to main content
GET
Listar contatos

Autorizações

Authorization
string
header
obrigatório

Token da API no formato sk_live_….

Parâmetros de consulta

page
integer
padrão:1

Número da página, começando em 1. Um valor inválido é tratado como 1.

Intervalo obrigatório: x >= 1
perPage
integer
padrão:20

Quantidade de itens por página. O máximo depende do ambiente (padrão 100).

Intervalo obrigatório: 1 <= x <= 100

Busca livre por nome, número, código ou LID. Um termo só com dígitos também encontra o contato pelo id.

tagsIds
string

Ids de tags, separados por vírgula. Traz os contatos que têm atendimento com alguma dessas tags. Tag que não é da sua empresa responde 422 (ERR_API_INVALID_REFERENCE).

channelsIds
string

Ids de canais, separados por vírgula. Traz os contatos cujo último canal de conversa é um desses. Canal que não é da sua empresa responde 422 (ERR_API_INVALID_REFERENCE).

name
string

Filtra pelo nome.

number
string

Filtra pelo telefone. Só os dígitos são comparados: +55 (11) 99999 vale o mesmo que 5511999999. Sem nenhum dígito, responde 422.

email
string

Filtra pelo e-mail.

code
string

Filtra pelo código do contato no seu sistema.

origin
string

Filtra pela origem.

cpfCnpj
string

Filtra pelo CPF ou CNPJ.

lid
string

Filtra pelo LID do WhatsApp.

instagramUsername
string

Filtra pelo usuário do Instagram. O @ é opcional.

sourceUrl
string

Marketing — filtra pela página de origem.

sourceId
string

Marketing — filtra pelo id da origem (ex.: id do anúncio).

headline
string

Marketing — filtra pelo título do anúncio.

mediaType
string

Marketing — filtra pelo tipo da mídia de origem.

mediaUrl
string

Marketing — filtra pela URL da mídia de origem.

utmSource
string

Marketing — filtra pelo utm_source.

utmMedium
string

Marketing — filtra pelo utm_medium.

utmCampaign
string

Marketing — filtra pelo utm_campaign.

utmId
string

Marketing — filtra pelo utm_id.

fbclid
string

Marketing — filtra pelo fbclid (clique em anúncio da Meta).

gclid
string

Marketing — filtra pelo gclid (clique em anúncio do Google).

ctwaClid
string

Marketing — filtra pelo ctwa_clid (clique em anúncio Click to WhatsApp).

customFields
object

Filtra por campo personalizado de contato, no formato customFields[<key>]=<valor> — a key é a mesma de GET /custom-fields?application=contact e da lista customFields de cada contato. Dá para enviar vários campos; o contato precisa atender a todos.

Campos de texto, texto longo, e-mail, telefone e link buscam por parte do valor. Os demais (número, moeda, data, seleção e sim/não) exigem o valor exato — data no formato DD/MM/AAAA.

Uma key que não é de um campo de contato da sua empresa responde 422 (ERR_API_INVALID_REFERENCE); um valor que não combina com o tipo do campo, 422 (ERR_API_VALIDATION).

from
string<date>

Traz contatos criados a partir desta data, no fuso horário da empresa.

to
string<date>

Traz contatos criados até esta data, no fuso horário da empresa.

Resposta

OK

data
object[]
meta
object
Exemplo: