Appointments
The Appointments resource represents scheduled visits between patients and clinicians. Appointments are read-only.
Endpoints
| Method | Path | Description |
|---|---|---|
GET |
/Appointments |
List appointments |
GET |
/Appointments({id}) |
Get a single appointment |
List Appointments
Supports: $filter, $select, $orderby, $top, $skip, $count, $expand
Example
curl -X GET "https://api.nymblqa.com/Appointments?\$filter=status eq 'Scheduled'&\$orderby=appointment_date asc&\$top=50" \
-H "Authorization: Bearer eyJraWQiOiJ..." \
-H "x-api-key: YOUR_API_KEY"
Response
{
"@odata.context": "https://api.nymblqa.com/$metadata#Appointments",
"@odata.count": 125,
"value": [
{
"id": "appt-001",
"patient_id": "12345",
"appointment_date": "2026-03-01",
"start_datetime": "2026-03-01T09:00:00Z",
"end_datetime": "2026-03-01T09:30:00Z",
"status": "Scheduled",
"appointment_type_id": "type-123"
}
]
}
Get a Single Appointment
Example
curl -X GET "https://api.nymblqa.com/Appointments(appt-001)" \
-H "Authorization: Bearer eyJraWQiOiJ..." \
-H "x-api-key: YOUR_API_KEY"
Properties
| Property | Type | Max Length | Description |
|---|---|---|---|
id |
string | — | Unique appointment identifier (required) |
patient_id |
string | — | ID of the associated patient |
appointment_date |
string | — | Date of the appointment (YYYY-MM-DD) |
start_time |
string | 8 | Start time (HH:MM:SS) |
end_time |
string | 8 | End time (HH:MM:SS) |
start_time_new |
string | 8 | Alternate start time field |
end_time_new |
string | 8 | Alternate end time field |
start_datetime |
string (date-time) | — | Full start date/time (ISO 8601) |
end_datetime |
string (date-time) | — | Full end date/time (ISO 8601) |
status |
string | 30 | Appointment status (e.g., Scheduled, Completed, Cancelled) |
visit_type |
string | 30 | Visit type (e.g., In-Person, Telehealth) |
appointment_type_id |
string | — | ID of the appointment type |
branch_id |
string | — | ID of the branch/location |
user_id |
string | — | Primary clinician user ID |
user_two_id |
string | — | Secondary clinician user ID |
user_three_id |
string | — | Tertiary clinician user ID |
user_four_id |
string | — | Quaternary clinician user ID |
user_type |
string | 30 | Type of primary user |
user_type_id |
string | — | User type identifier |
notes |
string | — | Appointment notes |
prescription_id |
string | — | Associated prescription ID |
prescription_two_id |
string | — | Secondary prescription ID |
recurring |
boolean | — | Whether this is a recurring appointment |
recurring_appointment_id |
string | — | ID of the recurring appointment series |
custom_recurrence |
boolean | — | Whether recurrence is custom-defined |
rescheduled_from |
string | — | Original appointment ID if rescheduled |
rescheduled_to |
string | — | New appointment ID if rescheduled |
confirmation_code |
string | 100 | Appointment confirmation code |
confirmation_sent |
boolean | — | Whether a confirmation was sent |
confirmation_status |
string | 45 | Status of confirmation (e.g., Confirmed, Pending) |
confirmation_updated_at |
string (date-time) | — | When confirmation status last changed |
confirmation_request_sent_date |
string | — | Date confirmation request was sent |
confirmation_request_sent_status |
string | 25 | Status of the confirmation request |
survey_sent_date |
string | — | Date post-visit survey was sent |
survey_sent_status |
string | 25 | Status of survey delivery |
survey_completed |
boolean | — | Whether the survey was completed |
delivery_location_id |
string | — | ID of the delivery location |
nylas_event_id |
string | 300 | Associated Nylas calendar event ID |
source_id |
string | — | Source system record ID |
source_name |
string | 100 | Source system name |
created_at |
string (date-time) | — | Record creation timestamp |
created_by_id |
string | — | ID of user who created the record |
updated_at |
string (date-time) | — | Last update timestamp |
updated_by_id |
string | — | ID of user who last updated the record |
Common Query Examples
Today's scheduled appointments:
GET /Appointments?$filter=appointment_date eq 2026-02-21 and status eq 'Scheduled'&$orderby=start_datetime asc
Appointments for a specific patient:
Appointments within a date range:
GET /Appointments?$filter=appointment_date ge 2026-03-01 and appointment_date le 2026-03-31&$orderby=appointment_date asc
Upcoming confirmed appointments:
GET /Appointments?$filter=start_datetime gt 2026-02-21T00:00:00Z and confirmation_status eq 'Confirmed'&$orderby=start_datetime asc
Appointment with expanded type and patient: