Skip to content

List Event Availability
Alpha

Request

Get availability for events of an experience.

Use this when you need availability for many events at once — for example, when rendering a calendar. For a single event, prefer GET /v1/event-availabilities/{eventId}. The response is paginated; pass the returned next cursor on subsequent calls to continue.

Security
OAuth2(Required scopes: event.read)
Query
experienceIdstringrequired

The unique identifier of the experience to query events for.

fromstring

Filter events with a session starting on or after this local date-time (inclusive). ISO 8601 date-time without timezone (e.g., 2025-10-09T08:00:00). The value is matched against each session's local start time; an event is returned when any of its sessions starts within the requested window.

Example:from=2025-10-09T08:00:00
tostring

Filter events with a session starting before this local date-time (exclusive). ISO 8601 date-time without timezone (e.g., 2025-10-10T18:00:00). The value is matched against each session's local start time; an event is returned when any of its sessions starts within the requested window.

Example:to=2025-10-10T18:00:00
cursorstring

Pagination cursor for fetching the next page of results. Omit or pass an empty string to start from the beginning of the list.

limitinteger, (int32), [ 1 .. 100 ]

Maximum number of items to return per page. Defaults to 50, maximum 100.

Default:50
curl -i -X GET \
  'https://api.understory.io/v1/event-availabilities?experienceId=string&from=2025-10-09T08%3A00%3A00&to=2025-10-10T18%3A00%3A00&cursor=string&limit=50' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
itemsArray of objects(EventAvailability)required

Availability information for events matching the query.

nextstring

Cursor for the next page of results. An empty string or absent value indicates the end of the list.

Response
{ "items": [ { … } ], "next": "string" }