Developers Search documentation⌘ / Ctrl K

Guides

Overview Start integrating Embed a guest widget JavaScript & TypeScript SDK Access & authentication Webhooks & signatures Errors, retries & limits Translation key catalog Changelog

Client systems

Partner preorders

Connection guide GETRead the partner preorder catalog POSTIssue a partner-scoped commercial preorder quote POSTCreate a partner preorder order GETRead a partner preorder order

External orders & POS

Connection guide POSTIngest a signed external order revision POSTIngest a signed external-order cancellation revision

Guest experiences

Published storefronts

Connection guide GETRead a published restaurant or brand storefront GETRead a storefront for a selected actual venue GETList publicly attached brand outlets GETResolve a published storefront by verified hostname GETBootstrap one verified widget frame GETList attached outlets for a verified widget frame

QR table access and ordering

Connection guide GETResolve a public table locator POSTRequest current-session table admission GETRead an owned table join POSTClaim approved native table membership GETRead current native table membership GETRead the current native table ordering catalog POSTQuote an owned guest table-order batch POSTSubmit an immutable guest table-order request GETList only the caller membership order-request receipts GETRead one owned guest order request and original native outcome GETRead the server-owned QR history statement POSTPrepare isolated QR contact verification POSTPrepare QR association from verified Portal reentry POSTAssociate verified own QR history atomically

Guest resource observers

Connection guide POSTRead a native resource observer baseline POSTIssue a native resource observer ticket

Guest payments

Connection guide POSTOpen native guest payment access POSTBind a guest payment checkout handoff POSTRedeem a receiver-bound guest payment handoff GETRead the currently collectible native guest bill POSTReview a server-derived automatic order payment POSTFreeze the reviewed guest financial offer POSTAccept the exact offer and create its original checkout POSTRecover an acknowledgement after a lost create response GETRead original acknowledgement and current checkout status POSTRecover the original guest checkout POSTPrepare a private widget checkout transition POSTClaim a widget transition for its saved receiver

Reservations & waitlist

Connection guide GETGet the public booking projection GETGet publicly bookable slots GETGet exact native guarantee terms for a selected booking slot POSTCreate a verified public booking intent and hold POSTCreate a remote waitlist verification intent GETRead the owning public intent verification state POSTVerify and atomically convert a public intent POSTResend contact verification within policy limits POSTVerify the existing guest for a proposed guarantee agreement POSTRead the proposed agreement after real guest verification POSTAccept the exact verified guarantee agreement GETRead an owned reservation or waitlist entry POSTConfirm a guest-owned reservation POSTChange a guest-owned reservation POSTCancel a guest-owned reservation POSTClaim a guest-owned waitlist entry POSTCancel a guest-owned waitlist entry POSTPrepare contact recovery from an owned reservation or waitlist

Guest ordering

Connection guide POSTPrepare contact recovery from an owned preorder session GETGet the publicly eligible preorder catalog GETRead bounded public scheduled fulfillment slot choices POSTCreate an encrypted public preorder draft GETResume a public preorder draft PUTUpdate and re-verify a public preorder draft POSTVerify contact and issue a commercial quote POSTAccept a single-use public preorder quote POSTDecline an issued public preorder quote POSTExchange a URL-safe grant for a manage session GETView the guest-owned preorder projection POSTCancel a preorder within the guest policy boundary POSTQuote a guest reschedule or cart change POSTAccept a guest amendment quote

Guest portal

Connection guide POSTExchange a Guest Portal bootstrap token GETGet guest-owned profile PATCHUpdate guest-owned profile GETGet guest-owned consent preferences POSTRecord guest-owned consent preference PATCHUpdate guest-owned marketing preferences GETGet guest-owned loyalty account GETGet guest-owned privacy requests POSTCreate a guest-owned privacy request GETList guest-owned restaurant history POSTRevoke guest portal session POSTPrepare private contact recovery context for the current Portal POSTRequest targeted Guest Portal reentry POSTConfirm targeted Guest Portal reentry GETRead own reservation history GETRead own waitlist history GETRead own preorder history POSTPrepare contact proof for one native management target POSTBind an actual reentry verification to a native target POSTVerify the exact prepared native target proof GETRead saved native target proof metadata POSTEnter native management using an exact fresh target proof GETList own retained payment receipts GETRead an owned original QR visit GETRead current QR history consent and statement POSTPrepare fresh QR reconsent contact proof POSTPrepare QR reconsent from real current reentry POSTAppend fresh verified QR history consent POSTWithdraw own QR history consent GETList own original QR order receipts GETRead one own frozen QR order receipt

Careers

Connection guide GETRead a public career posting POSTSubmit a public career application

Candidate portal

Connection guide GETRead the authenticated candidate profile POSTWithdraw a candidate application POSTRespond to a candidate offer

Specialized integrations

Audit & SIEM

Connection guide POSTIngest a signed external audit event batch

Workforce events

Connection guide POSTAccept a signed, replay-safe workforce provider event

Guest communications

Connection guide POSTIngest a signed provider inbound message POSTIngest a signed provider delivery event

Payment callbacks

Connection guide POSTIngest a signed provider payment-attempt event

Bank callbacks

Connection guide POSTIngest a verified Plaid bank-feed event POSTIngest a verified Salt Edge bank-feed event

Download OpenAPI

Sections