Skip to content

Event Availability

Query availability for events.

Availability is computed from multiple inputs — the event's lifecycle state, its remaining seat capacity, configured booking limits, the booking cutoff, and the per-ticket-variant resource limits. The response always returns every applicable constraint (both passing and failing), so callers can tell exactly why an event is or is not bookable.

Operations

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.

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": [
    { … }
  ]
}