Sign in
Sessions

Fetch a Session's waitlist

Returns a support/admin-facing view of a Session's waitlist: who is currently queued (in order), who has already been promoted off the waitlist, and the waitlist-related entries from the session log — so "why did X get in ahead of Y?" can be answered without a database query.

Requires the RESERVATIONS_VIEW permission on the session's site.

get/shop/sessions/{sessionId}/waitlist

Response

The session's waitlist was successfully retrieved.

Example response

{
  "data": {
    "capacity": 2,
    "num_booked": 2,
    "waitlist_enabled": true,
    "num_waitlisted": 2,
    "waitlist": [
      {
        "position": 1,
        "order_ref": "AB2SYY",
        "name": "Jane Doe",
        "num_customers": 1
      }
    ],
    "promotions": [
      {
        "order_ref": "EF4UAA",
        "name": "Alex Brown"
      }
    ],
    "logs": [
      {
        "level": "info",
        "message": "Booking (AB2SYY) was moved from the wait list."
      }
    ]
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.