Skip to main content
GET
Listar agendamentos

Authorizations

Authorization
string
header
required

Chave de API no formato bd_live_xxxxxxxx.xxxx...

Query Parameters

cursor
string

Cursor de paginação retornado em next/previous.

end_date
string<date>
modality
enum<string>
  • in_person - Presencial
  • telehealth - Teleconsulta
Available options:
in_person,
telehealth
page_size
integer

Resultados por página (padrão 50, máximo 100).

patient_id
integer
professional_id
integer
room_id
integer
start_date
string<date>
status
enum<string>

One of: requested, scheduled, confirmed, checked_in, completed, no_show, cancelled.

Available options:
cancelled,
checked_in,
completed,
confirmed,
no_show,
requested,
scheduled
updated_since
string<date-time>

Response

200 - application/json
results
object[]
required
next
string<uri> | null
Example:

"https://api.bydoctor.com.br/api/public/v1/appointments?cursor=cD00ODY%3D"

previous
string<uri> | null
Example:

"https://api.bydoctor.com.br/api/public/v1/appointments?cursor=cj0xJnA9NDg3"