Skip to main content
GET
cURL

Authorizations

Headout-Auth
string
header
required

Path Parameters

productId
string
required

ID of the product to fetch.

Query Parameters

currencyCode
string

Currency code for product pricing.

fetch-variants
boolean

Flag to fetch product variants.

language
enum<string>
default:EN

Language code for localization. Content falls back to English when a translation is unavailable.

Available options:
EN,
ES,
FR,
IT,
DE,
PT,
NL,
PL,
KO,
JA,
ZH_HANS,
ZH_HANT,
AR,
DA,
NO,
RO,
RU,
SV,
TR
Example:

"EN"

Response

200 - application/json

Successful response

id
integer

Headout's unique product identifier. Use this to fetch full product details via the getProductById endpoint.

name
string

Display name of the experience (e.g., "Skip-the-Line Tickets to the Eiffel Tower").

url
string

Relative URL path for this product page on Headout.

canonicalUrl
string

The canonical Headout URL for this product page. Use for linking and affiliate tracking.

neighbourhood
string | null

Neighbourhood or locality where the experience takes place (e.g., "Times Square", "Old Town").

content
object[] | null

Structured content sections for this product. Each item contains a title, section type, and HTML content.

city
object

The city where this experience takes place.

displayTags
string[]

Display tags associated with the product (e.g., "Best Seller", "Top Rated").

images
object[]

Product images for display in product detail pages.

startLocation
object

Meeting or departure point for this experience, including GPS coordinates and optional address.

endLocation
object | null

Drop-off or end point for this experience. Same structure as startLocation. Null if the experience ends at the start location.

productType
enum<string>

Experience category. Useful for filtering and display logic.

Available options:
TOUR,
ACTIVITY,
EVENT,
ATTRACTION,
TRANSFER,
AIRPORT_TRANSFER,
ADD_ON
ratingCumulative
object

Aggregated rating and review count from verified Headout customers.

pricing
object

Starting price for display on product cards. Reflects the cheapest available variant.

currency
object

Currency in which all prices in this response are denominated.

hasInstantConfirmation
boolean

Whether bookings for this product are confirmed immediately without manual review.

hasMobileTicket
boolean

Whether this product supports mobile/digital tickets (no print required).

inventorySelectionType
enum<string>

Inventory selection flow for this product. Determines how date/time selection should be presented to users.

Available options:
NORMAL,
SEATMAP
variants
object[]
contentListHtml
object[] | null

Structured content sections for this product in HTML format. Complements the content field with pre-rendered HTML for rich display.

topReviews
object[] | null

Top customer reviews for this product. Useful for displaying social proof on product pages.