PEPINO ZAPdocs
Referência da APICampanhas

Lista as campanhas do projeto

Ver como Markdown
GET
/v1/campaigns

Lista as campanhas de disparo em massa do Projeto, com os contadores de progresso (total de destinatarios, enviados e falhos) e os marcos de tempo. Apenas leitura — segura para polling de status e LIBERADA sem add-on/assinatura (o gate comercial incide so em criar/disparar). Retorna ate 100 itens (sem paginacao).

Authorization

bearerAuth
AuthorizationBearer <token>

API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/campaigns"
{
  "items": [
    {
      "id": "camp_3Hk9Zq2pVxL",
      "name": "Promo Junho",
      "status": "COMPLETED",
      "pausedReason": null,
      "totalRecipients": 1500,
      "sentCount": 1487,
      "failedCount": 13,
      "startedAt": "2026-06-07T14:02:11Z",
      "completedAt": "2026-06-07T16:09:55Z",
      "createdAt": "2026-06-07T13:55:00Z"
    }
  ]
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key ausente ou invalida"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Projeto inativo ou sem permissao"
  }
}