Waitlist

Estimate the wait

The wait a new party of `party_size` would be quoted now: the parties ahead that compete for the same tables and a minutes band, never a single number.

Esta página aún no está disponible en tu idioma.

GEThttps://api.maple.inc/v1/locations/{locationId}/waitlist_estimateAPI key

The wait a new party of party_size would be quoted now: the parties ahead that compete for the same tables and a minutes band, never a single number. Parties above 50 answer 422 party_size_out_of_bounds. Requires bookings:read.

Authorization

Send your API key as Authorization: Bearer <key>: mpk_test_… against the sandbox (https://api.staging.maple.inc/v1), mpk_live_… against production. See Authentication. The samples read the key from MAPLE_KEY and the base URL from MAPLE_BASE, as set up in the Quickstart.

Parameters

locationId string path required
party_size string query required

Responses

200 OK

object string required

Always waitlist_estimate.
location_id string required
livemode boolean required
party_size integer required
parties_ahead integer required
wait_minutes object required
wait_minutes.min integer required
wait_minutes.max integer required

Errors

400 Bad request DeveloperApiBadRequest
401 Unauthorized DeveloperApiUnauthorized
403 Forbidden DeveloperApiForbidden
404 Not found DeveloperApiNotFound
422 Unprocessable DeveloperApiUnprocessable
429 Too many requests DeveloperApiRateLimited

Every error body names the error in _tag, explains it in message, and says where to report it in feedback. See Errors.

A 429 also sends Retry-After: Seconds to wait before retrying; also returned as retry_after in the body.

Estimate the wait

curl "$MAPLE_BASE/locations/str_123/waitlist_estimate?party_size=2" \
  -H "Authorization: Bearer $MAPLE_KEY"

import os
import requests

r = requests.get(
    f"{os.environ['MAPLE_BASE']}/locations/str_123/waitlist_estimate?party_size=2",
    headers={"Authorization": f"Bearer {os.environ['MAPLE_KEY']}"},
    timeout=30,
)
r.raise_for_status()
print(r.json())

const res = await fetch(`${process.env.MAPLE_BASE}/locations/str_123/waitlist_estimate?party_size=2`, {
  headers: {
    Authorization: `Bearer ${process.env.MAPLE_KEY}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());

{
  "object": "waitlist_estimate",
  "location_id": "str_123",
  "livemode": true,
  "party_size": 1,
  "parties_ahead": 1,
  "wait_minutes": {
    "min": 1,
    "max": 1
  }
}

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