# Headout

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

- **Category:** scheduling & booking
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 8
- **Triggers:** 0
- **Slug:** `HEADOUT`
- **Version:** 20260312_00

## Tools

### Get Product By ID

**Slug:** `HEADOUT_GET_PRODUCT_BY_ID`

Tool to retrieve detailed product information by product ID. Use when you need comprehensive product details including pricing, images, location, variants, and availability.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `language` | string | No | Language code for product details (defaults to EN). Supported languages include EN, ES, FR, IT, DE, PT, NL, etc. |
| `product_id` | string | Yes | The unique identifier for the product to retrieve. |
| `currencyCode` | string | No | 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 | No | Controls whether to include variant data in the response. Defaults to true if not specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cityCode` | string | Yes | The city code to fetch categories for (e.g., 'NEW_YORK', 'LONDON'). |
| `languageCode` | string | No | Language code for the response. Defaults to 'EN' if not provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of results to return. Used for pagination purposes. |
| `offset` | string | No | Starting point for retrieving results. Used for pagination purposes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Limit for pagination. Defaults to 10 if not provided. Specifies the maximum number of collections to return. |
| `offset` | integer | No | Offset for pagination. Defaults to 0 if not provided. |
| `cityCode` | string | Yes | The city code to fetch collections for (e.g., 'DUBAI', 'LONDON', 'NEW_YORK'). |
| `languageCode` | string | No | Language code for localized content. Defaults to 'EN' if not provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Inventory by Variant

**Slug:** `HEADOUT_LIST_INVENTORY_BY_VARIANT`

Tool to retrieve available inventory and pricing for a specific product variant. Use when you need to check availability and pricing details for booking.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of records to return per page. |
| `offset` | string | No | Pagination offset for result set navigation. |
| `variantId` | string | Yes | The identifier for the product variant needing inventory lookup. |
| `endDateTime` | string | No | End date-time for inventory query in fm-date-time format; treated as unlimited if not provided. |
| `currencyCode` | string | No | Three-letter currency code for pricing presentation (e.g., USD, AED) per ISO 4217 standard. |
| `startDateTime` | string | No | Start date-time for inventory query in fm-date-time format; defaults to current timestamp if omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of results to return per request. Controls pagination. |
| `offset` | string | No | Offset value for pagination. Use to retrieve next set of results. |
| `language` | string | No | Language code for the response. Supported languages include EN, ES, FR, IT, DE, PT, NL. Defaults to EN. |
| `categoryId` | string | Yes | The ID of the category to filter products by. |
| `currencyCode` | string | No | Currency code following ISO 4217 standard (e.g., USD, EUR, AED). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Products V2

**Slug:** `HEADOUT_LIST_PRODUCTS_V2`

Tool to fetch products using Headout V2 API with filtering by city, collection, category, or subcategory. Use when you need to retrieve product listings for specific locations or categories with pagination support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Pagination limit - maximum number of products to return. Defaults to 20. |
| `offset` | integer | No | Pagination offset - the number of items to skip. Defaults to 0. |
| `cityCode` | string | Yes | The city code for product filtering. Required parameter to fetch products for a specific city. |
| `categoryId` | string | No | Optional category identifier to filter products by category. |
| `campaignName` | string | No | Optional campaign name for filtering products by marketing campaign. |
| `collectionId` | string | No | Optional collection identifier to filter products by collection. |
| `currencyCode` | string | No | Currency code for pricing display. |
| `languageCode` | string | No | Language preference for product content. Defaults to EN if not specified. |
| `subCategoryId` | string | No | Optional subcategory identifier to filter products by subcategory. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cityCode` | string | Yes | The city code to fetch subcategories for (e.g., 'NEW_YORK', 'LONDON', 'PARIS'). |
| `languageCode` | string | No | Language code for the response. Defaults to 'EN' if not provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |