List all collections

curl --location 'https://www.headout.com/api/public/v2/collections/?cityCode=<CITY_CODE>&languageCode=<LANGUAGE_CODE>&limit=<LIMIT>&offset=<OFFSET>' \
--header 'Headout-Auth: <YOUR_API_KEY>'

{
  "collections": [
    {
      "id": "4012",
      "name": "Edge NYC",
      "content": {
        "description": null,
        "subtext": "Discover the city that never sleeps from a whole new perspective with our NYC Edge collection. From the 100th floor of 30 Hudson Yards, you'll be treated to stunning panoramic views of Manhattan and beyond. Step onto the glass floor and feel the exhilarating sensation of floating above the city streets, and go for the City Climb experience for a heart-pounding experience."
      },
      "cityCode": "NEW_YORK",
      "localeSpecificUrls": {
        "EN": "/edge-observation-deck-tickets-c-4012/",
        "ES": "/es/edge-nyc-c-4012/",
        "FR": "/fr/edge-nyc-c-4012/",
        "IT": "/it/edge-nyc-c-4012/",
        "DE": "/de/rand-nyc-c-4012/",
        "PT": "/pt/borda-nyc-c-4012/",
        "NL": "/nl/rand-nyc-c-4012/",
        "PL": "/pl/edge-observation-deck-tickets-c-4012/",
        "KO": "/ko/edge-observation-deck-tickets-c-4012/",
        "JA": "/ja/edge-observation-deck-tickets-c-4012/",
        "ZH_HANS": "/zh-hans/edge-observation-deck-tickets-c-4012/",
        "DA": "/da/edge-nyc-c-4012/",
        "NO": "/no/edge-nyc-c-4012/",
        "RO": "/ro/edge-nyc-c-4012/",
        "RU": "/ru/edge-observation-deck-tickets-c-4012/",
        "SV": "/sv/edge-nyc-c-4012/",
        "TR": "/tr/edge-observation-deck-tickets-c-4012/"
      },
      "canonicalUrl": "https://www.headout.com/edge-observation-deck-tickets-c-4012/",
      "heroImage": {
        "url": "https://cdn-imgix.headout.com/media/images/3fb40eb93c5f4c49d81e2e1994a9ce40-3fb40eb93c5f4c49d81e2e1994a9ce40-Edge%20Nyc.jpg",
        "type": "IMAGE"
      },
      "cardImage": {
        "url": "https://cdn-imgix.headout.com/media/images/3a08d0636f67ba3bce595cd4b0d82d9b-4012-new-york-the-edge-02.jpg",
        "type": "IMAGE"
      }
    }
  ],
  "nextUrl": "/api/public/v2/collections?cityCode=NEW_YORK&languageCode=en&offset=1&limit=1",
  "prevUrl": null,
  "total": 58,
  "nextOffset": 1
}

GET

api

public

collections

curl --location 'https://www.headout.com/api/public/v2/collections/?cityCode=<CITY_CODE>&languageCode=<LANGUAGE_CODE>&limit=<LIMIT>&offset=<OFFSET>' \
--header 'Headout-Auth: <YOUR_API_KEY>'

{
  "collections": [
    {
      "id": "4012",
      "name": "Edge NYC",
      "content": {
        "description": null,
        "subtext": "Discover the city that never sleeps from a whole new perspective with our NYC Edge collection. From the 100th floor of 30 Hudson Yards, you'll be treated to stunning panoramic views of Manhattan and beyond. Step onto the glass floor and feel the exhilarating sensation of floating above the city streets, and go for the City Climb experience for a heart-pounding experience."
      },
      "cityCode": "NEW_YORK",
      "localeSpecificUrls": {
        "EN": "/edge-observation-deck-tickets-c-4012/",
        "ES": "/es/edge-nyc-c-4012/",
        "FR": "/fr/edge-nyc-c-4012/",
        "IT": "/it/edge-nyc-c-4012/",
        "DE": "/de/rand-nyc-c-4012/",
        "PT": "/pt/borda-nyc-c-4012/",
        "NL": "/nl/rand-nyc-c-4012/",
        "PL": "/pl/edge-observation-deck-tickets-c-4012/",
        "KO": "/ko/edge-observation-deck-tickets-c-4012/",
        "JA": "/ja/edge-observation-deck-tickets-c-4012/",
        "ZH_HANS": "/zh-hans/edge-observation-deck-tickets-c-4012/",
        "DA": "/da/edge-nyc-c-4012/",
        "NO": "/no/edge-nyc-c-4012/",
        "RO": "/ro/edge-nyc-c-4012/",
        "RU": "/ru/edge-observation-deck-tickets-c-4012/",
        "SV": "/sv/edge-nyc-c-4012/",
        "TR": "/tr/edge-observation-deck-tickets-c-4012/"
      },
      "canonicalUrl": "https://www.headout.com/edge-observation-deck-tickets-c-4012/",
      "heroImage": {
        "url": "https://cdn-imgix.headout.com/media/images/3fb40eb93c5f4c49d81e2e1994a9ce40-3fb40eb93c5f4c49d81e2e1994a9ce40-Edge%20Nyc.jpg",
        "type": "IMAGE"
      },
      "cardImage": {
        "url": "https://cdn-imgix.headout.com/media/images/3a08d0636f67ba3bce595cd4b0d82d9b-4012-new-york-the-edge-02.jpg",
        "type": "IMAGE"
      }
    }
  ],
  "nextUrl": "/api/public/v2/collections?cityCode=NEW_YORK&languageCode=en&offset=1&limit=1",
  "prevUrl": null,
  "total": 58,
  "nextOffset": 1
}

