Skip to main content
​
id
string

The location's unique identifier.

​
name
string

The location's name.

​
description
string | null

The location's description.

Example:

"Our primary healthcare facility offering comprehensive services."

​
email
string | null

The location's email address.

Example:

"[email protected]"

​
phone
string | null

The location's phone number.

Example:

"+61400123456"

​
timezone
string

The location's timezone.

​
country_code
string

The location's country code.

​
online_booking
boolean | null

Whether online booking is enabled for this location.

Example:

true

​
abn
string | null

The location's Australian Business Number.

Example:

"12 345 678 901"

​
ndis_number
string | null

The location's NDIS number.

Example:

"4050123456"

​
logo_id
string | null

The location's logo media ID.

Example:

"med_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
image_id
string | null

The location's image media ID.

Example:

"med_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
service_ids
string[]

The IDs of services available at this location.

​
practitioner_ids
string[]

The IDs of practitioners working at this location.

​
opening_hours
object

The location's opening hours for each day of the week.

Example:
{
  "mon_active": true,
  "mon_opens_at": "09:00",
  "mon_closes_at": "17:00",
  "tue_active": true,
  "tue_opens_at": "09:00",
  "tue_closes_at": "17:00"
}
​
address
object

The location's address details.

Example:
{
  "line1": "123 Health Street",
  "line2": "Level 2",
  "city": "Sydney",
  "state": "NSW",
  "postal_code": "2000",
  "country_code": "AU"
}
​
created_at
string

The timestamp when the location was created (ISO 8601).