Skip to main content

GET Histórico de Alterações do Agendamento

Lista todas as alterações do agendamento — status, remarcação, troca de médico, edição de observações/prioridade e mudança de procedimento —, com o que mudou, quem mudou e quando. Do mais recente para o mais antigo, com paginação por cursor.

Autenticação necessária

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

Sem permissão específica

Não exige @CheckPermissions — basta estar autenticado.


Endpoint​

GET https://api-dev.imagemais.com.br/api/appointments/{id}/history

Parâmetros de Rota​

NomeTipoObrigatórioDescrição
idnumber✅ID do agendamento

Parâmetros de Query​

NomeTipoObrigatórioValores válidosDescrição
limitnumber❌inteiro de 1 a 100; padrão 20Itens por página
cursornumber❌inteiro positivoCursor de paginação (pagination.nextCursor da página anterior)

Requisição​

curl -X 'GET' \
'https://api-dev.imagemais.com.br/api/appointments/1/history?limit=20' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}'

Respostas​

200 Sucesso​

{
"data": [
{
"id": 121,
"type": "RESCHEDULE",
"from": null,
"to": null,
"changedAt": "2026-10-16T15:00:00.000Z",
"changedBy": {
"id": 345,
"name": "Nome Exemplo"
},
"source": "USER",
"changes": {
"date": {
"from": "2026-10-20T00:00:00.000Z",
"to": "2026-10-22T00:00:00.000Z"
},
"startTime": {
"from": "08:00",
"to": "09:30"
}
}
},
{
"id": 120,
"type": "STATUS",
"from": {
"id": 1,
"name": "Agendado",
"color": "#0d6efd"
},
"to": {
"id": 2,
"name": "Confirmado",
"color": "#198754"
},
"changedAt": "2026-10-16T14:30:00.000Z",
"changedBy": null,
"source": "SYSTEM",
"changes": null
}
],
"pagination": {
"nextCursor": null
}
}

from é null na criação do agendamento; to é null quando a alteração não muda o status. changedBy é null quando a mudança foi do sistema ou de uma API Key. source: USER, API_KEY ou SYSTEM. pagination.nextCursor é null na última página.

type e os campos que podem aparecer em changes (cada um no formato { from, to }):

typeCampos de changes
STATUS— (changes é null)
RESCHEDULEdate, startTime, endTime, doctor
DOCTOR_CHANGEdoctor
EDITnotes, priority
PROCEDURESprocedure, price, discount

400 Requisição inválida​

Retornado quando id não é numérico ou limit/cursor são inválidos:

{
"message": [
"limit must not be greater than 100"
],
"error": "Bad Request",
"statusCode": 400
}

404 Não encontrado​

{
"message": "Agendamento não encontrado",
"error": "Not Found",
"statusCode": 404
}

500 Erro interno​

{
"message": "Erro ao buscar histórico do agendamento",
"error": "Internal Server Error",
"statusCode": 500
}