Skip to main content

Return a Reservation

GET 

/api/v1/reservations/:id

Return a Reservation

Request

Path Parameters

    id int32required

Query Parameters

    include string

    Include associations (delimited with comma). Available associations: bookings, tables, business, user

Responses

Return a Reservation

Schema

    data

    object

    id stringrequired
    type stringrequired

    Possible values: [reservations]

    links

    object

    required

    self stringrequired

    attributes

    object

    required

    comment stringnullablerequired
    date stringrequired
    email stringnullablerequired
    from numberrequired
    marketing-agreement boolean
    name stringrequired
    other-rejection-reason stringnullablerequired
    party-size numberrequired
    phone stringnullablerequired
    phone-country-code stringnullablerequired
    phone-country-prefix stringnullablerequired
    reject-reason stringnullablerequired
    state string
    status string

    table

    object

    nullable

    required

    id numberrequired
    business_id stringrequired
    floor_plan_id string
    number stringrequired
    number_of_seats numberrequired
    uuid stringrequired
    shape stringrequired
    rotation numberrequired
    position_x numberrequired
    position_y numberrequired
    guest-id string
    to numberrequired
    created-at stringrequired

    relationships

    object

    required

    bookings

    object

    required

    data

    object[]

    required

  • Array [

  • type stringrequired

    Possible values: [bookings]

    id stringrequired
  • ]

  • tables

    object

    required

    links

    object

    required

    self stringrequired
    related stringrequired

    business

    object

    required

    links

    object

    required

    self stringrequired
    related stringrequired

    user

    object

    required

    links

    object

    required

    self stringrequired
    related stringrequired

    meta

    object

    total-count numberrequired
    total-pages numberrequired
Loading...