Pular para o conteúdo

GET /v1/calendar/waitlist/services/{serviceId}

GET
/v1/calendar/waitlist/services/{serviceId}
curl --request GET \
--url 'https://seu-endereco-da-api/v1/calendar/waitlist/services/example?from=example&to=example' \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Ler agenda (calendar:read).

serviceId
required
string
from
required
string
to
required
string
cursor
string
limit
number
>= 1
Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
status
required
string
contactId
required
string
contactName
required
string
serviceId
required
string
serviceName
required
string
resourceId
required
string
nullable
resourceName
required
string
nullable
insuranceId
required

Convênio pedido: só recebe vaga de profissional que aceita

string
nullable
insuranceName
required
string
nullable
preferredFrom
required
string format: date-time
nullable
preferredTo
required
string format: date-time
nullable
offeredStartsAt
required

Início do horário oferecido quando a vaga abriu

string format: date-time
nullable
offeredEndsAt
required

Fim do horário oferecido, pela duração do serviço

string format: date-time
nullable
offeredResourceId
required
string
nullable
offeredResourceName
required
string
nullable
offerExpiresAt
required

Até quando a oferta vale antes de ir para o próximo da fila

string format: date-time
nullable
conversationId
required
string
nullable
createdAt
required
string format: date-time
nextCursor
required
string
nullable

Example generated

{
"items": [
{
"id": "example",
"status": "example",
"contactId": "example",
"contactName": "example",
"serviceId": "example",
"serviceName": "example",
"resourceId": "example",
"resourceName": "example",
"insuranceId": "example",
"insuranceName": "example",
"preferredFrom": "2026-04-15T12:00:00Z",
"preferredTo": "2026-04-15T12:00:00Z",
"offeredStartsAt": "2026-04-15T12:00:00Z",
"offeredEndsAt": "2026-04-15T12:00:00Z",
"offeredResourceId": "example",
"offeredResourceName": "example",
"offerExpiresAt": "2026-04-15T12:00:00Z",
"conversationId": "example",
"createdAt": "2026-04-15T12:00:00Z"
}
],
"nextCursor": "example"
}