Lista o catálogo de badges da comunidade
GET/api/badges
- Auth
- Requires a token
- Who can call it:
- owner
- admin
- moderator
- finance
- API key:
- gamification:read
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
Só owner e admin da comunidade do `X-CommunityId` (moderador, financeiro e membro: 403). Em ordem alfabética, com `holders` (quantas pessoas têm cada badge agora). Badge removido não aparece. Os badges funcionam com a gamificação ligada ou desligada.
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Responses
| Status | Description |
|---|---|
200 | O catálogo. |
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. |
curl example
curl -X GET "https://api.memberfy.net/api/badges" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"