Vai al contenuto

Lista o catálogo de badges da comunidade

GET/api/badges

Auth
Richiede un token
Chi può:
owner
admin
moderator
finance
Chiave API:
gamification:read
X-CommunityId
X-CommunityId Invia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.

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.

Header

NomeTipoDescrizione
X-CommunityIdfacoltativostring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Risposte

CodiceDescrizione
200O catálogo.
401Token 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`).
403Autenticado, mas sem permissão para esta operação.

Esempio con curl

curl -X GET "https://api.memberfy.net/api/badges" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"