E-mails da biblioteca
GET/api/emails
- Auth
- Exige token
- Chave de API:
- reports:read
- X-CommunityId
X-CommunityIdEnvie o X-CommunityId da comunidade em que a operação acontece.
Owner, admin, moderador e financeiro. Cada e-mail com idiomas, versões e onde é usado. Filtros `usage` e `q` (nome).
Parâmetros
| Nome | Onde | Tipo | Descrição |
|---|---|---|---|
usageopcional | query | FREE | DEFAULT_OVERRIDE | |
qopcional | query | string | |
pageopcional | query | integer | |
limitopcional | query | integer |
Headers
| Nome | Tipo | Descrição |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Respostas
| Código | Descrição |
|---|---|
200 | Os e-mails. |
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. |
Exemplo com curl
curl -X GET "https://api.memberfy.net/api/emails" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"