Bookings

Search booking availability

Bookable slots for a party at a granted location inside a venue-local window (at most 31 days). Every slot carries an opaque signed slot_token: pass it unchanged to POST /booking_holds, never rebuild slot parameters yourself. Quotes are bound to the partner channel and expire after 15 minutes. Typed outcomes (party_size_out_of_bounds with the bounds, outside_booking_window, large_party_inquiry_required with the venue’s inquiry contact, bookings_not_enabled) come back as 422 with a code. Requires bookings:read.

curl --request GET \
  --url https://api.maple.inc/v1/locations/{locationId}/booking_availability \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.maple.inc/v1/locations/{locationId}/booking_availability"

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_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://api.maple.inc/v1/locations/{locationId}/booking_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://api.maple.inc/v1/locations/{locationId}/booking_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))

}

require 'uri'
require 'net/http'

url = URI("https://api.maple.inc/v1/locations/{locationId}/booking_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

{
  "object": "list",
  "data": [
    {
      "object": "booking_slot",
      "slot_token": "<string>",
      "starts_at": "<string>",
      "starts_at_local": "<string>",
      "duration_minutes": 123,
      "area": {
        "ref": "<string>",
        "name": "<string>"
      },
      "cancellation_policy": {
        "type": "<string>",
        "currency": "<string>",
        "policy_text": "<string>",
        "tiers": [
          {
            "within_hours_before_start": 123,
            "basis": "<string>",
            "amount_cents": 123,
            "percent_bps": 123
          }
        ],
        "deposit": {
          "amount_cents": 123,
          "currency": "<string>",
          "basis": "<string>"
        }
      }
    }
  ]
}

{
  "_tag": "DeveloperApiBadRequest",
  "message": "<string>",
  "code": "<string>"
}

{
  "_tag": "DeveloperApiUnauthorized",
  "message": "<string>"
}

{
  "_tag": "DeveloperApiForbidden",
  "code": "insufficient_scope",
  "message": "<string>"
}

{
  "_tag": "DeveloperApiNotFound",
  "message": "<string>"
}

{
  "_tag": "DeveloperApiConflict",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "_tag": "DeveloperApiUnprocessable",
  "code": "<string>",
  "message": "<string>",
  "details": {}
}

{
  "_tag": "DeveloperApiRateLimited",
  "message": "<string>",
  "retry_after": 123
}

Authorizations

Authorization

string

header

required

API key — mpk_test_… for the sandbox, mpk_live_… for production. Issued by Maple during partner onboarding.

Path Parameters

locationId

string

required

Query Parameters

party_size

string

required

Pattern: ^[+-]?\d*\.?\d+(?:[Ee][+-]?\d+)?$

start

string

required

Venue-local wall-clock start of the search window, YYYY-MM-DDTHH:MM.

end

string

required

Venue-local wall-clock end of the search window, YYYY-MM-DDTHH:MM, at most 31 days after start.

changing_booking_id

string | null

Reschedule mode: exclude this booking’s own claim from occupancy so its current slot (or a neighbour) can be re-quoted. The resulting slot_token is what POST /bookings/{id}/change takes.

Response

Success

object

enum<string>

required

Available options:

list

data

object[]

required

Show child attributes

⌘I

Search booking availability

curl --request GET \
  --url https://api.maple.inc/v1/locations/{locationId}/booking_availability \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.maple.inc/v1/locations/{locationId}/booking_availability"

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_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://api.maple.inc/v1/locations/{locationId}/booking_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://api.maple.inc/v1/locations/{locationId}/booking_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))

}

require 'uri'
require 'net/http'

url = URI("https://api.maple.inc/v1/locations/{locationId}/booking_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

{
  "object": "list",
  "data": [
    {
      "object": "booking_slot",
      "slot_token": "<string>",
      "starts_at": "<string>",
      "starts_at_local": "<string>",
      "duration_minutes": 123,
      "area": {
        "ref": "<string>",
        "name": "<string>"
      },
      "cancellation_policy": {
        "type": "<string>",
        "currency": "<string>",
        "policy_text": "<string>",
        "tiers": [
          {
            "within_hours_before_start": 123,
            "basis": "<string>",
            "amount_cents": 123,
            "percent_bps": 123
          }
        ],
        "deposit": {
          "amount_cents": 123,
          "currency": "<string>",
          "basis": "<string>"
        }
      }
    }
  ]
}

{
  "_tag": "DeveloperApiBadRequest",
  "message": "<string>",
  "code": "<string>"
}

{
  "_tag": "DeveloperApiUnauthorized",
  "message": "<string>"
}

{
  "_tag": "DeveloperApiForbidden",
  "code": "insufficient_scope",
  "message": "<string>"
}

{
  "_tag": "DeveloperApiNotFound",
  "message": "<string>"
}

{
  "_tag": "DeveloperApiConflict",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}

{
  "_tag": "DeveloperApiUnprocessable",
  "code": "<string>",
  "message": "<string>",
  "details": {}
}

{
  "_tag": "DeveloperApiRateLimited",
  "message": "<string>",
  "retry_after": 123
}

Get started

Orders

Menus

Delivery

Bookings

Core concepts

Tutorials

API reference

Endpoints

Resources

Search booking availability

Authorizations

Path Parameters

Query Parameters

Response