Pular para o conteúdo

Lista ou consulta list

GET/api/profiles/list

Auth
Exige token
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

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

Parâmetros

NomeOndeTipoDescrição
communityIdobrigatórioquerystring (uuid)
pageopcionalqueryintegerPage must be a positive integer
limitopcionalqueryintegerLimit must be between 1 and 100
searchopcionalquerystringSearch must be a string
roleopcionalqueryowner | admin | moderator | member | financeInvalid role
sortByopcionalqueryjoinedAt | lastSeenAt | displayName | role | fullNameInvalid sortBy field
orderopcionalqueryasc | descOrder must be asc or desc

Headers

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

Respostas

CódigoDescrição
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.

Exemplo com curl

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