Skip to content

Get events
Alpha

Request

Get all events.

The response includes events in every non-deleted lifecycle state (ACTIVE, INACTIVE, CANCELLED, COMPLETED); apply state filtering client-side if you only want bookable events.

Results are ordered by session start time. Each event is returned once, positioned by its earliest session that matches the from/to window.

Security
OAuth2(Required scopes: event.read)
Query
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 .. 500 ]

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

Default:100
fromstring

Filter events with a session starting on or after this local date-time (inclusive). ISO 8601 date-time without a timezone offset (e.g. 2025-01-15T09: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-01-15T09:00:00
tostring

Filter events with a session starting before this local date-time (exclusive). ISO 8601 date-time without a timezone offset (e.g. 2025-01-15T18: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-01-15T18:00:00
experience_idstring

Restrict the result to events of a single experience. The filter strictly scopes results — no events from other experiences are returned.

curl -i -X GET \
  'https://api.understory.io/v1/events?cursor=string&limit=100&from=2025-01-15T09%3A00%3A00&to=2025-01-15T18%3A00%3A00&experience_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
nextstring

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

itemsArray of objects(Event)
Response
{
  "next": "string",
  "items": [
    { … }
  ]
}