Aller au contenu

Lista ou consulta autocomplete

GET/api/members/autocomplete

Auth
Jeton requis
Clé d’API:
members:read
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

Sujeito a verificação de papel (RBAC). Para a equipe (owner, admin, moderador, financeiro), `search` casa com o nome mostrado, o nome da conta e o e-mail; para quem não é da equipe, em qualquer modo do chat, casa só com o nome mostrado (o `displayName`, ou o nome da conta quando não há apelido), nunca com o e-mail.

Paramètres

NomEmplacementTypeDescription
searchfacultatifquerystringProcura, 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-mail, URL e seleção (esta 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 e nos campos customizados de telefone, comparando só os dígitos. `pagination.total` conta o resultado da busca com os demais filtros.

En-têtes

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

Réponses

StatutDescription
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 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.
500Erro interno do servidor.

Exemple curl

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