Lista as campanhas da comunidade
GET/api/campaigns
- Auth
- Jeton requis
- Clé d’API:
- campaigns:read
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.
Owner, admin, moderador e financeiro (a equipe vê o mesmo). Mais recentes primeiro; cada item traz o último disparo (`lastRun`) com os contadores.
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
pagefacultatif | query | integer | |
limitfacultatif | query | integer | |
statusfacultatif | query | DRAFT | SCHEDULED | SENDING | SENT | PAUSED | CANCELED | |
sentFromfacultatif | query | string (date) | Só campanhas (manuais e automáticas) com um envio no período, de `sentFrom` a `sentTo`, datas AAAA-MM-DD inclusivas no fuso da comunidade. Conta o disparo que saiu (em envio ou concluído) pelo início dele, a mesma regra do resumo de `GET /api/campaigns/stats`. Sem um dos lados, o período fica aberto daquele lado. Data inválida ou início depois do fim devolve 400. |
sentTofacultatif | query | string (date) | Fim do período de envio (inclusivo, AAAA-MM-DD, fuso da comunidade). Ver `sentFrom`. |
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Réponses
| Statut | Description |
|---|---|
200 | Página de campanhas. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`). |
403 | Autenticado, mas sem permissão para esta operação. |
500 | Erro interno do servidor. |
Exemple curl
curl -X GET "https://api.memberfy.net/api/campaigns" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"