Skip to main content
GET
Listar contatos

Authorizations

Authorization
string
header
required

Chave de API da Arara (ara_live_...), enviada no header Authorization: Bearer ara_live_.... Crie e gerencie as chaves no painel: https://app.ararahq.com/dashboard/apikeys. O valor completo aparece uma única vez, na criação.

Headers

X-Waba-Id
string<uuid>

Restringe o resultado a uma conta WhatsApp Business (WABA) da organização.

Query Parameters

q
string

Busca por nome, telefone ou email.

lifecycle
enum<string>

Estágio do contato. ALL (ou omitido) traz todos.

Available options:
ALL,
NEW,
ENGAGED,
SILENT,
DORMANT,
OPTED_OUT
page
integer
default:0

Página, começando em 0.

Required range: x >= 0
size
integer
default:20

Itens por página. Máximo 200.

Required range: 1 <= x <= 200

Response

Página de contatos

contacts
object[]
required
total
integer<int64>
required
page
integer
required
size
integer
required
totalPages
integer
required