Appointments

List appointments (agenda)

List the appointments visible to the authenticated caller, tenant-scoped by role, sorted by start time. Filter by a start-time range and status, paginated.

get/v1/appointments

Request

  • Base URL
    https://scribe-api.telepatia.ai
  • Auth
    HTTP bearer

Query parameters

startFromstring nullable

ISO-8601 lower bound on start (inclusive).

startTostring nullable

ISO-8601 upper bound on start (inclusive).

statusAppointmentStatus[] nullable

Filter by one or more statuses (repeatable).

consultationInternalIdstring nullable

Filter to the booking that carries this consultation id.

pageinteger

Page number (1-based).

limitinteger

Number of items per page.

Response

Successful Response

totalinteger nullable

Total appointments matching the filter (null on later pages).

pageinteger required

Current page number (1-based).

limitinteger required

Number of items per page.

totalPagesinteger nullable

Total number of pages (null when the total is unknown).

hasMoreboolean required

Whether another page likely exists (accurate on every page).

Example response

{
  "items": [
    {
      "appointmentType": "follow-up",
      "consultationInternalId": "CONSULT-12345",
      "createdAt": "2026-08-28T12:00:00.000Z",
      "end": "2026-09-01T14:30:00.000Z",
      "id": "apt_a1b2c3d4e5f6g7h8",
      "medicalRecordConfigurationId": "mrc_a1b2c3d4e5f6g7h8",
      "minutesDuration": 30,
      "reason": "Follow-up",
      "scribeSessionModality": "TELEMEDICINE",
      "serviceType": "cardiology",
      "start": "2026-09-01T14:00:00.000Z",
      "status": "booked"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.