Retrieve a location

GET

locations

{location}

cURL

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

import requests

url = "https://api.caspen.com/v1/locations/{location}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.caspen.com/v1/locations/{location}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.caspen.com/v1/locations/{location}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.caspen.com/v1/locations/{location}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.caspen.com/v1/locations/{location}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.caspen.com/v1/locations/{location}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "timezone": "<string>",
  "online_appointment_booking": true,
  "online_class_booking": true,
  "tax_identifier": "<string>",
  "tax_identifier_label": "<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>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Path Parameters

location

string

required

The location ID

Response

LocationResource

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

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 | null

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

Show child attributes

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 | null

The location's address details.

Show child attributes

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"

The practitioner object

cURL

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

import requests

url = "https://api.caspen.com/v1/locations/{location}"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.caspen.com/v1/locations/{location}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.caspen.com/v1/locations/{location}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.caspen.com/v1/locations/{location}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.caspen.com/v1/locations/{location}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.caspen.com/v1/locations/{location}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "timezone": "<string>",
  "online_appointment_booking": true,
  "online_class_booking": true,
  "tax_identifier": "<string>",
  "tax_identifier_label": "<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>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

API documentation

Appointment Clients

Appointments

Availabilities

Availability Slots

Busy Times

Clients

Contacts

Form Templates

Forms

Locations

Practitioners

Services

Path Parameters

Response