Campanhas

Listar campanhas

Changed on Oct 12, 2026

Envelope { content, totalPages, totalElements } (não segue o padrão { data, pagination }). Permissão: READ.

get/v1/campaigns

Request

Base URL
https://api.ararahq.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ararahq/apis/ararahq-api/docs/v1/campaigns/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

pageinteger

Página, começando em 0.

sizeinteger

Itens por página, de 1 a 100.

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.

Filtra por status da campanha.

Headers

X-Waba-Idstring uuid

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

Response

Página de campanhas

totalPagesinteger required

totalElementsinteger required

Example 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
}

Changes

Oct 12, 2026d576cd28afc0 Revision changes
- info
  api tag Campanhas added
- info
  api tag campaigns removed
- info
  added the non-success response with the status
Sep 15, 2026372d8c2e735d Revision changes
- breaking
  removed the enum value PAUSED from the query request parameter status
- breaking
  removed the enum value PENDING from the query request parameter status
- breaking
  removed the enum value RUNNING from the query request parameter status
- breaking
  the response property became optional for the status
- breaking
  the // response's property format changed from float to no format for status
- breaking
  the response's property type changed from object to string for status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- warning
  removed the optional property / from the response with the status
- info
  added the new optional header request parameter X-Waba-Id
- info
  added the new enum value AB_TESTING to the query request parameter status
- info
  added the new enum value COMPLETED_WITH_ERRORS to the query request parameter status
- info
  added the new enum value INGESTING to the query request parameter status
- info
  added the new enum value SCHEDULED to the query request parameter status
- info
  added the non-success response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status

Operation history (3 revisions)