Listar Campanhas

Recupera uma lista paginada de campanhas.

GET /external/v1/campaigns

Autenticacao

Requer chave de API com permissao campaigns:read.

Parametros de Query

Parametro	Tipo	Padrao	Descricao
status	string	-	Filtrar por status da campanha
page	number	1	Numero da pagina
limit	number	50	Itens por pagina (max 100)

Resposta

{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Tech Founders SF Q1",
      "status": "active",
      "automation_active": true,
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-03-20T14:22:00Z",
      "contact_count": 250
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 50,
    "total": 12,
    "total_pages": 1,
    "has_next": false,
    "has_prev": false
  }
}

Exemplo

cURL

curl --request GET \
  --url "https://app.getraze.com/external/v1/campaigns?status=active" \
  --header "X-API-Key: YOUR_API_KEY"

JavaScript

const response = await fetch(
  'https://app.getraze.com/external/v1/campaigns?status=active',
  {
    headers: { 'X-API-Key': 'YOUR_API_KEY' }
  }
);
const data = await response.json();

Python

import requests

response = requests.get(
    'https://app.getraze.com/external/v1/campaigns',
    params={'status': 'active'},
    headers={'X-API-Key': 'YOUR_API_KEY'}
)
data = response.json()

Erros

Status	Codigo	Descricao
401	MISSING_API_KEY	Nenhuma chave de API fornecida
401	INVALID_API_KEY	Chave de API invalida
403	INSUFFICIENT_PERMISSIONS	Sem permissao campaigns:read