Saltar al contenido

Busca de pessoas com horários livres

GET/api/scheduling/hosts

Auth
Requiere token
Quién puede:
owner
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.

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). 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.

Parámetros

NombreDóndeTipoDescripción
spaceIdobligatorioquerystring (uuid)
qopcionalquerystringParte do nome da pessoa ou da agenda.
dateopcionalquerystringDia (AAAA-MM-DD, hora local da comunidade).
fromopcionalquerystringInício da janela do dia.
toopcionalquerystringFim da janela do dia.
durationMinutesopcionalqueryinteger
hostProfileIdopcionalquerystring (uuid)
pageopcionalqueryinteger
limitopcionalqueryinteger

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
200Pessoas.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

Ejemplo con curl

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