Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.caspen.com/llms.txt

Use this file to discover all available pages before exploring further.

​
id
string

The location's unique identifier.

Example:

"loc_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
name
string

The location's name.

Example:

"Main Clinic"

​
description
string | null

The location's description.

Example:

"Our primary healthcare facility offering comprehensive services."

​
email
string | null

The location's email address.

Example:

"reception@mainclinic.com"

​
phone
string | null

The location's phone number.

Example:

"+61400123456"

​
timezone
string

The location's timezone.

Example:

"Australia/Sydney"

​
online_appointment_booking
boolean | null

Whether online appointment booking is enabled for this location.

Example:

true

​
online_class_booking
boolean | null

Whether online class booking is enabled for this location.

Example:

true

​
tax_identifier
string | null

The location's tax identifier (e.g. ABN, VAT number, GST number, Tax number).

Example:

"12 345 678 901"

​
tax_identifier_label
string

The label for the tax identifier based on the account's country.

Example:

"ABN"

​
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.

Example:
[
  "ser_01HYHYQHA682J0K1RW7B2HVA9F",
  "ser_01HYHYW37MTYJPMT5JV4RN99GK"
]
​
practitioner_ids
string[]

The IDs of practitioners working at this location.

Example:
[
  "pra_01HYHYQHA682J0K1RW7B2HVA9F",
  "pra_01HYHYW37MTYJPMT5JV4RN99GK"
]
​
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).

Example:

"2024-01-01T12:00:00Z"