List Appointments

List Appointments

GET /v1.0/appointments

Retrieves a list of appointments for a specific date range.

Parameters

Name	In	Type	Description	Required
x-sully-organization-id	header	string	Organization ID for multi-tenant support.	Yes
x-sully-transaction-id	header	string	Transaction ID for tracking purposes.	Yes
patient_first_name	query	string	Patient’s first name (required if phone_number is not provided).	Conditional
patient_last_name	query	string	Patient’s last name (required if phone_number is not provided).	Conditional
patient_date_of_birth	query	string	Patient’s date of birth in YYYY-MM-DD format (required if phone_number is not provided).	Conditional
patient_phone_number	query	string	Patient’s phone number (required if first_name, last_name, and date_of_birth are not all provided).	Conditional
patient_email	query	string	Patient’s email address (required if first_name, last_name, and date_of_birth are not all provided).	No
practitioner_id	query	string	Practitioner’s ID.	No
practitioner_email	query	string	Practitioner’s email (required if practitionerFirstName and practitionerLastName are not provided).	No
practitioner_first_name	query	string	Practitioner’s first name (required if practitionerEmail is not provided).	No
practitioner_last_name	query	string	Practitioner’s last name (required if practitionerEmail is not provided).	No
start_date_time	query	string	Start date for appointments search in ISO 8601 format (e.g., 2025-07-15T00:00:00Z).	Yes
end_date_time	query	string	End date for appointments search in ISO 8601 format.	Yes
count	query	integer	Number of items to retrieve. Default is 10.	No
include_raw	query	boolean	Include raw data in the response. If set to true, response will include raw data.	No
include_fhir	query	boolean	Include FHIR format in the response.	No

Responses

• 200: A list of appointment slots (application/json)

• 400: Bad request due to invalid input (application/json)