get Appointments
GET {{baseUrl}}/appointments?subdomain={{subdomain}}&location_id={{location_id}}&start=2022-01-01&end=2022-12-31&page=1&per_page=20
Get a list of appointments
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
subdomain | string | (Required) Used to scope the request to the specified institution | |
location_id | string | (Required) Used to scope the request to the specified institution | |
start | string | (Required) A parseable date string defining the earliest returned records. Recommended format is YYYY-MM-DDThh:mm:ss+0000 | |
end | string | (Required) A parseable date string defining the last returned records. Recommended format is YYYY-MM-DDThh:mm:ss+0000 | |
timezone | string | Timezone for the appointment clinic | |
cancelled | string | Is appointment cancelled | |
unavailable | string | Unavailable appointments are used to block availability on a schedule, specify to set the filter | |
nex_only | string | Only show appointments booked via NexHealth API | |
updated_since | string | Query appointments whose records have updated since the specified datetime in ISO8601 format. Must be a parseable date/time, recommended formats are YYYY-MM-DD or YYYY-MM-DDT00:00:00+0000 | |
appointment_type_id | string | Get appointments for a specific appointment type | |
foreign_id | string | Unique appointment id from the EMR | |
patient_id | string | Get appointments for a specific patient | |
provider_ids[] | string | Query appointments that are booked with the specified providers only | |
operatory_ids[] | string | Query appointments that are booked in the specified operatories only | |
created_by | string | Query appointments that were created by a specific user | |
include[] | string | Resources to be included in the response | |
include[] | string | Resources to be included in the response | |
page | number | Page number. Starts with page 1 | |
per_page | number | Number of results to return per page. Defaults is 5 per page and Max 100 per page |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"code":"\u003cboolean\u003e","description":"\u003cstring\u003e","error":["\u003cstring\u003e","\u003cstring\u003e"],"data":[{"id":"\u003cinteger\u003e","patient_id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e","provider_name":"\u003cstring\u003e","start_time":"\u003cstring\u003e","confirmed":"\u003cboolean\u003e","patient_missed":"\u003cboolean\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","note":"\u003cinteger\u003e","end_time":"\u003cstring\u003e","unavailable":"\u003cboolean\u003e","cancelled":"\u003cboolean\u003e","timezone":"\u003cstring\u003e","institution_id":"\u003cinteger\u003e","appointment_type_id":"\u003cinteger\u003e","checkin_at":"\u003cstring\u003e","location_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","misc":"\u003cobject\u003e","last_sync_time":"\u003cstring\u003e","patient_confirmed":"\u003cinteger\u003e","created_by_user_id":"\u003cinteger\u003e","is_guardian":"\u003cboolean\u003e","patient_confirmed_at":"\u003cstring\u003e","cancelled_at":"\u003cstring\u003e","is_new_clients_patient":"\u003cboolean\u003e","confirmed_at":"\u003cstring\u003e","sooner_if_possible":"\u003cstring\u003e","operatory_id":"\u003cinteger\u003e","deleted":"\u003cboolean\u003e","checked_out":"\u003cboolean\u003e","checked_out_at":"\u003cstring\u003e","referrer":"\u003cstring\u003e","is_past_patient":"\u003cboolean\u003e","timezone_offset":"\u003cstring\u003e","patient":{"id":"\u003cinteger\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","middle_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","name":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","institution_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","bio":"\u003cobject\u003e","inactive":"\u003cboolean\u003e","last_sync_time":"\u003cstring\u003e","guarantor_id":"\u003cinteger\u003e","unsubscribe_sms":"\u003cboolean\u003e"},"procedures":[{"id":"\u003cinteger\u003e","patient_id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e","appointment_id":"\u003cinteger\u003e","code":"\u003cstring\u003e","description":"\u003cstring\u003e","status":"\u003cstring\u003e","fee":{"amount":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"currency_code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"start_date":"\u003cdate\u003e","end_date":"\u003cdate\u003e"},{"id":"\u003cinteger\u003e","patient_id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e","appointment_id":"\u003cinteger\u003e","code":"\u003cstring\u003e","description":"\u003cstring\u003e","status":"\u003cstring\u003e","fee":{"amount":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"currency_code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"start_date":"\u003cdate\u003e","end_date":"\u003cdate\u003e"}],"descriptors":[{"id":"\u003cinteger\u003e","descriptor_type":"\u003cstring\u003e","name":"\u003cstring\u003e","code":"\u003cstring\u003e","location_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","data":"\u003cobject\u003e","active":"\u003cboolean\u003e","last_sync_time":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e"},{"id":"\u003cinteger\u003e","descriptor_type":"\u003cstring\u003e","name":"\u003cstring\u003e","code":"\u003cstring\u003e","location_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","data":"\u003cobject\u003e","active":"\u003cboolean\u003e","last_sync_time":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e"}],"booking_details":{"booked_via_nexhealth_generated_link":"\u003cboolean\u003e","campaign_type":"\u003cstring\u003e","campaign_id":"\u003cinteger\u003e","campaign_medium":"\u003cstring\u003e","booked_via_one_click":"\u003cboolean\u003e"}},{"id":"\u003cinteger\u003e","patient_id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e","provider_name":"\u003cstring\u003e","start_time":"\u003cstring\u003e","confirmed":"\u003cboolean\u003e","patient_missed":"\u003cboolean\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","note":"\u003cinteger\u003e","end_time":"\u003cstring\u003e","unavailable":"\u003cboolean\u003e","cancelled":"\u003cboolean\u003e","timezone":"\u003cstring\u003e","institution_id":"\u003cinteger\u003e","appointment_type_id":"\u003cinteger\u003e","checkin_at":"\u003cstring\u003e","location_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","misc":"\u003cobject\u003e","last_sync_time":"\u003cstring\u003e","patient_confirmed":"\u003cinteger\u003e","created_by_user_id":"\u003cinteger\u003e","is_guardian":"\u003cboolean\u003e","patient_confirmed_at":"\u003cstring\u003e","cancelled_at":"\u003cstring\u003e","is_new_clients_patient":"\u003cboolean\u003e","confirmed_at":"\u003cstring\u003e","sooner_if_possible":"\u003cstring\u003e","operatory_id":"\u003cinteger\u003e","deleted":"\u003cboolean\u003e","checked_out":"\u003cboolean\u003e","checked_out_at":"\u003cstring\u003e","referrer":"\u003cstring\u003e","is_past_patient":"\u003cboolean\u003e","timezone_offset":"\u003cstring\u003e","patient":{"id":"\u003cinteger\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","middle_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","name":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","institution_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","bio":"\u003cobject\u003e","inactive":"\u003cboolean\u003e","last_sync_time":"\u003cstring\u003e","guarantor_id":"\u003cinteger\u003e","unsubscribe_sms":"\u003cboolean\u003e"},"procedures":[{"id":"\u003cinteger\u003e","patient_id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e","appointment_id":"\u003cinteger\u003e","code":"\u003cstring\u003e","description":"\u003cstring\u003e","status":"\u003cstring\u003e","fee":{"amount":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"currency_code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"start_date":"\u003cdate\u003e","end_date":"\u003cdate\u003e"},{"id":"\u003cinteger\u003e","patient_id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e","appointment_id":"\u003cinteger\u003e","code":"\u003cstring\u003e","description":"\u003cstring\u003e","status":"\u003cstring\u003e","fee":{"amount":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"currency_code":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"start_date":"\u003cdate\u003e","end_date":"\u003cdate\u003e"}],"descriptors":[{"id":"\u003cinteger\u003e","descriptor_type":"\u003cstring\u003e","name":"\u003cstring\u003e","code":"\u003cstring\u003e","location_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","data":"\u003cobject\u003e","active":"\u003cboolean\u003e","last_sync_time":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e"},{"id":"\u003cinteger\u003e","descriptor_type":"\u003cstring\u003e","name":"\u003cstring\u003e","code":"\u003cstring\u003e","location_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","data":"\u003cobject\u003e","active":"\u003cboolean\u003e","last_sync_time":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e"}],"booking_details":{"booked_via_nexhealth_generated_link":"\u003cboolean\u003e","campaign_type":"\u003cstring\u003e","campaign_id":"\u003cinteger\u003e","campaign_medium":"\u003cstring\u003e","booked_via_one_click":"\u003cboolean\u003e"}}],"count":"\u003cinteger\u003e"}