Skip to content

Busca de anfitrião pelo início do nome ou de qualquer palavra dele (público, com token)

GET/api/attendance/kiosk/hosts

Auth
Requires a token
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.

Procura residentes pelo **início do nome de exibição ou de qualquer palavra dele** ("Prado" acha "Ana Prado"), com pelo menos 3 letras (curingas `%` e `_` não contam) (menos: 400 com `errors`). No máximo 8 resultados, em ordem estável (nome, depois id), só quem tem acesso ao space e não foi removido. Devolve apenas `id`, `displayName`, `avatarUrl` e `initials`: nunca e-mail, telefone, papel ou plano. Limite: 30 por minuto e 300 por dia por token.

Parameters

NameInTypeDescription
qrequiredquerystring

Headers

NameTypeDescription
X-Kiosk-TokenrequiredstringToken do quiosque. A comunidade e o space saem dele; nunca vão no corpo nem no caminho.

Responses

StatusDescription
200Até 8 anfitriões.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou revogado, ou space apagado.
403Autenticado, mas sem permissão para esta operação.
429Limite de taxa (por token e por IP). Traz `Retry-After` (segundos) e `errors`.
500Erro interno do servidor.

curl example

curl -X GET "https://api.memberfy.net/api/attendance/kiosk/hosts" \
  -H "Authorization: Bearer $TOKEN"