Skip to main content
GET
Listar contatos
Cada contato vem com as tags e com as colunas personalizadas preenchidas, em custom_fields. Para achar um contato pelo telefone, envie phone em E.164 (+5511987654321). O celular brasileiro com ou sem o nono dígito é o mesmo contato.

Authorizations

Authorization
string
header
required

API Key da organização (Authorization: Bearer ik_live_xxx)

Query Parameters

Parte do nome ou do e-mail (sem diferença de maiúscula) ou 3 ou mais dígitos do telefone

Required string length: 1 - 100
tag
string

Só os contatos com esta tag

Required string length: 1 - 40
phone
string

Telefone exato em E.164 (com ou sem o 9º dígito, o mesmo contato)

Maximum string length: 40
cursor
string

O pagination.next_cursor da página anterior (sem ele, a primeira página)

Maximum string length: 200
limit
string

Itens por página: inteiro (default: 20). Abaixo de 1 vale 1 e acima de 100 vale 100; o que não é inteiro responde 400

Response

Os contatos, os mais novos primeiro

contacts
object[]
required
pagination
object
required