Get Open Appointment Slots

GET /v1.0/appointments/open-slots

Retrieves available appointment slots for a practitioner. Identify the practitioner either by email OR by first name + last name.

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

start_date_time

query

string

Start date for slot search (ISO 8601).

Yes

end_date_time

query

string

End date for slot search (ISO 8601).

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

include_raw

query

boolean

Include raw data in the response.

No

include_fhir

query

boolean

Include FHIR format in the response.

No

Responses

  • 200: List of available appointment slots (application/json)

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

Last updated