Browse Available Appointment Slots over a Date Range
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}/available-slots-range \
--header 'Content-Type: application/json' \
--data '
{
"location_id": 123,
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"staff_id": "<string>"
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}/available-slots-range"
payload = {
"location_id": 123,
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"staff_id": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
location_id: 123,
start_date: '2023-12-25',
end_date: '2023-12-25',
staff_id: '<string>'
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}/available-slots-range', 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.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}/available-slots-range",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'location_id' => 123,
'start_date' => '2023-12-25',
'end_date' => '2023-12-25',
'staff_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}/available-slots-range"
payload := strings.NewReader("{\n \"location_id\": 123,\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"staff_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}/available-slots-range")
.header("Content-Type", "application/json")
.body("{\n \"location_id\": 123,\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"staff_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}/available-slots-range")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"location_id\": 123,\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"staff_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": [
"<string>"
],
"meta": {
"appointment_definition_id": 123,
"location_id": 123,
"timezone": "<string>",
"start_date": "<string>",
"end_date": "<string>",
"requires_staff": true,
"customer_must_select_staff": true,
"assigned_staff_required": true,
"staff": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>"
},
"slot_interval_minutes": 123,
"duration_minutes": 123,
"buffer_before_minutes": 123,
"buffer_after_minutes": 123,
"min_lead_minutes": 123,
"max_advance_days": 123,
"max_concurrent_bookings": 123,
"total": 123
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Appointment Availability
Browse Available Appointment Slots over a Date Range
A POST to the /appointment-definitions/{appointmentDefinitionId}/available-slots-range
endpoint returns all bookable slots in [start_date, end_date], sorted by
start time, paginated. Range is capped at 31 days by the form request.
POST
/
v3
/
appointment-definitions
/
{appointmentDefinition}
/
available-slots-range
Browse Available Appointment Slots over a Date Range
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}/available-slots-range \
--header 'Content-Type: application/json' \
--data '
{
"location_id": 123,
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"staff_id": "<string>"
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}/available-slots-range"
payload = {
"location_id": 123,
"start_date": "2023-12-25",
"end_date": "2023-12-25",
"staff_id": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
location_id: 123,
start_date: '2023-12-25',
end_date: '2023-12-25',
staff_id: '<string>'
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}/available-slots-range', 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.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}/available-slots-range",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'location_id' => 123,
'start_date' => '2023-12-25',
'end_date' => '2023-12-25',
'staff_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}/available-slots-range"
payload := strings.NewReader("{\n \"location_id\": 123,\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"staff_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}/available-slots-range")
.header("Content-Type", "application/json")
.body("{\n \"location_id\": 123,\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"staff_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/appointment-definitions/{appointmentDefinition}/available-slots-range")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"location_id\": 123,\n \"start_date\": \"2023-12-25\",\n \"end_date\": \"2023-12-25\",\n \"staff_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": [
"<string>"
],
"meta": {
"appointment_definition_id": 123,
"location_id": 123,
"timezone": "<string>",
"start_date": "<string>",
"end_date": "<string>",
"requires_staff": true,
"customer_must_select_staff": true,
"assigned_staff_required": true,
"staff": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>"
},
"slot_interval_minutes": 123,
"duration_minutes": 123,
"buffer_before_minutes": 123,
"buffer_after_minutes": 123,
"min_lead_minutes": 123,
"max_advance_days": 123,
"max_concurrent_bookings": 123,
"total": 123
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Path Parameters
The appointment definition ID
Body
application/json
Request payload for the range slots endpoint. Date window is capped at 31 days so a single call can't sweep an unbounded slot space.
Reuses the same staff/location validation rules as the single-day endpoint
(ListAppointmentAvailableSlots) so the range version inherits the same
"is this combination actually bookable?" guarantees.
⌘I