Campanhas

Listar campanhas com progresso

Lista campanhas do workspace com progresso por status.

API key Escopo read

Exemplo de requisição

curl -X GET "https://seu-dominio/campaigns" \
  -H "x-api-key: $VERTICE_API_KEY"

const response = await fetch('https://seu-dominio/campaigns', {
  method: 'GET',
  headers: {
  'x-api-key': process.env.VERTICE_API_KEY ?? '',
  },
});

const payload = await response.json();
console.log(payload);

GET /campaigns

API key

Entenda

Conceituação

Lista campanhas do workspace com progresso por status.

Cada destinatário vira um job independente na fila da instância. O progresso é calculado por status e o cancelamento afeta apenas jobs pendentes.

Contrato

Atributos

1 campo

Header

x-api-key string obrigatório

API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.

Contrato

Resposta

200

{
  "data": [
    {
      "id": "cmp_...",
      "name": "Black Friday",
      "status": "completed",
      "recipients": 120,
      "stats": {
        "total": 120,
        "queued": 0,
        "sent": 118,
        "failed": 2,
        "read": 74
      }
    }
  ]
}

Respostas de sucesso são envelopadas em data.

Erros comuns

400 Corpo, query ou parâmetro inválido. A resposta traz error.code e error.message.

401 Credencial ausente, inválida ou sessão expirada.

403 Escopo insuficiente, IP não autorizado ou workspace suspenso.

429 Fila cheia, limite de tentativas ou rate limit.