Vai al contenuto

Lista ou consulta list

GET/api/profiles/list

Auth
Richiede un token
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.

Sujeito a verificação de papel (RBAC).

Parametri

NomeDoveTipoDescrizione
communityIdobbligatorioquerystring (uuid)
pagefacoltativoqueryintegerPage must be a positive integer
limitfacoltativoqueryintegerLimit must be between 1 and 100
searchfacoltativoquerystringSearch must be a string
rolefacoltativoqueryowner | admin | moderator | member | financeInvalid role
sortByfacoltativoqueryjoinedAt | lastSeenAt | displayName | role | fullNameInvalid sortBy field
orderfacoltativoqueryasc | descOrder must be asc or desc

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
200Operação realizada com sucesso.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
500Erro interno do servidor.

Esempio con curl

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