Listar campanhas
Busca as campanhas de e-mail do workspace.
GET
https://external-api.lip7.com.br/api/external/email/campaignsEscopo
email:campaigns:readSíncrono — responde 200 com os dadosRetorna no formato data + pagination — veja Paginação.
Query params
pagenumberopcionalpadrão 1Número da página.
limitnumberopcionalpadrão 20Itens por página, com máximo de 100.
statusstringopcionalFiltra pelo status da campanha.
valores
DRAFTSCHEDULEDSENDINGSENTPAUSEDCANCELLEDCOMPLETEDFAILEDsearchstringopcionalBusca por termo no nome da campanha.
Status possíveis
| Status | Significado |
|---|---|
DRAFT | Criada, ainda não disparada |
SCHEDULED | Agendada para um horário futuro |
SENDING | Disparo em andamento |
SENT | Disparo concluído |
PAUSED | Pausada durante o envio |
CANCELLED | Cancelada antes de concluir |
COMPLETED | Finalizada com todas as entregas processadas |
FAILED | Falhou durante o processamento |
Requisição
curl -X GET "https://external-api.lip7.com.br/api/external/email/campaigns?status=SENT" \
-H "x-api-key: lip_SUA_CHAVE"Resposta
{
"success": true,
"data": [
{
"id": "camp_...",
"name": "Promo Junho",
"subject": "Ofertas especiais",
"status": "SENT"
}
],
"pagination": { "page": 1, "limit": 20, "total": 1, "totalPages": 1 }
}