GET/transactional-api/list-called-in-appointments/:siteId

List Called-in Appointments

Returns pending appointments at the given site whose arrival status is currently Called In, ordered by intended start time. An appointment drops off this list once its consultation starts, its called-in status is cleared, or it is marked as Did Not Attend.

Authorization: Bearer token (JWT). See Authentication.

Request

curl -L -X GET 'https://{tenantId}.api.england.medicus.health/transactional-api/list-called-in-appointments/:siteId' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <token>'

Path and query parameters

Name	In	Type	Required	Description
siteId	path	string<uuid>	Yes	Site to list called-in appointments for.

Responses

200 Called-in appointments for the given site.

[
  {
    "appointmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "patientName": "string",
    "roomName": "string",
    "calledInAt": "2025-01-01T09:30:00Z"
  }
]

400 The siteId is not a valid UUID.

{
  "errors": [
    {
      "code": "invalid-site-id",
      "description": "The siteId is not a UUID"
    }
  ]
}

404 No site found for the given siteId.

{
  "errors": [
    {
      "code": "site-not-found",
      "description": "Site not found for this siteId"
    }
  ]
}