Listar campanhas
curl --request GET \
--url https://api.ararahq.com/v1/campaigns \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ararahq.com/v1/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.ararahq.com/v1/campaigns"
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/campaigns",
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;
}{
"content": [
{
"id": "7b3789fb-4c5d-6789-abcd-ef0123456789",
"name": "Black Friday 2026",
"status": "COMPLETED",
"templateName": "bf_oferta_geral",
"totalMessages": 50000,
"sentCount": 48500,
"deliveredCount": 47200,
"readCount": 38900,
"failedCount": 900,
"totalCost": 19175,
"scheduledAt": null,
"createdAt": "2026-11-27T18:00:00Z"
}
],
"totalPages": 1,
"totalElements": 1
}Campanhas
Listar campanhas
Envelope { content, totalPages, totalElements } (não segue o padrão
{ data, pagination }). Permissão: READ.
GET
/
v1
/
campaigns
Listar campanhas
curl --request GET \
--url https://api.ararahq.com/v1/campaigns \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ararahq.com/v1/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.ararahq.com/v1/campaigns"
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/campaigns",
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;
}{
"content": [
{
"id": "7b3789fb-4c5d-6789-abcd-ef0123456789",
"name": "Black Friday 2026",
"status": "COMPLETED",
"templateName": "bf_oferta_geral",
"totalMessages": 50000,
"sentCount": 48500,
"deliveredCount": 47200,
"readCount": 38900,
"failedCount": 900,
"totalCost": 19175,
"scheduledAt": null,
"createdAt": "2026-11-27T18:00:00Z"
}
],
"totalPages": 1,
"totalElements": 1
}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
Página, começando em 0.
Required range:
x >= 0Itens por página, de 1 a 100.
Required range:
1 <= x <= 100Filtra por status da campanha.
SCHEDULED: agendada, aguardando o horário.INGESTING: processando contatos e enfileirando envios.AB_TESTING: teste A/B em andamento.COMPLETED: todos os contatos processados.COMPLETED_WITH_ERRORS: processada, com contatos bloqueados.FAILED: falha geral no processamento.CANCELED: cancelada.
Available options:
SCHEDULED, INGESTING, AB_TESTING, COMPLETED, COMPLETED_WITH_ERRORS, FAILED, CANCELED