List a restaurant's reservations

GET

/api/v1/partnership/restaurants/{restaurant_pk}/reservations/

const url = 'https://public.api.barestho.com/api/v1/partnership/restaurants/example/reservations/';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://public.api.barestho.com/api/v1/partnership/restaurants/example/reservations/ \
  --header 'Authorization: Basic <credentials>'

Returns all reservations for the specified restaurant that are accessible to the authenticated partner. Results include reservations in all states (pending, confirmed, cancelled, no-show, etc.).

Authorizations

basicAuth

Parameters

Path Parameters

restaurant_pk

required

string

The unique identifier of the restaurant whose reservations are listed.

Responses

200

A list of reservations for the specified restaurant.

application/json

Array<object>

Represents a dining reservation at a restaurant. The lifecycle of a reservation progresses through several states: created → confirmed → arrived (or no-show), and may be cancelled at any point before arrival.

object

Unique numeric identifier for the reservation, assigned by the server.

integer

first_name

First name of the guest holding the reservation. Maximum 255 characters.

string

nullable <= 255 characters

last_name

Last name of the guest holding the reservation. Maximum 255 characters.

string

nullable <= 255 characters

email

Email address of the guest. Used for booking confirmations and reminders.

string format: email

nullable <= 254 characters

phone

Phone number of the guest. Maximum 128 characters.

string

nullable <= 128 characters

start_time

required

ISO 8601 date-time indicating when the reservation begins. Should be expressed in the restaurant’s local timezone (see PartnerRestaurant.timezone). Required.

string format: date-time

duration

Duration of the reservation slot as an ISO 8601 duration string (e.g. PT2H). Calculated and set by the server based on the restaurant’s slot configuration.

string

adults

required

Number of adult guests in the party. Must be between 1 and 50 (inclusive). Required.

integer

>= 1 <= 50

children

Number of child guests in the party. Defaults to 0 if omitted. Must be between 0 and 50 (inclusive).

integer

<= 50

comment

Optional free-text comment from the guest or partner (e.g. dietary requirements, special occasion notes). Visible to the restaurant.

string

nullable

cancelled

true if the reservation has been cancelled. Set this to true via PATCH to cancel a reservation. The cancelled_at timestamp is set automatically.

boolean

cancelled_at

ISO 8601 timestamp of when the reservation was cancelled. Set automatically by the server when cancelled transitions to true.

string format: date-time

nullable

confirmed

true if the reservation has been confirmed by the restaurant. For synchronous confirmation mode, this is set to true immediately upon creation.

boolean

confirmed_at

ISO 8601 timestamp of when the reservation was confirmed. Set automatically by the server when confirmed transitions to true.

string format: date-time

nullable

confirmation_mode

Defines how the reservation is confirmed: - CONFIRMATION_MODE_SYNCHRONOUS: The reservation is confirmed immediately upon creation. confirmed will be true in the creation response.

CONFIRMATION_MODE_ASYNCHRONOUS: The reservation requires explicit confirmation by the restaurant. Poll the reservation or listen to webhooks to detect when confirmed becomes true.

string

Allowed values: CONFIRMATION_MODE_SYNCHRONOUS CONFIRMATION_MODE_ASYNCHRONOUS

arrived

true if the guest has checked in at the restaurant. Set this to true via PATCH when the guest arrives. The arrived_at timestamp is set automatically.

boolean

arrived_at

ISO 8601 timestamp of when the guest was marked as arrived. Set automatically by the server when arrived transitions to true.

string format: date-time

nullable

no_show

true if the guest did not show up for the reservation. Set this to true via PATCH to record a no-show. The no_show_at timestamp is set automatically.

boolean

no_show_at

ISO 8601 timestamp of when the reservation was marked as a no-show. Set automatically by the server when no_show transitions to true.

string format: date-time

nullable

language

BCP 47 language tag representing the guest’s preferred language (e.g. en, fr, nl). Used to localise guest-facing communications.

string

metadata

Arbitrary key-value pairs that the partner can attach to a reservation for their own tracking purposes (e.g. internal booking reference, campaign ID). The platform stores this data as-is and does not interpret it.

object

key

additional properties

Example

[
  {
    "confirmation_mode": "CONFIRMATION_MODE_SYNCHRONOUS"
  }
]