Listar contatos
curl --request GET \
--url https://api.ararahq.com/v1/contacts \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ararahq.com/v1/contacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.ararahq.com/v1/contacts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ararahq.com/v1/contacts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"contacts": [
{
"id": "1f2e3d4c-5b6a-7890-abcd-ef1234567890",
"name": "João Silva",
"phone": "+5511999999999",
"email": "joao@exemplo.com",
"attributes": {
"plano": "pro"
},
"tags": [
"vip"
],
"createdAt": "2026-09-01T14:30:00Z",
"lifecycle": "ENGAGED",
"source": "API",
"outboundCount": 12,
"inboundCount": 3,
"firstSeenAt": "2026-09-01T14:30:00Z",
"lastOutboundAt": "2026-09-14T10:00:00Z",
"lastInboundAt": "2026-09-14T10:05:00Z",
"lastMessageAt": "2026-09-14T10:05:00Z",
"optOutAt": null,
"lastTemplateName": "pedido_confirmado"
}
],
"total": 123,
"page": 123,
"size": 123,
"totalPages": 123
}Contatos
Listar contatos
Contatos da organização, no envelope
{ contacts, total, page, size, totalPages } (não segue o padrão
{ data, pagination }). Exige plano com contatos (403 PLAN_FEATURE_LOCKED).
Permissão: ADMIN.
GET
/
v1
/
contacts
Listar contatos
curl --request GET \
--url https://api.ararahq.com/v1/contacts \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ararahq.com/v1/contacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.ararahq.com/v1/contacts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ararahq.com/v1/contacts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"contacts": [
{
"id": "1f2e3d4c-5b6a-7890-abcd-ef1234567890",
"name": "João Silva",
"phone": "+5511999999999",
"email": "joao@exemplo.com",
"attributes": {
"plano": "pro"
},
"tags": [
"vip"
],
"createdAt": "2026-09-01T14:30:00Z",
"lifecycle": "ENGAGED",
"source": "API",
"outboundCount": 12,
"inboundCount": 3,
"firstSeenAt": "2026-09-01T14:30:00Z",
"lastOutboundAt": "2026-09-14T10:00:00Z",
"lastInboundAt": "2026-09-14T10:05:00Z",
"lastMessageAt": "2026-09-14T10:05:00Z",
"optOutAt": null,
"lastTemplateName": "pedido_confirmado"
}
],
"total": 123,
"page": 123,
"size": 123,
"totalPages": 123
}Authorizations
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
Restringe o resultado a uma conta WhatsApp Business (WABA) da organização.
Query Parameters
Busca por nome, telefone ou email.
Estágio do contato. ALL (ou omitido) traz todos.
Available options:
ALL, NEW, ENGAGED, SILENT, DORMANT, OPTED_OUT Página, começando em 0.
Required range:
x >= 0Itens por página. Máximo 200.
Required range:
1 <= x <= 200