Skip to main content
GET
Listar campanhas

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

page
integer
default:0

Página, começando em 0.

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

Itens por página, de 1 a 100.

Required range: 1 <= x <= 100
status
enum<string>

Filtra 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

Response

Página de campanhas

content
object[]
required
totalPages
integer
required
totalElements
integer<int64>
required