Aller au contenu

Lista os convidados

GET/api/visitors/spaces/{spaceId}/invitations

Auth
Jeton requis
Clé d’API:
visitors: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.

O membro vê **só os seus** (os que ele recebe ou cadastrou), em qualquer data. Moderador e financeiro veem também os esperados **de hoje** (todos os anfitriões). Owner e admin veem qualquer data. Ordem por horário esperado. `status` aceita `EXPECTED` (hoje em diante), `ARRIVED`, `CANCELED` e `NO_SHOW` (derivado: esperado de um dia que já passou). `from` e `to` são dias `AAAA-MM-DD` (inclusivos) no fuso da comunidade.

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirepathstring (uuid)
statusfacultatifqueryEXPECTED | ARRIVED | CANCELED | NO_SHOW
fromfacultatifquerystringAAAA-MM-DD
tofacultatifquerystringAAAA-MM-DD
qfacultatifquerystringParte do nome ou da empresa.
hostMemberIdfacultatifquerystring (uuid)Só os convidados deste anfitrião (vale dentro do que quem chama já pode ver; útil para owner e admin).
pagefacultatifqueryinteger
limitfacultatifqueryinteger

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
200Página de convidados.
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.
404Recurso não encontrado.
500Erro interno do servidor.

Exemple curl

curl -X GET "https://api.memberfy.net/api/visitors/spaces/<spaceId>/invitations" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"