Skip to content

Get event
Alpha

Request

Get an event by its ID.

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

The unique identifier for the event.

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

Responses

OK

Bodyapplication/json
idstringrequired

The unique identifier of the event.

statestringrequired

The lifecycle state of the event.

  • ACTIVE — bookable; the default operational state. A host closing the event's date to new bookings leaves it ACTIVE: Get Event Availability tells whether the event can be booked now.
  • INACTIVE — not currently bookable. Can transition back to ACTIVE.
  • CANCELLED — terminal. The event was cancelled and cannot be made bookable again.
  • COMPLETED — terminal. The event's sessions have all elapsed.
  • UNKNOWN — defensive default; should not appear on a correctly configured event.
Enum:"ACTIVE""INACTIVE""CANCELLED""COMPLETED""UNKNOWN"
visibilitystringrequired

Who can discover the event.

  • PUBLIC — discoverable through public listings and search.
  • PRIVATE — accessible only via direct link or referral; not publicly discoverable.
  • UNKNOWN — defensive default; should not appear on a correctly configured event.
Enum:"PUBLIC""PRIVATE""UNKNOWN"
experience_idstringrequired

The unique identifier of the experience this event is an instance of.

capacityobject(Capacity)required

The seat capacity of the event. Capacity is shared across all sessions: a single booking that attends every session counts once against reserved.

sessionsArray of objects, [ 1 .. 50 ] items(Session)required

The sessions that make up the event, in chronological order.

An event has between 1 and 50 sessions; multi-session events are booked together as a single reservation that covers every session.

created_atstring, (date-time)required

The date and time when the event was created.

updated_atstring, (date-time)required

The date and time when the event was last updated.

metadataobject(Metadata)

Free-form key-value pairs attached by the integrator.

Example:
{
  "key1": "value1",
  "key2": "value2"
}
Response
{
  "id": "string",
  "state": "ACTIVE",
  "visibility": "PUBLIC",
  "experience_id": "string",
  "capacity": {
    "total": 0,
    "reserved": 0
  },
  "sessions": [
    { … }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  }
}