Retrieve curated collections of experiences for a specific city (e.g., “Broadway Shows”, “Statue of Liberty Tours”, “Theme Parks”). Collections group related products together and are ideal for showcasing themed experiences or popular attractions to users. Results are ordered by city-specific collection rank. Use the returned IDs as collectionId in the Products endpoint.

curl --location 'https://www.headout.com/api/public/v2/collections/?cityCode=<CITY_CODE>&languageCode=<LANGUAGE_CODE>&limit=<LIMIT>&offset=<OFFSET>' \
--header 'Headout-Auth: <YOUR_API_KEY>'

{
  "collections": [
    {
      "id": "4012",
      "name": "Edge NYC",
      "content": {
        "description": null,
        "subtext": "Discover the city that never sleeps from a whole new perspective with our NYC Edge collection. From the 100th floor of 30 Hudson Yards, you'll be treated to stunning panoramic views of Manhattan and beyond. Step onto the glass floor and feel the exhilarating sensation of floating above the city streets, and go for the City Climb experience for a heart-pounding experience."
      },
      "cityCode": "NEW_YORK",
      "localeSpecificUrls": {
        "EN": "/edge-observation-deck-tickets-c-4012/",
        "ES": "/es/edge-nyc-c-4012/",
        "FR": "/fr/edge-nyc-c-4012/",
        "IT": "/it/edge-nyc-c-4012/",
        "DE": "/de/rand-nyc-c-4012/",
        "PT": "/pt/borda-nyc-c-4012/",
        "NL": "/nl/rand-nyc-c-4012/",
        "PL": "/pl/edge-observation-deck-tickets-c-4012/",
        "KO": "/ko/edge-observation-deck-tickets-c-4012/",
        "JA": "/ja/edge-observation-deck-tickets-c-4012/",
        "ZH_HANS": "/zh-hans/edge-observation-deck-tickets-c-4012/",
        "DA": "/da/edge-nyc-c-4012/",
        "NO": "/no/edge-nyc-c-4012/",
        "RO": "/ro/edge-nyc-c-4012/",
        "RU": "/ru/edge-observation-deck-tickets-c-4012/",
        "SV": "/sv/edge-nyc-c-4012/",
        "TR": "/tr/edge-observation-deck-tickets-c-4012/"
      },
      "canonicalUrl": "https://www.headout.com/edge-observation-deck-tickets-c-4012/",
      "heroImage": {
        "url": "https://cdn-imgix.headout.com/media/images/3fb40eb93c5f4c49d81e2e1994a9ce40-3fb40eb93c5f4c49d81e2e1994a9ce40-Edge%20Nyc.jpg",
        "type": "IMAGE"
      },
      "cardImage": {
        "url": "https://cdn-imgix.headout.com/media/images/3a08d0636f67ba3bce595cd4b0d82d9b-4012-new-york-the-edge-02.jpg",
        "type": "IMAGE"
      }
    }
  ],
  "nextUrl": "/api/public/v2/collections?cityCode=NEW_YORK&languageCode=en&offset=1&limit=1",
  "prevUrl": null,
  "total": 58,
  "nextOffset": 1
}

Authorizations

Headout-Auth

string

header

required

Query Parameters

cityCode

string

required

Uppercase city identifier (e.g., NEW_YORK, DUBAI, LONDON). Available city codes are returned by the Cities endpoint.

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

offset

integer

default:0

Number of records to skip for pagination. Use with limit to paginate through large result sets. Start at 0 for the first page.

limit

integer

default:10

Maximum number of records to return per request. Use with offset to paginate through results. Check nextOffset in response for more pages.

Response

200 - application/json

Successful response

collections

object[]

The collections in this page of results.

Show child attributes

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 collections available in the requested city across all pages.

nextOffset

integer | null

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

List all cities

List all categories

⌘I

Guide

Cities

Collections

Categories

Subcategories

Products

Availabilities

Bookings

Authorizations

Query Parameters

Response