Skip to main content
GET
Retrieve bookable experiences (tickets, tours, activities) for a specific city. Filter results by collection, category, or subcategory to narrow down products. Each product includes pricing, images, reviews, availability info, and cancellation policies. Use primaryCategoryOnly=true together with categoryId to restrict results to products whose primary category matches — excluding products where that category is only a secondary association.

Authorizations

Headout-Auth
string
header
required

Query Parameters

cityCode
string
required

Uppercase city identifier (e.g., NEW_YORK, DUBAI, LONDON). Use the Cities API to retrieve all available city codes.

collectionId
string

Filter products by a specific themed collection (e.g., Broadway Shows, Theme Parks). Obtain collection IDs from the Collections API.

categoryId
string

Filter products by a top-level experience type (e.g., Tickets, Tours, Transportation). Obtain category IDs from the Categories API.

subCategoryId
string

Filter products by a specific subcategory within a category (e.g., Museums, Landmarks). Obtain subcategory IDs from the Subcategories API.

languageCode
enum<string>
default:EN

Language code for localizing response content including product names, descriptions, and URLs. Defaults to English (EN). Content falls back to English when a translation is unavailable. See supported language codes.

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

Currency code for displaying prices (e.g., USD, EUR, GBP). All price fields in the response will use this currency. See Currency Codes.

campaignName
string

Partner-specific campaign identifier for tracking conversions and attributing bookings to marketing campaigns.

offset
integer
default:0

Number of products to skip for pagination.

limit
integer
default:20

Maximum number of products to return per page.

primaryCategoryOnly
boolean
default:false

When true and categoryId is provided, restricts results to products whose primary category matches the requested categoryId. By default (false), results include products linked to any subcategory under that category, even if it is only a secondary category. Has no effect when categoryId is not provided.

Response

200 - application/json

Successful response

products
object[]

The products in this page of results.

nextUrl
string | null

Full URL to fetch the next page of results. Null if on the last page.

prevUrl
string | null

Full URL to fetch the previous page of results. Null if on the first page.

total
integer

Total number of products matching the query across all pages.

nextOffset
integer | null

Offset value to use in the next request to retrieve the following page.