Skip to main content

GET Contar Agendamentos por Status

Retorna contagens de agendamentos agrupadas por status e encaixes.

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/count

Parâmetros de Query​

NomeTipoObrigatórioDescrição
datestring✅Data dos agendamentos no formato YYYY-MM-DD
doctorIdnumber❌Filtrar pelo ID do médico

Requisição​

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

Respostas​

200 Sucesso​

{
"data": {
"total": 0,
"encaixes": 0,
"byStatus": {
"agendado": 0,
"confirmado": 0,
"naFila": 0,
"emAtendimento": 0,
"cancelado": 0,
"finalizado": 0,
"faltou": 0
}
}
}
CampoTipoDescrição
totalnumberTotal de agendamentos do dia que não são encaixe
encaixesnumberTotal de encaixes no dia
byStatus.agendadonumberAgendamentos com status Agendado
byStatus.confirmadonumberAgendamentos com status Confirmado
byStatus.naFilanumberAgendamentos com status Na fila
byStatus.emAtendimentonumberAgendamentos com status Em atendimento
byStatus.canceladonumberAgendamentos com status Cancelado
byStatus.finalizadonumberAgendamentos com status Finalizado
byStatus.faltounumberAgendamentos com status Faltou

As contagens de byStatus desconsideram os encaixes. O resultado fica em cache por 10 segundos por conta/data/médico — alterações recentes podem levar esse tempo para aparecer.

400 Requisição inválida​

Retornado quando o parâmetro date não é enviado ou está em formato inválido.

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