Skip to main content
GET
/
locations
/
{location}
cURL
curl --request GET \
  --url https://api.caspen.com/v1/locations/{location}
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "timezone": "<string>",
  "country_code": "<string>",
  "online_booking": true,
  "abn": "<string>",
  "ndis_number": "<string>",
  "logo_id": "<string>",
  "image_id": "<string>",
  "service_ids": [
    "<string>"
  ],
  "practitioner_ids": [
    "<string>"
  ],
  "opening_hours": {
    "mon_active": true,
    "mon_opens_at": "<string>",
    "mon_closes_at": "<string>",
    "tue_active": true,
    "tue_opens_at": "<string>",
    "tue_closes_at": "<string>",
    "wed_active": true,
    "wed_opens_at": "<string>",
    "wed_closes_at": "<string>",
    "thu_active": true,
    "thu_opens_at": "<string>",
    "thu_closes_at": "<string>",
    "fri_active": true,
    "fri_opens_at": "<string>",
    "fri_closes_at": "<string>",
    "sat_active": true,
    "sat_opens_at": "<string>",
    "sat_closes_at": "<string>",
    "sun_active": true,
    "sun_opens_at": "<string>",
    "sun_closes_at": "<string>"
  },
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country_code": "<string>"
  },
  "created_at": "<string>"
}

Path Parameters

​
location
string
required

The location ID

Response

LocationResource

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

"[email protected]"

​
phone
string | null

The location's phone number.

Example:

"+61400123456"

​
timezone
string

The location's timezone.

Example:

"Australia/Sydney"

​
country_code
string

The location's country code.

Example:

"AU"

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

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"