Search.../
  1. Home
  2. Getting Started
  3. Overview
Generate a test token to explore our APIs

Is Available

Developer Preview

Returns the current availability of a requested entity.
Based on the requested entity, validate there is enough spots left.
When invoking on a locked session, availability is False.

Permissions
This endpoint requires the Read Bookings - Public Data permission scope.

Authorization

This endpoint requires an authorization header - pass the access token from the OAuth installation flow.

GET

https://www.wixapis.com/bookings/v1/availability

Query Params

NAME
TYPE
DESCRIPTION
partySize
Required

integer

Number of spots to query availability for.

ONE OF:
sessionId

string

Check if session with the given ID is available for booking

scheduleId

string

Check if schedule with the given ID is available for booking

session

object

Check if a time slot is available in a specified schedule.

Response Object

NAME
TYPE
DESCRIPTION
available

boolean

whether or not the requested entity is available for booking of the specified party size

capacity

integer

The maximum number of participants that can be added to the session.

totalNumberOfParticipants

integer

The current number of registered participants on this session

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Get Availability

Gets the provided session's availability

Request

curl

Copy Code
1curl --X GET /
2 'https://www.wixapis.com/bookings/v1/bookings/availability?sessionId=193ZPR9ppP9emJUCLevcLf6orynNEIDt5nc0520xjGQILnPPaF5s62yK3BWz7ExgIRM1VRioAcbF7zzwvoBTEIScx8fykHVtU2r5GoJrd7PuRidnB3zvYGeB6vu46SF7RN6M20Jg3OP1PZhRjhbotC5iz5mBXEncK2sHCaVgGczVpDEUts19ULscMtZ8dzmp6Hd6caRs6g5UcGtKSnvH5KJPYdojijsgantqsSTmGCItRoTcYi0dBhYzvxxB6Sv51iSs7tupi36hkw6Eau5FhC7P8jBQfZ0eFi7tZIeGUyoV39wexfMbu0kLn5nRTUVx5r0eSzENSJcV7F&partySize=1' \
3 -H 'Authorization: <AUTH>'

Response

json

1
2{
3 "available": true,
4 "capacity": 50,
5 "totalNumberOfParticipants": 0
6}