Skip to content

Get content blocks
Alpha

Request

Get the content blocks of an experience, such as what's included, the itinerary and nice to know.

Blocks are returned in the order Understory's own storefront presents them, in the language negotiated via the Accept-Language header. Blocks without content are omitted.

New block types and handles are added without a new API version. Clients must not fail on values they do not recognise.

Security
OAuth2(Required scopes: experience.read)
Path
experienceIdstringrequired

The ID of the experience.

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
curl -i -X GET \
  'https://api.understory.io/v1/experiences/{experienceId}/content-blocks?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 any(ContentBlock)
Response
{
  "next": "string",
  "items": [
    { … }
  ]
}