Listings API Reference

    Headers

    AuthorizationRequired
    An API key that can be found in your API settings

    Responses

    200 OK
    [
  {
    "id": "652f2df92960860c8985a46e",
    "restaurantId": "651cead6fc03dda80bfae1f1",
    "price": 20,
    "date": "2023-11-01T03:00:00.000Z",
    "guestCount": 2,
    "status": "VERIFIED",
    "offers": [],
    "perGuestCharge": 100,
    "perGuestChargeReason": "DINING_CREDIT"
  },
  {
    "id": "6535beb02922b759d035142c",
    "restaurantId": "651cead8fc03dda80bfae1f5",
    "price": 100,
    "date": "2023-11-22T23:59:34.879Z",
    "guestCount": 1,
    "status": "NEEDS_VERIFIED",
    "offers": []
  }
]

    Headers

    AuthorizationRequired
    An API key that can be found in your API settings

    Body

    guestsRequired
    number
    The number of guests listed in the reservation, must be greater than 1
    priceRequired
    number
    The desired listing price
    restaurantIdRequired
    string
    The ID of the restaurant that the listing is to be created on, restaurant IDs can be retrieved from /api/v1/restaurants. A slug (such as cote-korean-steakhouse-new-york) is also accepted.
    firstNameRequired
    string
    The first name on the reservation
    lastNameRequired
    string
    The last name on the reservation
    dateRequired
    string
    The date + time of the reservation in ISO date string format (ex. 2023-11-22T23:59:34.879Z)
    type
    string
    The type of reservation (if applicable). Options available at /v1/restaurants/[id] under the key of seatingTypes. View Restaurant API Docs
    perGuestCharge
    number
    A per guest charge to append to the buyers price of the listing, not shown until the purchase listing stage. Common charges include reservation fees, dining credits, or prix fixe meals
    perGuestChargeReason
    enum - DINING_CREDIT | PRIX_FIXE | RESERVATION_FEE_NONREFUNDABLE | RESERVATION_FEE_REFUNDABLE
    The reason for why a guest charge is required, this argument is optional however it is required if perGuestCharge is defined
    reservationPlatformUrl
    string
    The share URL of the reservation. Since other details are provided, the details fetched from the url will be overridden
    or
    restaurantIdRequired
    string
    The ID of the restaurant that the listing is to be created on, restaurant IDs can be retrieved from /api/v1/restaurants. A slug (such as cote-korean-steakhouse-new-york) is also accepted.
    priceRequired
    number
    The desired listing price
    lastName
    string
    lastName must be provided if the reservation url does not share the last name
    perGuestCharge
    number
    A per guest charge to append to the buyers price of the listing, not shown until the purchase listing stage. Common charges include reservation fees, dining credits, or prix fixe meals
    perGuestChargeReason
    enum - DINING_CREDIT | PRIX_FIXE | RESERVATION_FEE_NONREFUNDABLE | RESERVATION_FEE_REFUNDABLE
    The reason for why a guest charge is required, this argument is optional however it is required if perGuestCharge is defined
    reservationPlatformUrlRequired
    string
    The share URL of the reservation (ex. resy.com/i/resid)

    Responses

    200 OK
    {
  "id": "65370b237d6438c7db4e731b",
  "createdAt": "2023-10-24T00:09:07.740Z",
  "updatedAt": "2023-10-24T00:09:07.740Z",
  "status": "NEEDS_VERIFIED",
  "name": "test name",
  "date": "2023-11-22T23:59:34.879Z",
  "guestCount": 1,
  "price": 100,
  "restaurantId": "651cead8fc03dda80bfae1f5",
  "userId": "65249e5ed7372579c90e8e1c",
  "saleId": null,
  "reviewId": null
}

    Headers

    AuthorizationRequired
    An API key that can be found in your API settings

    Responses

    200 OK
    {
  "id": "6535beb02922b759d035142c",
  "date": "2023-11-22T23:59:34.879Z",
  "price": 100,
  "guestCount": 1,
  "restaurantId": "651cead8fc03dda80bfae1f5",
  "status": "NEEDS_VERIFIED",
  "sale": null,
  "offers": []
}

    Headers

    AuthorizationRequired
    An API key that can be found in your API settings

    Body

    price
    string
    The updated listing price

    Responses

    200 OK
    {
  "id": "6535beb02922b759d035142c",
  "createdAt": "2023-10-24T00:09:07.740Z",
  "updatedAt": "2023-10-24T00:09:07.740Z",
  "status": "NEEDS_VERIFIED",
  "name": "test name",
  "date": "2023-11-22T23:59:34.879Z",
  "guestCount": 1,
  "price": 150,
  "restaurantId": "651cead8fc03dda80bfae1f5",
  "userId": "65249e5ed7372579c90e8e1c",
  "saleId": null,
  "reviewId": null
}

    Headers

    AuthorizationRequired
    An API key that can be found in your API settings

    Responses

    204 OK
    ""

    Headers

    AuthorizationRequired
    An API key that can be found in your API settings

    Body

    restaurantIdRequired
    string
    The ID of the restaurant to search for listings on
    minDateRequired
    string
    The minimum date of the listing, must be an ISO formatted date
    maxDateRequired
    string
    The maximum date of the listing, must be an ISO formatted date

    Responses

    200 OK
    [
  {
    "restaurantId": "651ceb05fc03dda80bfae25d",
    "date": "2024-04-16T19:00:00.000Z",
    "guestCount": 5,
    "price": 110,
    "perGuestCharge": null,
    "totalPrice": 110,
    "restaurantName": "Cote Korean Steakhouse"
  },
  {
    "restaurantId": "651ceb05fc03dda80bfae25d",
    "date": "2024-04-16T19:00:00.000Z",
    "guestCount": 6,
    "price": 60,
    "perGuestCharge": null,
    "totalPrice": 60,
    "restaurantName": "Cote Korean Steakhouse"
  },
  "..."
]

    Responses

    200 OK
    [
  {
    "id": "65bb07e9c4579a58254ce705",
    "date": "2024-02-17T10:00:00.000Z",
    "price": 200,
    "guestCount": 1,
    "restaurantId": "651ceb05fc03dda80bfae25d",
    "status": "VERIFIED",
    "perGuestCharge": null,
    "perGuestChargeReason": null,
    "reservationPlatformUrl": null,
    "sale": {
      "id": "65c431798813d215e7d43eeb",
      "price": 250,
      "confirmationId": "pi_3OhJcvJM5vZIAxLo0D4RKzIV",
      "createdAt": "2024-02-08T01:42:17.073Z"
    },
    "offers": []
  },
  "..."
]
    Explore
    Support