Skip to content

Get Event Availability
Alpha

Request

Get the availability for a single event.

Returns availability information including remaining seats and constraints.

Security
OAuth2(Required scopes: event.read)
Path
eventIdstringrequired

The unique identifier of the event.

curl -i -X GET \
  'https://api.understory.io/v1/event-availabilities/{eventId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
event_idstringrequired

The unique identifier of the event whose availability is described.

availablebooleanrequired

Whether the event is currently bookable. false if any constraint in constraints reports available: false, or if the host has closed the event's date to new bookings.

constraintsArray of any(EventAvailabilityConstraint)required

Every constraint that applies to this event, in no particular order. Both passing (available: true) and failing constraints are included.

Response
{ "event_id": "string", "available": true, "constraints": [ { … } ] }