Skip to main content
GET
Get waitlist

Authorizations

Authorization
string
header
required

Your brand's secret API key, e.g. Bearer way_sk_live_bhEqcn0i1fRoUEHBPjJkQA. Older Way-Brand-Id + Way-Secret-Key credentials still work: see Legacy authentication.

Path Parameters

brandId
string
required

The brand's ID - must match the brand your API key identifies (or the Way-Brand-Id header when one is sent).

waitlistId
string
required

The waitlist's ID, from the listing or experience data.

Response

200 - application/json

Get waitlist.

id
string
required

The unique identifier of the waitlist.

Example:

"waitlist-123"

mode
enum<string>
required

Mode of the waitlist.

Available options:
auto,
manual,
none
Example:

"auto"

shouldShowRemovedEntries
boolean
required

Indicates if removed entries should be shown.

Example:

false

claimTime
object | null

Claim time interval in seconds (nullable)

Example:

3600