Skip to main content

GET Estado Atual do Agendamento

Devolve o mesmo formato do data dos eventos appointment.*. Serve para reconciliar: como a entrega de webhooks não é ordenada, o consumidor pode reconsultar o estado atual do recurso e comparar o version.

Autenticação necessária

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

Permissão necessária

Exige a permissão manage_webhooks.


Endpoint​

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

Parâmetros de Rota​

NomeTipoObrigatórioDescrição
idnumber✅ID do agendamento

Requisição​

curl -X 'GET' \
'https://api-dev.imagemais.com.br/api/webhooks/resources/appointments/1' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}'

Respostas​

200 Sucesso​

{
"object": "appointment",
"id": 98765,
"version": 1759771930123,
"status": "QUEUED",
"scheduled_date": "2026-10-06",
"scheduled_start": "2026-10-06T14:00:00-03:00",
"scheduled_end": "2026-10-06T14:30:00-03:00",
"timezone": "America/Sao_Paulo",
"is_fit": false,
"requested_services": [
"VIDEO"
],
"priority": null,
"notes": null,
"finished_at": null,
"patient": {
"id": 1234,
"name": "Nome Exemplo",
"cpf": "12345678900",
"birth_date": "1990-01-01",
"gender": "F",
"phone": "+5511999999999"
},
"doctor": {
"id": 4,
"name": "Nome Exemplo"
},
"requesting_doctor": {
"id": 7,
"name": "Nome Exemplo",
"council": "CRM",
"council_number": "123456",
"council_uf": "SP"
},
"procedure": {
"id": 10,
"name": "Ultrassonografia obstétrica",
"type": "IMAGEM",
"modality": "US",
"local_report": false,
"codes": [
{
"system": "SUPPLIER",
"supplier_id": 2,
"value": "USOB01"
}
]
},
"budget_id": 5501,
"consultation_id": null,
"created_at": "2026-10-05T12:00:00-03:00",
"updated_at": "2026-10-06T14:32:10-03:00"
}

Valores de status: SCHEDULED, CONFIRMED, QUEUED, IN_PROGRESS, FINISHED, CANCELED, NO_SHOW. Valores de priority: PREGNANT, ELDERLY, DISABLED, CHILD ou null. requested_services traz VIDEO só quando o vídeo do exame foi pedido e o procedimento é de imagem. cpf vem só com dígitos e phone no formato +55… (ou null se não for um telefone válido).

400 Requisição inválida​

Retornado quando o id não é numérico.

{
"message": "Validation failed (numeric string is expected)",
"error": "Bad Request",
"statusCode": 400
}

403 Sem permissão​

{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}

404 Não encontrado​

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