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

Overview

License Apache 2.0

Servers

https://api.understory.io/

Booking

This is an early version of the Bookings API specification.

The API is available in production for testing. Breaking changes might be introduced, but the overall specification is close to stable.

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.

Query

cursorstring

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

limitinteger(int32)

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&from=2019-08-24T14%3A15%3A22Z&limit=100&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.

experience_idstringrequired

The unique identifier for the experience.

company_idstringrequired

The unique identifier for the company.

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.

start_timestring(date-time)required

The start time of the event.

end_timestring(date-time)required

The end time of the event.

durationstring(iso-8601)required

The duration of the event, i.e. the time between start and end time.

For example, PT1H45M represents 1 hours and 45 minutes.

Example: "PT1H45M"

location_idstringrequired

The unique identifier for the location.

languagesArray of strings(iso-639-1)required

The languages spoken during the event.

Example: [["en","da"]]

statusstringrequired

The status of the event.

Enum"ACTIVE""INACTIVE""CANCELLED""DRAFT"

assigned_guidesArray of stringsrequired

The unique identifiers for the guides assigned to the event.

capacityobject(Capacity)required

The capacity of the event.

bookedintegerrequired

The minimum number of participants.

totalintegerrequired

The maximum number of participants.

is_fullbooleanrequired

Indicates if the event is full, i.e. booked is greater than or equal to total.

visibilitystringrequired

The visibility of the event.

Enum"PUBLIC""PRIVATE"

informationstring(MarkdownText)required

Additional information about the event.

cancellationobject(Cancellation)

The cancellation information for the event.

Is only present if the event is CANCELLED.

reasonstringrequired

The reason for the cancellation.

cancelled_onstring(date-time)required

The date and time when the event was cancelled.

cancelled_bystringrequired

The unique identifier for the user who cancelled the event.

Response

application/json

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

Get eventPreview

Request

Get an event by ID.

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.

experience_idstringrequired

The unique identifier for the experience.

company_idstringrequired

The unique identifier for the company.

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.

start_timestring(date-time)required

The start time of the event.

end_timestring(date-time)required

The end time of the event.

durationstring(iso-8601)required

The duration of the event, i.e. the time between start and end time.

For example, PT1H45M represents 1 hours and 45 minutes.

Example: "PT1H45M"

location_idstringrequired

The unique identifier for the location.

languagesArray of strings(iso-639-1)required

The languages spoken during the event.

Example: [["en","da"]]

statusstringrequired

The status of the event.

Enum"ACTIVE""INACTIVE""CANCELLED""DRAFT"

assigned_guidesArray of stringsrequired

The unique identifiers for the guides assigned to the event.

capacityobject(Capacity)required

The capacity of the event.

bookedintegerrequired

The minimum number of participants.

totalintegerrequired

The maximum number of participants.

is_fullbooleanrequired

Indicates if the event is full, i.e. booked is greater than or equal to total.

visibilitystringrequired

The visibility of the event.

Enum"PUBLIC""PRIVATE"

informationstring(MarkdownText)required

Additional information about the event.

cancellationobject(Cancellation)

The cancellation information for the event.

Is only present if the event is CANCELLED.

reasonstringrequired

The reason for the cancellation.

cancelled_onstring(date-time)required

The date and time when the event was cancelled.

cancelled_bystringrequired

The unique identifier for the user who cancelled the event.

Response

application/json

{
  "id": "string",
  "experience_id": "string",
  "company_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "start_time": "2019-08-24T14:15:22Z",
  "end_time": "2019-08-24T14:15:22Z",
  "duration": "PT1H45M",
  "location_id": "string",
  "languages": [
    [ … ]
  ],
  "status": "ACTIVE",
  "cancellation": {
    "reason": "string",
    "cancelled_on": "2019-08-24T14:15:22Z",
    "cancelled_by": "string"
  },
  "assigned_guides": [
    "string"
  ],
  "capacity": {
    "booked": 0,
    "total": 0,
    "is_full": true
  },
  "visibility": "PUBLIC",
  "information": "string"
}

Experience

This is a preview of the Experience API specification.

The API is not yet available in production.

Operations

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