Skip to main content
GET
/
appointments
/
get
/
{id}
Get Appointment
curl --request GET \
  --url https://api.example.com/appointments/get/{id} \
  --header 'Authorization: <authorization>'
{
  "success": true,
  "data": {
    "_id": "65f8a1b2c3d4e5f6789012ef",
    "name": "General Consultation",
    "date": "2024-03-15",
    "time": "14:30",
    "recording_id": "rec_123",
    "recording_url": "https://storage.example.com/recording.mp3",
    "recording_key": "recordings/rec_123.mp3",
    "status": "finished",
    "doctor_id": "doctor_uid_123",
    "patient_id": "65f8a1b2c3d4e5f6789012ab",
    "notes": "Patient presented with symptoms...",
    "language": "de",
    "notes_type": "soap_clinical_notes_de",
    "appointment_type": "in_person"
  }
}

Overview

Fetches detailed information for a specific appointment using its unique identifier.

Authentication

Authorization
string
required
Bearer token for authenticated access
Authorization: Bearer your_jwt_token_here

Path Parameters

id
string
required
Unique appointment identifier (ObjectId format)

Response

success
boolean
Whether the request was successful
data
object
The appointment object
error
string
Error message (only present when success is false)

Example Response

{
  "success": true,
  "data": {
    "_id": "65f8a1b2c3d4e5f6789012ef",
    "name": "General Consultation",
    "date": "2024-03-15",
    "time": "14:30",
    "recording_id": "rec_123",
    "recording_url": "https://storage.example.com/recording.mp3",
    "recording_key": "recordings/rec_123.mp3",
    "status": "finished",
    "doctor_id": "doctor_uid_123",
    "patient_id": "65f8a1b2c3d4e5f6789012ab",
    "notes": "Patient presented with symptoms...",
    "language": "de",
    "notes_type": "soap_clinical_notes_de",
    "appointment_type": "in_person"
  }
}

Error Response

{
  "success": false,
  "error": "Error message describing what went wrong"
}