Saltar al contenido

Lista os membros da comunidade

GET/api/members

Auth
Requiere token
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

Lista da página Membros, para a equipe (owner, admin, moderador e financeiro). Busca, filtros (papel, tags, grupos, atividade e entrada no período), ordenação e paginação combinam entre si. Com `fields`, cada item traz as colunas extras pedidas (telefone, grupos, plano, campos customizados) — todas já visíveis a esses papéis na ficha do membro. Cada item traz `name`, o nome da pessoa como aparece nesta comunidade (o `displayName`, se houver, senão o nome da conta).

Parámetros

NombreDóndeTipoDescripción
pageopcionalqueryintegerPage must be a positive integer
limitopcionalqueryintegerLimit must be between 1 and 100
searchopcionalquerystringProcura, sem diferenciar maiúsculas nem acentos, em nome de exibição, nome completo, e-mail, cargo (`jobTitle`), frase (`tagline`), tags, nome dos grupos e valores dos campos customizados de texto e de seleção (pelo valor guardado e pelo rótulo da opção). Um termo só de dígitos e pontuação de telefone (4 dígitos ou mais) procura também no telefone. `pagination.total` conta o resultado da busca com os demais filtros.
roleopcionalqueryowner | admin | moderator | member | financeInvalid role
activeFromopcionalquerystring (date)Só quem teve atividade no período (post, artigo, comentário, reação e as demais ações que o card "Membros ativos" do Dashboard conta), de `activeFrom` a `activeTo`, datas AAAA-MM-DD inclusivas no fuso da comunidade. A regra é a mesma do Dashboard: com `activeFrom` = hoje − 6 dias e `activeTo` = hoje, `pagination.total` é o valor do card. Sem um dos lados, o período fica aberto daquele lado. Data inválida ou início depois do fim devolve 400.
activeToopcionalquerystring (date)Fim do período de atividade (inclusivo, AAAA-MM-DD, fuso da comunidade). Ver `activeFrom`.
joinedFromopcionalquerystring (date)Só quem entrou na comunidade (`joinedAt`) de `joinedFrom` a `joinedTo`, datas AAAA-MM-DD inclusivas no fuso da comunidade. A lista mostra só quem continua na comunidade: quem entrou e saiu no período conta nas "entradas" do card Crescimento, mas não aparece aqui. Data inválida ou início depois do fim devolve 400.
joinedToopcionalquerystring (date)Fim do período de entrada (inclusivo, AAAA-MM-DD, fuso da comunidade). Ver `joinedFrom`.
sortByopcionalquerystringColuna da ordenação: `joinedAt` (padrão), `lastSeenAt`, `displayName`, `fullName`, `role`, `jobTitle` ou um campo customizado como `campo_<key>`. No campo customizado, quem não preencheu fica por último nos dois sentidos, NUMBER ordena como número e SELECT pelo rótulo da opção; chave que não existe (ou campo apagado) volta à ordem padrão. Combina com todos os filtros e com a paginação.
fieldsopcionalquerystringColunas extras, separadas por vírgula. Sem `fields`, o item não muda. Chaves: `phone` (acrescenta `phone`, E.164, e `phoneCountry` no item); `groups` (`groups: [{ id, name, color, isPrimary }]`); `plan` (`plan: { subscriptionId, productId, title, status } | null`, a assinatura viva mais recente que não é complemento; só para owner, admin e financeiro, como em `/api/subscriptions`: para o moderador a chave não vem); `campo_<key>` (um campo customizado) ou `customFields` (todos) acrescentam `customFields: { <key>: { type, value } }`, com o valor cru como é guardado (número com ".", data AAAA-MM-DD, `value` da opção, "true"/"false") ou `null` — o app formata. `jobTitle`, `tagline`, `joinedAt`, `lastSeenAt` e `tags` já vêm sempre no item. Chave desconhecida ou de campo apagado é ignorada, para uma escolha de colunas salva no app não quebrar a lista.
orderopcionalqueryasc | descOrder must be asc or desc

Headers

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

Respuestas

CódigoDescripción
200Operação realizada com sucesso.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token anterior à F-31 F3 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.
500Erro interno do servidor.

Ejemplo con curl

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