> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Headout

> Headout is a travel experiences and activities booking platform offering tours, attractions, and entertainment bookings worldwide.

![Headout logo](https://mintcdn.com/composio-preview/o1IUBrrsmtgkhmyf/images/toolkits/headout.svg?fit=max\&auto=format\&n=o1IUBrrsmtgkhmyf\&q=85\&s=dfced4e38ca58d2d6f4e4c31673b3789)

* **Category:** scheduling & booking
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 8
* **Triggers:** 0
* **Slug:** `HEADOUT`
* **Version:** 20261101\_00

## Tools

> [accordion] Get Product By ID
>
> **Slug:** `HEADOUT_GET_PRODUCT_BY_ID`
>
> Retrieve product information by product ID, including supported pricing, images, location and variant details. Variant data can be requested or omitted.
>
> #### Input Parameters
>
> **language** `string`
>
> Language code for product details (defaults to EN). Supported languages include EN, ES, FR, IT, DE, PT, NL, etc.
>
> **product\_id** `string` *required*
>
> The unique identifier for the product to retrieve.
>
> **currencyCode** `string`
>
> Currency code for pricing in ISO 4217 format (e.g., USD, EUR, GBP, AED). If not specified, default currency will be used.
>
> **fetch-variants** `boolean`
>
> Controls whether to include variant data in the response. Defaults to true if not specified.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Categories V2
>
> **Slug:** `HEADOUT_LIST_CATEGORIES_V2`
>
> Tool to fetch all available activity categories for a specific city using V2 API. Use when you need to list categories of activities available in a particular city location.
>
> #### Input Parameters
>
> **cityCode** `string` *required*
>
> The city code to fetch categories for (e.g., 'NEW\_YORK', 'LONDON').
>
> **languageCode** `string`
>
> Language code for the response. Defaults to 'EN' if not provided.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Cities
>
> **Slug:** `HEADOUT_LIST_CITIES`
>
> Tool to list all active cities with pagination support. Use when you need to retrieve available cities from the Headout platform. Supports pagination through offset and limit parameters.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of results to return. Used for pagination purposes.
>
> **offset** `string`
>
> Starting point for retrieving results. Used for pagination purposes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Collections V2
>
> **Slug:** `HEADOUT_LIST_COLLECTIONS_V2`
>
> Tool to fetch all collections for a specific city using V2 API with pagination support. Use when you need to browse collections available in a particular city, with optional language-specific content and pagination controls.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Limit for pagination. Defaults to 10 if not provided. Specifies the maximum number of collections to return.
>
> **offset** `integer`
>
> Offset for pagination. Defaults to 0 if not provided.
>
> **cityCode** `string` *required*
>
> The city code to fetch collections for (e.g., 'DUBAI', 'LONDON', 'NEW\_YORK').
>
> **languageCode** `string`
>
> Language code for localized content. Defaults to 'EN' if not provided.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Inventory by Variant
>
> **Slug:** `HEADOUT_LIST_INVENTORY_BY_VARIANT`
>
> Retrieve a page of available inventory and pricing for a specific product variant to check booking availability. Optionally specify a date-time range and pricing currency, and use offset and limit to navigate results; the response can include availability, remaining quantities, and person or group pricing.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of records to return per page.
>
> **offset** `string`
>
> Pagination offset for result set navigation.
>
> **variantId** `string` *required*
>
> The identifier for the product variant needing inventory lookup.
>
> **endDateTime** `string`
>
> End date-time for inventory query in fm-date-time format; treated as unlimited if not provided.
>
> **currencyCode** `string`
>
> Three-letter currency code for pricing presentation (e.g., USD, AED) per ISO 4217 standard.
>
> **startDateTime** `string`
>
> Start date-time for inventory query in fm-date-time format; defaults to current timestamp if omitted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Products By Category
>
> **Slug:** `HEADOUT_LIST_PRODUCTS_BY_CATEGORY`
>
> Tool to list product listings filtered by category ID with pagination support. Use when you need to retrieve products for a specific category.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of results to return per request. Controls pagination.
>
> **offset** `string`
>
> Offset value for pagination. Use to retrieve next set of results.
>
> **language** `string`
>
> Language code for the response. Supported languages include EN, ES, FR, IT, DE, PT, NL. Defaults to EN.
>
> **categoryId** `string` *required*
>
> The ID of the category to filter products by.
>
> **currencyCode** `string`
>
> Currency code following ISO 4217 standard (e.g., USD, EUR, AED).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Products V2
>
> **Slug:** `HEADOUT_LIST_PRODUCTS_V2`
>
> List Headout V2 products for a required city, with optional collection, category, subcategory and campaign filters. Supports pagination and optional language and currency selection.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Pagination limit - maximum number of products to return. Defaults to 20.
>
> **offset** `integer`
>
> Pagination offset - the number of items to skip. Defaults to 0.
>
> **cityCode** `string` *required*
>
> The city code for product filtering. Required parameter to fetch products for a specific city.
>
> **categoryId** `string`
>
> Optional category identifier to filter products by category.
>
> **campaignName** `string`
>
> Optional campaign name for filtering products by marketing campaign.
>
> **collectionId** `string`
>
> Optional collection identifier to filter products by collection.
>
> **currencyCode** `string`
>
> Currency code for pricing display.
>
> **languageCode** `string`
>
> Language preference for product content. Defaults to EN if not specified.
>
> **subCategoryId** `string`
>
> Optional subcategory identifier to filter products by subcategory.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Subcategories V2
>
> **Slug:** `HEADOUT_LIST_SUBCATEGORIES_V2`
>
> Tool to fetch all subcategories for a specific city using V2 API. Use when you need to list subcategories of activities available in a particular city location.
>
> #### Input Parameters
>
> **cityCode** `string` *required*
>
> The city code to fetch subcategories for (e.g., 'NEW\_YORK', 'LONDON', 'PARIS').
>
> **languageCode** `string`
>
> Language code for the response. Defaults to 'EN' if not provided.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
