API Reference

List Slots

get
https://au-api.halaxy.com/main/Slot

Retrieves a collection of time intervals that are available for booking appointments

💡

Tip

Explore our Querying Resources guide for helpful tips on filtering requests and retrieving the exact data you need.


Parameters

Query Params
integer
Defaults to 1

The collection page number

integer
≥ 0
Defaults to 30

The number of items per page

boolean

Enable or disable pagination

string

The logical id of the resource

string

The duration of the slot

string

The free/busy status of the appointment

string

The practitioner available for the slot

string

The Organization the slot if apart of the Slot

string

The PractitionerRole that is apart of the Slot

string

The Appointment start date/time.

string

The Appointment end date/time.

string

The schedule the slot is a part of

string
enum

The _include parameter can be used to include related search results to reduce overall network delay of repeated retrievals of related resources.

Modifiers

  • _include:iterate = can be used to include related resources based on already included resources.
Allowed:
Headers
string
enum
Defaults to application/fhir+json

Generated from available response content types

Allowed:
Responses

403

Forbidden

Updated 3 months ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/fhir+json
application/json

Updated 3 months ago

Did this page help you?