Waitlist
Get waitlist
The active queue at a granted location, first in line first, and whether remote parties may join. Requires bookings:read. Maple-native locations only; other providers answer 422 capability_unsupported.
Get waitlist
curl --request GET \
--url https://api.maple.inc/v1/locations/{locationId}/waitlist \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.maple.inc/v1/locations/{locationId}/waitlist"
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}/waitlist', 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}/waitlist",
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}/waitlist"
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}/waitlist")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.maple.inc/v1/locations/{locationId}/waitlist")
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": "waitlist",
"location_id": "<string>",
"livemode": true,
"open": true,
"entries": [
{
"object": "waitlist_entry",
"id": "<string>",
"livemode": true,
"created": 123,
"location_id": "<string>",
"status": "waiting",
"party_size": 123,
"position": 123,
"quoted_wait": {
"parties_ahead": 123,
"wait_minutes": {
"min": 123,
"max": 123
}
},
"joined_at": "<string>",
"notified_at": "<string>",
"booking_id": "<string>",
"channel": "<string>",
"guest": {
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>",
"phone_last_four": "<string>",
"email": "<string>"
}
}
]
}{
"_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": "DeveloperApiUnprocessable",
"code": "<string>",
"message": "<string>",
"feedback": "<string>",
"details": {}
}{
"_tag": "DeveloperApiRateLimited",
"message": "<string>",
"retry_after": 123,
"feedback": "<string>"
}Authorizations
API key — mpk_test_… for the sandbox, mpk_live_… for production. Issued by Maple during partner onboarding.
Path Parameters
Response
Success
Available options:
waitlist Whether remote parties may join. The venue can still add parties in person while it is closed.
The active queue, first in line first.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Get waitlist
curl --request GET \
--url https://api.maple.inc/v1/locations/{locationId}/waitlist \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.maple.inc/v1/locations/{locationId}/waitlist"
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}/waitlist', 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}/waitlist",
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}/waitlist"
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}/waitlist")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.maple.inc/v1/locations/{locationId}/waitlist")
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": "waitlist",
"location_id": "<string>",
"livemode": true,
"open": true,
"entries": [
{
"object": "waitlist_entry",
"id": "<string>",
"livemode": true,
"created": 123,
"location_id": "<string>",
"status": "waiting",
"party_size": 123,
"position": 123,
"quoted_wait": {
"parties_ahead": 123,
"wait_minutes": {
"min": 123,
"max": 123
}
},
"joined_at": "<string>",
"notified_at": "<string>",
"booking_id": "<string>",
"channel": "<string>",
"guest": {
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>",
"phone_last_four": "<string>",
"email": "<string>"
}
}
]
}{
"_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": "DeveloperApiUnprocessable",
"code": "<string>",
"message": "<string>",
"feedback": "<string>",
"details": {}
}{
"_tag": "DeveloperApiRateLimited",
"message": "<string>",
"retry_after": 123,
"feedback": "<string>"
}