List first-available booking slots

get https://api.waitwhile.com/v2/visits/first-available-slots

Responses

Response body

array of objects

object

date

date-time

Date and time of slot

duration

integer

≥ 0

Duration of slot in seconds

isWithinHours

boolean

Flag to indicate if time slot is within booking hours

numSpotsByResourceId

object

Capacity by resource

Has additional fields

numSpotsByServiceId

object

Capacity by service

Has additional fields

numBookedSpotsByResourceId

object

Booked spots by resource

Has additional fields

numBookedSpotsByServiceId

object

Booked spots by service

Has additional fields

numAvailableSpotsByResourceId

object

Available spots by resource

Has additional fields

numAvailableSpotsByServiceId

object

Available spots by service

Has additional fields

numSpots

integer

≥ 0

Capacity number of spots

numBookedSpots

integer

≥ 0

Booked number of spots

numAvailableSpots

integer

≥ 0

Available number of spots

bookings

array of objects

bookings

object

string

Identifier of visit

locationId

string

Identifier of location

type

string

Visit type

WAITLIST BOOKING BLOCK

customerId

string

Identifier of customer, automatically derived from visitor contact information if not provided.

externalId

string | null

External identifier, optionally provided by client

externalCustomerId

string | null

External customer identifier, optionally provided by client. Will take priority over other contact info when deriving customerId

name

string | null

Name of customer

firstName

string | null

First name of customer

lastName

string | null

Last name of customer

phone

string | null

Phone number in E.164 format

string | null

Email address

messagingTokens

array of objects

length ≤ 5

Tokens used for sending visit messages

messagingTokens

object

type

string

required

FCM

token

string

required

length between 1 and 2000

FCM token or similar

liveActivityToken

object

Update token for customer live activity

notes

string | null

Optional notes - Deprecated please use notes on customer/notes

serviceIds

array of strings | null

Service identifiers

serviceIds

resourceIds

array of strings | null

Resource identifiers

resourceIds

dataFields

array of objects | null

Data-fields

dataFields

object

string

Unique identifier

values

array

length ≤ 20

values

partySize

integer

1 to 100

Party size

quotedWaitDuration

integer

≥ 0

Wait duration estimated by client

position

integer | null

≥ 1

Current position in line

state

string

State of visit

PENDING DRAFT BOOKED WAITING SERVING COMPLETE

tags

date

string

Date and time of booking, must be in YYYY-MM-DDThh:mm format

duration

integer

0 to 86400

Duration of booking in seconds

isBlock

boolean

Flag to indicate if booking visit is used to block out calendar

source

string

Source where visit was created

WEB-APP IOS-APP ANDROID-APP PUBLIC KIOSK QR SMS EMAIL API RWG IMPORT IOS-APP-CLIP

locale

string

Locale in xx-YY format, where the first part is language and second country code, supported in public pages

ar-AE bg-BG ca-ES cs-CZ de-AT de-CH de-DE en-AU en-CA en-GB en-IN en-US es-ES es-MX es-PE es-PR eu-ES fr-CA fr-CH fr-FR hi-IN hr-HR hu-HU it-CH it-IT ja-JP ka-GE ko-KR nb-NO nl-NL pl-PL pt-PT ro-RO ru-RU sv-SE th-TH tr-TR zh-CN

publicId

string

Short identifier to be used in public links

ticket

string

Ticket of visit

originalPosition

integer | null

≥ 1

Original position in line when added to waitlist

created

date-time

Date and time of creation

updated

date-time

Date and time of last update

pendingTime

date-time

Date and time when visit became pending

draftTime

date-time

Date and time when visit became draft

bookingTime

date-time

Date and time when visit was booked

waitlistTime

date-time

Date and time when visit was added to waitlist

serveTime

date-time

Date and time when visit was served

completedTime

date-time

Date and time when visit was completed

cancelTime

date-time

Date and time when visit was cancelled

removedTime

date-time

Date and time when visit was removed

noShowTime

date-time

Date and time when visit was marked as no-show

confirmedTime

date-time

Date and time when visit was confirmed

arrivedTime

date-time

Date and time when visit was marked as arrived

prioritizedTime

date-time

Date and time when visit was prioritized

expiredTime

date-time

Date and time when visit was expired

flaggedTime

date-time

Date and time when visit was flagged

delayedTime

date-time

Date and time when visit was marked as delayed

importedTime

date-time

Date and time when visit was imported

nextInLineTime

date-time

Date and time when latest next-in-line message was sent

nextInLineTriggerTime

date-time

Date and time when visit first met next-in-line criteria

rejectedTime

date-time

Date and time when visit was rejected

alertedTime

date-time

Date and time when visit was first alerted

lastAlertedTime

date-time

Date and time when visit was last alerted

pendingExpireTime

date-time

Date and time when visit will expire

waitDuration

integer

≥ 0

Duration in waiting state before served

serveDuration

integer

≥ 0

Duration in serving state before completed

estWaitDuration

integer | null

≥ 0

Current estimated wait duration

originalEstWaitDuration

integer

≥ 0

Original estimated wait duration

createdBy

string

Identifier of creator

updatedBy

string

Identifier of last updater

isAnonymized

boolean

Flag to indicate if personal information has been anonymized

orderValue

object

The order value assigned to a visit

metadata

object | null

Store metadata about your objects. You can store 20 keys with max length 40. Values can be strings of max length 500.

Has additional fields

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.waitwhile.com/v2/visits/first-available-slots?showBookings=true&showDetails=true&isPublic=false' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful