Aller au contenu

Busca de pessoas com horários livres

GET/api/scheduling/hosts

Auth
Jeton requis
Qui peut l’appeler:
owner
Clé d’API:
scheduling: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.

Quem acessa o space. Devolve só quem tem horário livre na janela, cada pessoa com as suas agendas, o total de horários livres e os próximos 3 (`nextSlots`), cada um dizendo se é gratuito (`free`) ou o custo em créditos (`creditCost`) e se o saldo de quem chama cobre (`canAfford`, falso também quando o plano em atraso ou pausado não pode gastar crédito, a mesma regra de reservar). Com vínculo vivo a uma empresa não encerrada, o saldo da empresa também conta: `affordableWith` diz qual carteira cobre (`own` primeiro, depois `company`, o mesmo `payWith` de `POST /api/bookings`; `null` quando nenhuma) e `companyWallet` traz `{ companyId, name, balance }` (nulo sem empresa que possa pagar). Sem `date`, a janela são os próximos 14 dias. Quando ninguém tem horário, `data.nextSlots` sugere os mais próximos de qualquer pessoa. Agenda cujo dono perdeu o papel exigido ou o acesso ao space não aparece; a própria agenda de quem chama também não. Horário sem sufixo é a hora local da comunidade.

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirequerystring (uuid)
qfacultatifquerystringParte do nome da pessoa ou da agenda.
datefacultatifquerystringDia (AAAA-MM-DD, hora local da comunidade).
fromfacultatifquerystringInício da janela do dia.
tofacultatifquerystringFim da janela do dia.
durationMinutesfacultatifqueryinteger
hostMemberIdfacultatifquerystring (uuid)
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
200Pessoas.
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/scheduling/hosts" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"