Skip to main content
GET
Listar campanhas da organização
A lista traz os dois canais juntos. Use o campo channel de cada item para distinguir campanha de ligações (voice) de campanha de mensagens (whatsapp).

Filtros

Um status fora da lista responde 400 em vez de devolver uma lista vazia — assim um erro de digitação não passa por “nenhuma campanha”.

Campos por canal

Campanhas de WhatsApp vêm com agent, phone_number, config e started_at nulos, e com template_name preenchido. Os detalhes de cada campo estão em Detalhes da campanha.
A lista não traz os destinatários, só os contadores (total_recipients, dispatched_count, completed_count, failed_count). Para ver contato a contato, e o motivo de cada falha, use o endpoint de detalhes.

Exemplo

Authorizations

Authorization
string
header
required

API Key da organização (Authorization: Bearer ik_live_xxx)

Query Parameters

page
string

Página (default: 1)

limit
string

Itens por página (default: 20, max: 100)

status
string

Filtrar por status (PENDING, IN_PROGRESS, COMPLETED, FAILED, CANCELLED)

project_id
string

Filtrar por projeto

Response

Lista de campanhas

campaigns
object[]
required
pagination
object
required