# Understory API

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](/docs).

{% partial file="/_partials/preview-admonition.md" /%}


Version: 0.1.0
License: Apache 2.0

## Servers

```
https://api.understory.io
```

## Security

### OAuth2

OAuth2 authentication using the client credentials flow

Type: oauth2

## Download OpenAPI description

[Understory API](https://developer.understory.io/_spec/apis/index.yaml)

## 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.


### Get Bookings

 - [GET /v1/bookings](https://developer.understory.io/apis/booking/getbookings.md): Get all bookings.

### Create Booking

 - [POST /v1/bookings](https://developer.understory.io/apis/booking/createbooking.md): Create a new booking for an event.

### Get Booking

 - [GET /v1/bookings/{bookingId}](https://developer.understory.io/apis/booking/getbooking.md): Get a booking by its ID.

### Get Tickets

 - [GET /v1/bookings/{bookingId}/tickets](https://developer.understory.io/apis/booking/gettickets.md): Get all tickets for a booking.

### Get information requests

 - [GET /v1/experiences/{experienceId}/information-requests](https://developer.understory.io/apis/booking/getinformationrequestsforexperience.md): Information requests describes additional information that is collected during the booking flow.

These are usually presented as additional questions to be answered by the guest.


### Get ticket variants

 - [GET /v1/experiences/{experienceId}/ticket-variants](https://developer.understory.io/apis/booking/getticketvariantsforexperience.md): Ticket variants describe the ticket options available for booking an experience.


### Get information requests

 - [GET /v1/experiences/{experienceId}/information-requests](https://developer.understory.io/apis/experience/getinformationrequestsforexperience.md): Information requests describes additional information that is collected during the booking flow.

These are usually presented as additional questions to be answered by the guest.


### Get ticket variants

 - [GET /v1/experiences/{experienceId}/ticket-variants](https://developer.understory.io/apis/experience/getticketvariantsforexperience.md): Ticket variants describe the ticket options available for booking an experience.


## Experience

This is a preview of the Experience API specification.

The API is not yet available in production.


### Get information requests

 - [GET /v1/experiences/{experienceId}/information-requests](https://developer.understory.io/apis/booking/getinformationrequestsforexperience.md): Information requests describes additional information that is collected during the booking flow.

These are usually presented as additional questions to be answered by the guest.


### Get ticket variants

 - [GET /v1/experiences/{experienceId}/ticket-variants](https://developer.understory.io/apis/booking/getticketvariantsforexperience.md): Ticket variants describe the ticket options available for booking an experience.


### Get information requests

 - [GET /v1/experiences/{experienceId}/information-requests](https://developer.understory.io/apis/experience/getinformationrequestsforexperience.md): Information requests describes additional information that is collected during the booking flow.

These are usually presented as additional questions to be answered by the guest.


### Get ticket variants

 - [GET /v1/experiences/{experienceId}/ticket-variants](https://developer.understory.io/apis/experience/getticketvariantsforexperience.md): Ticket variants describe the ticket options available for booking an experience.


### Get experiences

 - [GET /v1/experiences](https://developer.understory.io/apis/experience/getexperiences.md): Get all experiences for the company.

### Get experience

 - [GET /v1/experiences/{experienceId}](https://developer.understory.io/apis/experience/getexperiencebyid.md): Get an experience by its ID.

## Event

This is a preview of the Events API specification.

The API is not yet available in production.


### Get events

 - [GET /v1/events](https://developer.understory.io/apis/event/getevents.md): Get all events for the company.

### Get event

 - [GET /v1/events/{eventId}](https://developer.understory.io/apis/event/getevent.md): Get an event by its ID.

## Grow

This is a collection of endpoints related to Understory Grow.

### Get marketing consents

 - [GET /v1/marketing-consents](https://developer.understory.io/apis/grow/getmarketingconsents.md): Get all marketing consents collected through Understory checkouts.

## Test

These endpoints are for testing purposes only.

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


### Who am I

 - [GET /v1/me](https://developer.understory.io/apis/test/getme.md): Get information about the current user.