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.
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!
https://api.understory.io/
https://api.understory.io/v1/bookings
curl -i -X GET \
'https://api.understory.io/v1/bookings?cursor=string&limit=100&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z&sort=-created_at' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'OK
The status of the booking.
The customer that made the booking.
For private customers, this is always "PRIVATE"
Address lines. The first line is the primary address line, e.g. street name and number. The second line is the secondary address line, e.g. apartment number.
Combination of language and country/region. The format is a lowercase ISO 639-1 language code followed by an optional hyphen and an uppercase ISO 3166-1 country code.
{ "next": "string", "items": [ { … } ] }
The customer making the booking.
The customer making the booking.
For company customers, this is always "COMPANY"
Address lines. The first line is the primary address line, e.g. street name and number. The second line is the secondary address line, e.g. apartment number.
Combination of language and country/region. The format is a lowercase ISO 639-1 language code followed by an optional hyphen and an uppercase ISO 3166-1 country code.
https://api.understory.io/v1/bookings
curl -i -X POST \
https://api.understory.io/v1/bookings \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"event_id": "string",
"customer": {
"customer_type": "PRIVATE",
"company_name": "string",
"vat_number": "string",
"email": "user@example.com",
"name": "string",
"phone": "string",
"address": {
"address_lines": [
"string"
],
"city": "string",
"zip_code": "string",
"region": "string",
"country": "string"
}
},
"locale": "string",
"items": [
{
"type_id": "string",
"item_type": "VARIANT",
"quantity": 1
}
],
"metadata": {
"property1": "string",
"property2": "string"
}
}'{ "id": "string", "status": "ACTIVE" }
https://api.understory.io/v1/bookings/{bookingId}
curl -i -X GET \
'https://api.understory.io/v1/bookings/{bookingId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'OK
The status of the booking.
The customer that made the booking.
For private customers, this is always "PRIVATE"
Address lines. The first line is the primary address line, e.g. street name and number. The second line is the secondary address line, e.g. apartment number.
Combination of language and country/region. The format is a lowercase ISO 639-1 language code followed by an optional hyphen and an uppercase ISO 3166-1 country code.
{ "id": "string", "status": "ACTIVE", "source": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "company_id": "string", "experience_id": "string", "event_id": "string", "locale": "string", "customer": { "customer_type": "PRIVATE", "company_name": "string", "vat_number": "string", "email": "user@example.com", "name": "string", "phone": "string", "address": { … } }, "internal_note": "string", "metadata": { "property1": "string", "property2": "string" } }
https://api.understory.io/v1/bookings/{bookingId}/tickets
curl -i -X GET \
'https://api.understory.io/v1/bookings/{bookingId}/tickets' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'{ "items": [ { … } ] }
Combination of language and country/region. The format is a lowercase ISO 639-1 language code followed by an optional hyphen and an uppercase ISO 3166-1 country code.
If no value matches what is available in the host's Storefront, an error response is returned.
You can optionally provide multiple language-country pairs with a priority, separated by commas based on content negotation.
https://api.understory.io/v1/experiences/{experienceId}/information-requests
curl -i -X GET \
'https://api.understory.io/v1/experiences/{experienceId}/information-requests?cursor=string&limit=100' \
-H 'Accept-Language: en-GB; q=1.0, en-US; q=0.8' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'OK
What type of response is expected from the guest.
This will be extended in the future with additional types, eg. MULTI_CHOICE.
Defines at what scope this information is collected.
If the scope is BOOKING, the information is collected once per booking, eg. "Something something".
If the scope is TICKET, the information is collected for each ticket in the booking, eg. "What size of bicycle do you want?".
{ "next": "string", "items": [ { … } ] }
Combination of language and country/region. The format is a lowercase ISO 639-1 language code followed by an optional hyphen and an uppercase ISO 3166-1 country code.
If no value matches what is available in the host's Storefront, an error response is returned.
You can optionally provide multiple language-country pairs with a priority, separated by commas based on content negotation.
https://api.understory.io/v1/experiences/{experienceId}/ticket-variants
curl -i -X GET \
'https://api.understory.io/v1/experiences/{experienceId}/ticket-variants?cursor=string&limit=100' \
-H 'Accept-Language: en-GB; q=1.0, en-US; q=0.8' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'{ "next": "string", "items": [ { … } ] }