Skip to main content
GET
/
api
/
appointments
/
:id
Get Appointment
curl --request GET \
  --url https://api.example.com/api/appointments/:id
{
  "id": "<string>",
  "patient_id": "<string>",
  "patient_name": "<string>",
  "patient_email": "<string>",
  "patient_phone": "<string>",
  "doctor_id": "<string>",
  "doctor_name": "<string>",
  "specialty": "<string>",
  "date": "<string>",
  "time": "<string>",
  "duration_minutes": 123,
  "status": "<string>",
  "reason": "<string>",
  "notes": "<string>",
  "diagnosis": "<string>",
  "prescription": "<string>",
  "follow_up_required": true,
  "follow_up_date": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "completed_at": "<string>",
  "cancelled_at": "<string>",
  "cancellation_reason": "<string>",
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/DUVAN100/saludya-api/llms.txt

Use this file to discover all available pages before exploring further.

Get detailed information about a specific appointment using its unique identifier.

​
Path Parameters

​
id
string
required
Unique identifier of the appointment

​
Response

​
id
string
Unique appointment identifier
​
patient_id
string
ID of the patient
​
patient_name
string
Full name of the patient
​
patient_email
string
Email address of the patient
​
patient_phone
string
Phone number of the patient
​
doctor_id
string
ID of the assigned doctor
​
doctor_name
string
Full name of the doctor
​
specialty
string
Medical specialty for the appointment
​
date
string
Appointment date (ISO 8601 format)
​
time
string
Appointment time (HH:MM format)
​
duration_minutes
integer
Expected duration of the appointment in minutes
​
status
string
Current status of the appointment: scheduled, confirmed, in_progress, completed, cancelled, no_show
​
reason
string
Reason for the appointment visit
​
notes
string
Additional notes or special instructions
​
diagnosis
string
Medical diagnosis (available after appointment completion)
​
prescription
string
Prescribed medications or treatment (available after appointment completion)
​
follow_up_required
boolean
Whether a follow-up appointment is recommended
​
follow_up_date
string
Recommended date for follow-up appointment
​
created_at
string
Timestamp when the appointment was created
​
updated_at
string
Timestamp when the appointment was last updated
​
completed_at
string
Timestamp when the appointment was completed (if applicable)
​
cancelled_at
string
Timestamp when the appointment was cancelled (if applicable)
​
cancellation_reason
string
Reason for cancellation (if applicable)

​
Example Request

curl -X GET "https://api.saludya.com/api/appointments/apt_7k3m9n2p4q" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

​
Example Response

{
  "id": "apt_7k3m9n2p4q",
  "patient_id": "pat_5x8y2z4a6b",
  "patient_name": "María González",
  "patient_email": "maria.gonzalez@email.com",
  "patient_phone": "+52-555-123-4567",
  "doctor_id": "doc_3j5k7m9n1p",
  "doctor_name": "Dr. Carlos Ramírez",
  "specialty": "Cardiología",
  "date": "2026-03-10",
  "time": "09:30",
  "duration_minutes": 30,
  "status": "scheduled",
  "reason": "Consulta de control cardiovascular",
  "notes": "Traer resultados de análisis de sangre",
  "diagnosis": null,
  "prescription": null,
  "follow_up_required": false,
  "follow_up_date": null,
  "created_at": "2026-03-05T14:22:10Z",
  "updated_at": "2026-03-05T14:22:10Z",
  "completed_at": null,
  "cancelled_at": null,
  "cancellation_reason": null
}

​
Example Response (Completed Appointment)

{
  "id": "apt_6m8n4p1r3s",
  "patient_id": "pat_2x5y8z3a1b",
  "patient_name": "José Hernández",
  "patient_email": "jose.hernandez@email.com",
  "patient_phone": "+52-555-987-6543",
  "doctor_id": "doc_4k6m8n2p3q",
  "doctor_name": "Dra. Ana Martínez",
  "specialty": "Medicina General",
  "date": "2026-03-05",
  "time": "11:00",
  "duration_minutes": 20,
  "status": "completed",
  "reason": "Dolor de garganta y fiebre",
  "notes": "Síntomas desde hace 3 días",
  "diagnosis": "Faringitis aguda",
  "prescription": "Amoxicilina 500mg cada 8 horas por 7 días. Paracetamol 500mg cada 6 horas si hay fiebre.",
  "follow_up_required": true,
  "follow_up_date": "2026-03-12",
  "created_at": "2026-03-04T08:15:30Z",
  "updated_at": "2026-03-05T11:25:42Z",
  "completed_at": "2026-03-05T11:25:42Z",
  "cancelled_at": null,
  "cancellation_reason": null
}

​
Error Responses

​
error
object
​
code
string
Error code identifier
​
message
string
Human-readable error message

​
401 Unauthorized

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API token"
  }
}

​
403 Forbidden

{
  "error": {
    "code": "FORBIDDEN",
    "message": "You don't have permission to access this appointment"
  }
}

​
404 Not Found

{
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Appointment with ID 'apt_7k3m9n2p4q' not found"
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us