Skip to main content

GET Listar Agendamentos

Retorna a lista de agendamentos com filtros opcionais.

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.


Endpoint​

GET https://api-dev.imagemais.com.br/api/appointments

Parâmetros de Query​

NomeTipoObrigatórioDescrição
datestring✅Data dos agendamentos no formato YYYY-MM-DD
patientNamestring❌Filtrar pelo nome do paciente
statusstring❌Filtrar pelo status (busca parcial, sem diferenciar maiúsculas). Valores: Agendado, Confirmado, Na fila, Em atendimento, Cancelado, Finalizado, Faltou. all desativa o filtro
doctorIdnumber❌Filtrar pelo ID do médico
patientIdnumber❌Filtrar pelo ID do paciente
Somente médicos ativos

A listagem considera apenas agendamentos de médicos ativos e não excluídos. Para ver o histórico completo de um paciente (inclusive com médico inativo), use Buscar Agendamentos por Paciente. O resultado é ordenado por updatedAt crescente.


Requisição​

curl -X 'GET' \
'https://api-dev.imagemais.com.br/api/appointments?date=2026-05-11' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}'

Respostas​

200 Sucesso​

Retorna um array de agendamentos dentro da propriedade data.

{
"data": [
{
"id": 72,
"patientId": 55,
"date": "2026-09-18T00:00:00.000Z",
"startTime": "08:30",
"endTime": "09:00",
"notes": "",
"accountId": 1,
"isFit": false,
"createdAt": "2026-09-17T10:59:16.826Z",
"updatedAt": "2026-09-17T11:00:45.791Z",
"deletedAt": null,
"doctor": {
"id": 4,
"name": "Dr. Victor Rocha ",
"percentage": 40,
"userId": null
},
"patient": {
"dateBirth": "2000-01-02T00:00:00.000Z",
"id": 55,
"name": "Maria Oliveira Santos",
"contact": {
"phone": "(81) 99999-9999"
}
},
"priorityAppointment": null,
"status": {
"id": 5,
"name": "Finalizado",
"color": "#6B7280"
},
"appointmentProcedures": {
"price": "100",
"discountsAppointmentProcedures": null,
"procedure": {
"id": 21,
"name": "Ultrassom: Doppler Obstetrico 2/3 Trimestre",
"price": "100"
}
}
}
]
}

Estrutura do objeto de retorno​

Agendamento

CampoTipoDescrição
idnumberIdentificador único do agendamento
datestringData do agendamento (ISO 8601)
startTimestringHorário de início no formato HH:mm
endTimestringHorário de término no formato HH:mm
notesstringObservações do agendamento
patientIdnumberID do paciente
accountIdnumberID da conta associada
isFitbooleanIndica se o agendamento é um encaixe
priorityAppointmentobject | nullPrioridade do atendimento (id, name): Gestante, Idoso, PcD ou Criança
createdAtstringData de criação do registro
updatedAtstringData da última atualização
deletedAtstring | nullData de exclusão (soft delete)

doctor

CampoTipoDescrição
idnumberID do médico
namestringNome do médico
percentagenumber | nullPercentual do médico sobre os procedimentos
userIdnumber | nullID do usuário vinculado ao médico

patient

CampoTipoDescrição
idnumberID do paciente
namestringNome do paciente
dateBirthstringData de nascimento (ISO 8601)
contact.phonestringTelefone de contato

status

CampoTipoDescrição
idnumberID do status
namestringNome do status
colorstringCor em hexadecimal para exibição

appointmentProcedures

CampoTipoDescrição
pricestringPreço final após descontos
procedure.idnumberID do procedimento
procedure.namestringNome do procedimento
procedure.pricestringPreço original do procedimento
discountsAppointmentProceduresobject | nullDesconto aplicado ao procedimento (veja abaixo)

200 Sucesso — com descontos aplicados​

Quando o procedimento do agendamento tem desconto, discountsAppointmentProcedures vem como objeto (a relação é 1:1; sem desconto, vem null). Na listagem, só descontos ativos são retornados, com discountId e value.

{
"appointmentProcedures": {
"price": "100",
"discountsAppointmentProcedures": {
"value": "10",
"discountId": 3
},
"procedure": {
"id": 21,
"name": "Ultrassom: Doppler Obstetrico 2/3 Trimestre",
"price": "100"
}
}
}

discountsAppointmentProcedures

CampoTipoDescrição
discountIdnumberID do desconto aplicado
valuestringValor do desconto aplicado

400 Bad Request​

Retornado quando date não é enviado.

{
"message": [
"date must be a string"
],
"error": "Bad Request",
"statusCode": 400
}

500 Erro interno​

{
"statusCode": 500,
"message": "Internal server error"
}