Skip to content

Understory API (0.1.0)

This is the reference documentation for the Understory API. Here you can find detailed information about the API endpoints, request and response formats, and authentication methods.

For more general information, go to Documentation.

Preview

You’re exploring an early preview of the Understory API documentation. Take a look around and see what’s available.

Want to help us test and improve it? Share your feedback by clicking the chat icon in the bottom right. We’d love to hear your thoughts!

Download OpenAPI description
index.json
index.yaml
Overview
License

Apache 2.0

Languages
Servers

https://api.understory.io/

Booking

This is an early version of the Bookings API specification.

Most of these APIs are available in production for testing. Endpoints marked as "Preview" are not yet available in production.

Breaking changes might be introduced, but the overall specification is close to stable.

Operations

Experience

This is a preview of the Experience API specification.

The API is not yet available in production.

Operations

Event

This is a preview of the Events API specification.

The API is not yet available in production.

Operations

Get eventsPreview

Request

Get all events for the company.

Security
OAuth2
Query
cursorstring

The cursor for pagination. An empty string indicates the start of the list.

limitinteger(int32)[ 1 .. 1000 ]

The maximum number of events to return.

Default 100
fromstring(date-time)

Filter events based on the provided timestamp.

tostring(date-time)

Filter events based on the provided timestamp.

curl -i -X GET \
  'https://api.understory.io/v1/events?cursor=string&limit=100&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
nextstring

The cursor for the next page. An empty string indicates the end of the list.

itemsArray of objects(Event)
idstringrequired

The unique identifier for the event.

statestringrequired

The state of the event.

Enum"ACTIVE""INACTIVE""CANCELLED""COMPLETED"
visibilitystringrequired

The visibility of the event.

Enum"PUBLIC""PRIVATE"
experience_idstringrequired

The unique identifier for the experience.

capacityobject(Capacity)required

The capacity of the event.

totalintegerrequired

The total number of seats.

reservedintegerrequired

The number of reserved seats.

sessionsArray of objects(Session)[ 1 .. 10 ] itemsrequired

The sessions for the event.

idstringrequired

The unique identifier for the session.

start_timestring(date-time)required

The start time of the session.

end_timestring(date-time)required

The end time of the session.

timezonestringrequired

The IANA time zone name for the session.

Example: "Europe/Copenhagen"
location_idstringrequired

The unique identifier for the location of the session.

languagesArray of strings(iso-639-1)required

The languages spoken during the session.

Example: ["en"]
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)

A set of key-value pairs that are attached to the event for storing additional information.

example_keystring

Example of a metadata key.

property name*anyadditional property
Response
application/json
{
  "next": "string",
  "items": [
    { … }
  ]
}

Get eventPreview

Request

Get an event by its ID.

Security
OAuth2
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 for the event.

statestringrequired

The state of the event.

Enum"ACTIVE""INACTIVE""CANCELLED""COMPLETED"
visibilitystringrequired

The visibility of the event.

Enum"PUBLIC""PRIVATE"
experience_idstringrequired

The unique identifier for the experience.

capacityobject(Capacity)required

The capacity of the event.

totalintegerrequired

The total number of seats.

reservedintegerrequired

The number of reserved seats.

sessionsArray of objects(Session)[ 1 .. 10 ] itemsrequired

The sessions for the event.

idstringrequired

The unique identifier for the session.

start_timestring(date-time)required

The start time of the session.

end_timestring(date-time)required

The end time of the session.

timezonestringrequired

The IANA time zone name for the session.

Example: "Europe/Copenhagen"
location_idstringrequired

The unique identifier for the location of the session.

languagesArray of strings(iso-639-1)required

The languages spoken during the session.

Example: ["en"]
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)

A set of key-value pairs that are attached to the event for storing additional information.

example_keystring

Example of a metadata key.

property name*anyadditional property
Response
application/json
{
  "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": {
    "example_key": "string"
  }
}

Grow

This is a collection of endpoints related to Understory Grow.

Operations

Test

These endpoints are for testing purposes only.

You can use them to verify that your integration authentication works as intended.

Operations