curl --request GET \
--url https://{clinic}.{region}.practicehub.io/v3/api/availability \
--header 'Authorization: Bearer <token>'import requests
url = "https://{clinic}.{region}.practicehub.io/v3/api/availability"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{clinic}.{region}.practicehub.io/v3/api/availability', 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://{clinic}.{region}.practicehub.io/v3/api/availability",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://{clinic}.{region}.practicehub.io/v3/api/availability"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{clinic}.{region}.practicehub.io/v3/api/availability")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{clinic}.{region}.practicehub.io/v3/api/availability")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"starts_at": "2026-09-01T09:00:00",
"ends_at": "2026-09-01T09:30:00",
"practitioner_id": 123,
"practitioner_name": "<string>",
"location_id": 123,
"appointment_type_id": 123,
"resource_id": 123,
"type": "individual",
"group_master_id": 123,
"online_fee": 123
}
],
"meta": {
"timezone": "Europe/London",
"from": "2026-09-01T00:00:00",
"to": "2026-09-07T23:59:59",
"visibility": "online",
"unavailable_dates": [
"2023-12-25"
]
}
}{
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"message": "<string>",
"code": "<string>",
"errors": {}
}List free, bookable slots for a location and appointment type
Computed from the same availability engine as the calendar and online booking, so a returned slot is one the practice would book. visibility=online (default) is the patient view: the location, appointment type and (if given) practitioner must be enabled for online booking, and every online-booking rule applies — minimum advance notice, months ahead, daily caps, online-only guides, clustering. visibility=all is the front-desk view: every open slot for practitioners who provide the service, subject only to physical capacity. Up to 50 slots are returned per day. Not to be confused with practitioner_availabilities, which are the raw working-hours records this is computed from. Book a slot with POST /appointments (start/end/practitioner_id; group_master_id for a group slot).
curl --request GET \
--url https://{clinic}.{region}.practicehub.io/v3/api/availability \
--header 'Authorization: Bearer <token>'import requests
url = "https://{clinic}.{region}.practicehub.io/v3/api/availability"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{clinic}.{region}.practicehub.io/v3/api/availability', 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://{clinic}.{region}.practicehub.io/v3/api/availability",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://{clinic}.{region}.practicehub.io/v3/api/availability"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{clinic}.{region}.practicehub.io/v3/api/availability")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{clinic}.{region}.practicehub.io/v3/api/availability")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"starts_at": "2026-09-01T09:00:00",
"ends_at": "2026-09-01T09:30:00",
"practitioner_id": 123,
"practitioner_name": "<string>",
"location_id": 123,
"appointment_type_id": 123,
"resource_id": 123,
"type": "individual",
"group_master_id": 123,
"online_fee": 123
}
],
"meta": {
"timezone": "Europe/London",
"from": "2026-09-01T00:00:00",
"to": "2026-09-07T23:59:59",
"visibility": "online",
"unavailable_dates": [
"2023-12-25"
]
}
}{
"message": "<string>",
"code": "<string>",
"errors": {}
}{
"message": "<string>",
"code": "<string>",
"errors": {}
}Authorizations
API key from Developers → API Keys, sent as Authorization: Bearer .
Query Parameters
Location to search
Appointment type to book
Limit to one practitioner (omit for any)
Range start in the clinic timezone, YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS (default: start of today)
"2026-09-01"
Range end (inclusive; a date means the end of that day). Default 7 days from from; at most 31 days
"2026-09-07"
Patient (online) or front-desk (all) view
online, all Cap on slots returned per day
1 <= x <= 50When finding a new time for an existing appointment: its occupied time is treated as free for overlapping alternatives (its duration/columns are used), but its exact current start is not offered
Was this page helpful?