---
title: "List all campaigns"
method: GET
path: "/v1/campaigns"
tags: ["v1Campaigns"]
---

# List all campaigns

`GET /v1/campaigns`

## Query parameters

- `limit` number
- `cursor` string

## Response `200`

- CampaignCursorPaginatedResponseDto
  - `data` CampaignPublicDto[], required
    - `id` string, required
    - `name` string, required — Nome da campanha
    - `channelId` string — ID do canal
    - `channelIds` string[] — IDs dos canais
    - `operatorId` string — ID do operador
    - `operatorName` string — Nome do operador
    - `businessHoursId` string — ID do horário de atendimento
    - `channelType` '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' — Tipo do canal
    - `leadType` 'lead' | 'file' — Tipo dos leads
    - `normalizeBrazilPhoneNumbers` boolean — Normaliza números brasileiros adicionando DDI 55 quando aplicável
    - `scheduledTo` string — Data de agendamento
    - `nextScheduledTo` string — Próxima data de agendamento
    - `originalScheduledTo` string — Data de agendamento original
    - `finishedAtPrediction` string — Previsão de término
    - `leadsAssetUrl` string — URL do arquivo de leads
    - `message` string — Mensagem da campanha
    - `textRaw` string — Texto bruto da mensagem
    - `assetsUrls` string[] — URLs dos anexos/arquivos
    - `active` boolean — Indica se a campanha está ativa
    - `shouldCreateConversation` boolean — Indica se deve criar conversa
    - `status` 'processing' | 'scheduled' | 'executing' | 'paused' | 'awaiting-chunk' | 'awaiting-business-hours' | 'awaiting-other-campaign' | 'canceled' | 'failed' | 'done' | 'done-sent' — Status da campanha
    - `chunksCount` number — Quantidade de chunks
    - `leadsCount` number — Quantidade de leads
    - `secondsBetweenMessages` number — Segundos entre as mensagens
    - `secondsBetweenChunks` number — Segundos entre os chunks
    - `trackAllChannels` boolean — Indica se deve rastrear todos os canais
    - `trackMaxHours` number — Máximo de horas de rastreamento
    - `chunkSize` number — Tamanho do chunk
    - `template` object — Template da campanha
    - `progress` number — Progresso da campanha
    - `resultCounts` CampaignResultCounts
      - `sent` number, required — Quantidade de mensagens enviadas
      - `received` number, required — Quantidade de mensagens recebidas
      - `read` number, required — Quantidade de mensagens lidas
      - `answered` number, required — Quantidade de mensagens respondidas
      - `chunksExecuted` number, required — Quantidade de chunks executados
      - `byChunkId` object — Resultados agrupados por ID do lote
    - `messagesProcessed` number — Quantidade de mensagens processadas
    - `lastMessageProcessedAt` string, date-time — Data de processamento da última mensagem
    - `healthCheckData` HealthCheckData
      - `messagesProcessed` number, required — Quantidade de mensagens processadas
      - `lastMessageProcessedAt` string, date-time, required — Data de processamento da última mensagem
      - `healthCheckExecutions` number, required — Quantidade de execuções do health check
      - `jobId` string — ID do job
      - `chunkId` string — ID do lote
      - `nextHealthCheckAt` string, date-time — Data do próximo health check
      - `lastHealthCheckAt` string, date-time — Data do último health check
  - `nextCursor` object, nullable, required — Cursor for the next page. Null if there are no more results.

---

[API](https://skmtc.net/kinbox/apis/kinbox-api.md) · [All operations](https://skmtc.net/kinbox/apis/kinbox-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kinbox/kinbox-api/versions/c8469f0ba490/schema)