Bookings

Get booking profile

Whether a granted location accepts partner bookings right now, which provider serves it, the capability set its provider declares (hold release, venue verbs, time-window listing, live floor), and the hold TTL. Read this before calling any other bookings endpoint: enabled: false means the location is not bookable through the Developer API yet, and a false capability is what the matching verb answers with capability_unsupported. Requires bookings:read.

Get booking profile

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

import requests

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

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_profile', 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_profile",
  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_profile"

	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_profile")

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": "booking_profile",
  "location_id": "<string>",
  "livemode": true,
  "enabled": true,
  "provider": "maple",
  "capabilities": {
    "hold_release": true,
    "confirm_decline": true,
    "seat": true,
    "no_show": true,
    "window_lookup": true,
    "floor_status": true,
    "experiences": true
  },
  "blackout_dates": [
    {
      "start_date": "<string>",
      "end_date": "<string>",
      "start_time": "<string>",
      "end_time": "<string>",
      "reason": "<string>"
    }
  ],
  "blackout_dates_revision": "<string>",
  "hold_ttl_seconds": 123
}

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

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

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

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

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

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

Response

Success

object

enum<string>

required

Available options:

booking_profile

location_id

string

required

livemode

boolean

required

True when read with a live credential; test credentials only ever see test-mode data.

enabled

boolean

required

True when this location accepts partner bookings through the Developer API right now. When false, every other bookings endpoint for the location returns bookings_not_enabled.

provider

enum<string> | null

required

The provider behind the location’s booking connection, or null when none is configured.

Available options:

maple,

opentable,

resy,

sevenrooms

capabilities

object

required

Show child attributes

blackout_dates

object[]

required

Windows when the location takes no reservations, in start order (walk-ins and waitlist seating are unaffected). Availability omits slots inside them. A quote taken before a window was added is refused when held, booked, or used for a change: 409 slot_unavailable at Maple-native locations, whose engine also withholds seatings that would run into a window, and 422 date_blocked at provider-managed ones.

Show child attributes

blackout_dates_revision

string

required

The revision of blackout_dates. Send it as expected_revision to PUT /booking_blackouts so the write is refused (409 stale_blackout_dates) if the venue changed the list since you read it.

hold_ttl_seconds

required

How long a hold taken through POST /booking_holds claims capacity before it expires, when Maple enforces the hold lifetime. Null when the location’s provider owns hold expiry (read expires_at on each hold) or no provider is configured.

⌘I

Get booking profile

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

import requests

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

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_profile', 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_profile",
  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_profile"

	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_profile")

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": "booking_profile",
  "location_id": "<string>",
  "livemode": true,
  "enabled": true,
  "provider": "maple",
  "capabilities": {
    "hold_release": true,
    "confirm_decline": true,
    "seat": true,
    "no_show": true,
    "window_lookup": true,
    "floor_status": true,
    "experiences": true
  },
  "blackout_dates": [
    {
      "start_date": "<string>",
      "end_date": "<string>",
      "start_time": "<string>",
      "end_time": "<string>",
      "reason": "<string>"
    }
  ],
  "blackout_dates_revision": "<string>",
  "hold_ttl_seconds": 123
}

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

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

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

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

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

Get started

Orders

Menus

Delivery

Bookings

Core concepts

Tutorials

API reference

Endpoints

Resources

Get booking profile

Authorizations

Path Parameters

Response