Skip to content

Experience

An Experience is the product a company offers — for example, a guided tour, a workshop, or a tasting.

Experiences are templates: each Experience produces one or more Events (scheduled instances) that customers actually book. This API exposes experiences along with their information requests and ticket variants.

Operations
Webhooks

Get experiences
Alpha

Request

Get all experiences for the company.

Returns experiences in any non-deleted lifecycle state, including INACTIVE and ARCHIVED. Filter by state client-side if you only want bookable experiences. The response is paginated; pass the returned next cursor on subsequent calls to continue.

Security
OAuth2(Required scopes: experience.read)
Query
cursorstring

Pagination cursor for fetching the next page of results. Omit or pass an empty string to start from the beginning of the list.

limitinteger, (int32), [ 1 .. 100 ]

Maximum number of items to return per page. Defaults to 100, maximum 100.

Default:100
Headers
Accept-Languagestring(AcceptLanguageHeader)required

A lowercase ISO 639-1 language code (e.g. "da"), optionally followed by a hyphen and an uppercase ISO 3166-1 country code (e.g. "en-US").

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

Example:en-GB; q=1.0, en-US; q=0.8
GET
/v1/experiences
curl -i -X GET \
  'https://api.understory.io/v1/experiences?cursor=string&limit=100' \
  -H 'Accept-Language: en-GB; q=1.0, en-US; q=0.8' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
nextstring

Cursor for the next page of results. An empty string or absent value indicates the end of the list.

itemsArray of objects(Experience)
Response
{
  "next": "string",
  "items": [
    { … }
  ]
}