OrbitSenderDocs
ReferenceParceiro

Listar campanhas (parceiro)

GET
/api/external/partner/campaigns

Lista as campanhas do tenant com paginação (20 por página). A resposta passa pela allowlist de parceiro: apenas id_campaign, name, status e created_at — sem conteúdo de mensagem, segmentos ou PII. Requer o scope campaigns:read.

Authorization

x-api-key<token>

Chave de API no formato sk_live_..., no header x-api-key.

In: header

Query Parameters

page?integer

Número da página.

Range1 <= value
Default1

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/external/partner/campaigns"
{  "success": true,  "total": 0,  "page": 0,  "per_page": 20,  "pages": 0,  "campaigns": [    {      "id_campaign": "campaign_1234",      "name": "string",      "status": "string",      "created_at": "2019-08-24T14:15:22Z"    }  ]}
{  "success": false,  "error": "Unauthorized",  "message": "Chave de API inválida ou ausente."}
{  "success": false,  "error": "Forbidden",  "message": "Limite de canais atingido.",  "current": 5,  "max": 5}
{  "success": false,  "error": "Too Many Requests",  "code": "rate_limited",  "message": "Muitas requisições. Tente novamente em instantes."}
{  "success": false,  "error": "Internal Server Error",  "message": "Erro interno ao processar a requisição."}