List all locations

GET

locations

cURL

curl --request GET \
  --url https://api.caspen.com/v1/locations

{
  "data": [
    {
      "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>"
    }
  ],
  "links": {
    "prev": "<string>",
    "next": "<string>"
  }
}

Query Parameters

cursor

string

limit

integer

Required range: 1 <= x <= 100

Response

Paginated set of LocationResource

data

LocationResource · object[]

required

Show child attributes

data.id

string

The location's unique identifier.

data.name

string

The location's name.

data.description

string | null

The location's description.

data.email

string | null

The location's email address.

data.phone

string | null

The location's phone number.

data.timezone

string

The location's timezone.

data.country_code

string

The location's country code.

data.online_booking

boolean | null

Whether online booking is enabled for this location.

data.abn

string | null

The location's Australian Business Number.

data.ndis_number

string | null

The location's NDIS number.

data.logo_id

string | null

The location's logo media ID.

data.image_id

string | null

The location's image media ID.

data.service_ids

string[]

The IDs of services available at this location.

data.practitioner_ids

string[]

The IDs of practitioners working at this location.

data.opening_hours

object

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

Show child attributes

data.opening_hours.mon_active

boolean | null

data.opening_hours.mon_opens_at

string | null

data.opening_hours.mon_closes_at

string | null

data.opening_hours.tue_active

boolean | null

data.opening_hours.tue_opens_at

string | null

data.opening_hours.tue_closes_at

string | null

data.opening_hours.wed_active

boolean | null

data.opening_hours.wed_opens_at

string | null

data.opening_hours.wed_closes_at

string | null

data.opening_hours.thu_active

boolean | null

data.opening_hours.thu_opens_at

string | null

data.opening_hours.thu_closes_at

string | null

data.opening_hours.fri_active

boolean | null

data.opening_hours.fri_opens_at

string | null

data.opening_hours.fri_closes_at

string | null

data.opening_hours.sat_active

boolean | null

data.opening_hours.sat_opens_at

string | null

data.opening_hours.sat_closes_at

string | null

data.opening_hours.sun_active

boolean | null

data.opening_hours.sun_opens_at

string | null

data.opening_hours.sun_closes_at

string | null

data.address

object

The location's address details.

Show child attributes

data.address.line1

string | null

data.address.line2

string | null

data.address.city

string | null

data.address.state

string | null

data.address.postal_code

string | null

data.address.country_code

string | null

data.created_at

string

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

links

object

required

Show child attributes

links.prev

string | null

required

links.next

string | null

required

Retrieve a location

⌘I

cURL

curl --request GET \
  --url https://api.caspen.com/v1/locations

{
  "data": [
    {
      "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>"
    }
  ],
  "links": {
    "prev": "<string>",
    "next": "<string>"
  }
}

API documentation

Appointments

Availabilities

Availability Slots

Clients

Contacts

Locations

Practitioners

Services

Query Parameters

Response