Skip to main content
GET
/
api
/
public
/
v2
/
collections
cURL
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": "<string>",
      "name": "<string>",
      "cityCode": "<string>",
      "content": {
        "description": "<string>",
        "subtext": "<string>"
      },
      "localeSpecificUrls": {},
      "canonicalUrl": "<string>",
      "heroImage": {
        "url": "<string>",
        "type": "<string>"
      },
      "cardImage": {
        "url": "<string>",
        "type": "<string>"
      }
    }
  ],
  "nextUrl": "<string>",
  "prevUrl": "<string>",
  "total": 123,
  "nextOffset": 123
}

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.

​
languageCode
enum<string>
default:EN

Language code for localizing response content including product names, descriptions, and URLs. Defaults to English (EN). See supported language codes.

Available options:
EN,
ES,
FR,
IT,
DE,
PT,
NL,
PL
​
offset
string

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

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.

​
nextUrl
string

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

​
prevUrl
string

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

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