Bookings
Get booking configuration
Reads the native booking configuration from the effective catalog. Requires bookings:read and a location grant. Returns 404 when no configuration has been authored.
Get booking configuration
curl --request GET \
--url https://api.maple.inc/v1/locations/{locationId}/booking_configuration \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.maple.inc/v1/locations/{locationId}/booking_configuration"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.maple.inc/v1/locations/{locationId}/booking_configuration', 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.maple.inc/v1/locations/{locationId}/booking_configuration",
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://api.maple.inc/v1/locations/{locationId}/booking_configuration"
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://api.maple.inc/v1/locations/{locationId}/booking_configuration")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.maple.inc/v1/locations/{locationId}/booking_configuration")
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{
"timeZone": "<string>",
"currency": "<string>",
"areas": [
{
"poolId": "<string>",
"name": "<string>",
"units": [
{
"unitId": "<string>",
"seats": {
"min": 2,
"max": 2
},
"label": "<string>",
"tags": [
"<string>"
]
}
],
"kind": "seat",
"combinations": [
{
"unitIds": [
"<string>"
],
"seats": {
"min": 2,
"max": 2
}
}
]
}
],
"turnBands": [
{
"minutes": 2,
"minGuests": 2,
"maxGuests": 2
}
],
"shifts": [
{
"day": "MON",
"start": "<string>",
"end": "<string>"
}
],
"object": "booking_configuration",
"location_id": "<string>",
"version_id": "<string>",
"published_at": "<string>",
"livemode": true,
"pacing": {
"intervalMinutes": 2,
"maxCovers": 2,
"enforcement": "hard"
},
"bookingPolicy": {
"minLeadMinutes": 1,
"maxHorizonDays": 2,
"slotAlignment": "service_duration",
"autoConfirm": true
},
"cancellationPolicy": {
"requiresCardOnFile": true,
"tiers": [
{
"withinHoursBeforeStart": 1,
"basis": "flat",
"flatAmountMinor": 1,
"percentBps": 5000
}
],
"rescheduleCutoffHours": 123,
"policyText": "<string>"
},
"closedDates": [
"<string>"
]
}{
"_tag": "DeveloperApiUnauthorized",
"message": "<string>"
}{
"_tag": "DeveloperApiForbidden",
"code": "insufficient_scope",
"message": "<string>"
}{
"_tag": "DeveloperApiNotFound",
"message": "<string>"
}{
"_tag": "DeveloperApiUnprocessable",
"code": "<string>",
"message": "<string>",
"details": {}
}{
"_tag": "DeveloperApiRateLimited",
"message": "<string>",
"retry_after": 123
}Authorizations
API key — mpk_test_… for the sandbox, mpk_live_… for production. Issued by Maple during partner onboarding.
Path Parameters
Response
Success
Pattern:
^[A-Z]{3}$Minimum array length:
1Show child attributes
Show child attributes
Minimum array length:
1Show child attributes
Show child attributes
Minimum array length:
1Show child attributes
Show child attributes
Available options:
booking_configuration Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Get booking configuration
curl --request GET \
--url https://api.maple.inc/v1/locations/{locationId}/booking_configuration \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.maple.inc/v1/locations/{locationId}/booking_configuration"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.maple.inc/v1/locations/{locationId}/booking_configuration', 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.maple.inc/v1/locations/{locationId}/booking_configuration",
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://api.maple.inc/v1/locations/{locationId}/booking_configuration"
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://api.maple.inc/v1/locations/{locationId}/booking_configuration")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.maple.inc/v1/locations/{locationId}/booking_configuration")
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{
"timeZone": "<string>",
"currency": "<string>",
"areas": [
{
"poolId": "<string>",
"name": "<string>",
"units": [
{
"unitId": "<string>",
"seats": {
"min": 2,
"max": 2
},
"label": "<string>",
"tags": [
"<string>"
]
}
],
"kind": "seat",
"combinations": [
{
"unitIds": [
"<string>"
],
"seats": {
"min": 2,
"max": 2
}
}
]
}
],
"turnBands": [
{
"minutes": 2,
"minGuests": 2,
"maxGuests": 2
}
],
"shifts": [
{
"day": "MON",
"start": "<string>",
"end": "<string>"
}
],
"object": "booking_configuration",
"location_id": "<string>",
"version_id": "<string>",
"published_at": "<string>",
"livemode": true,
"pacing": {
"intervalMinutes": 2,
"maxCovers": 2,
"enforcement": "hard"
},
"bookingPolicy": {
"minLeadMinutes": 1,
"maxHorizonDays": 2,
"slotAlignment": "service_duration",
"autoConfirm": true
},
"cancellationPolicy": {
"requiresCardOnFile": true,
"tiers": [
{
"withinHoursBeforeStart": 1,
"basis": "flat",
"flatAmountMinor": 1,
"percentBps": 5000
}
],
"rescheduleCutoffHours": 123,
"policyText": "<string>"
},
"closedDates": [
"<string>"
]
}{
"_tag": "DeveloperApiUnauthorized",
"message": "<string>"
}{
"_tag": "DeveloperApiForbidden",
"code": "insufficient_scope",
"message": "<string>"
}{
"_tag": "DeveloperApiNotFound",
"message": "<string>"
}{
"_tag": "DeveloperApiUnprocessable",
"code": "<string>",
"message": "<string>",
"details": {}
}{
"_tag": "DeveloperApiRateLimited",
"message": "<string>",
"retry_after": 123
}