Appointments

Get an appointment by id

Get one appointment by its public id (apt_...) or the consultationInternalId you sent when creating it. Returns 404 if no appointment with that id is visible to your key.

get/v1/appointments/{appointment_id}

Request

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

Path parameters

appointment_idstring required

Response

Successful Response

idstring required

Stable public identifier.

consultationInternalIdstring nullable
statusstring required
startstring nullable
endstring nullable
minutesDurationinteger nullable
serviceTypestring nullable
appointmentTypestring nullable
reasonstring nullable
descriptionstring nullable
scribeSessionModality'IN_PERSON' | 'TELEMEDICINE' | 'DICTATION'

Supported scribe session modalities.

medicalRecordConfigurationIdstring nullable

The template the booking opens on. Null when the booking names none, or when the template has been deleted since.

createdAtstring required

ISO-8601 timestamp when the appointment was created.

Example response

{
  "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.