Travel

Headout

Learn how to use Headout with Composio

Overview

SLUG: HEADOUT

Description

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

Authentication Details

generic_api_key
stringRequired

Connecting to Headout

Create an auth config

Use the dashboard to create an auth config for the Headout toolkit. This allows you to connect multiple Headout accounts to Composio for agents to use.

1

Select App

Navigate to Headout.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Headout Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4headout_auth_config_id = "ac_YOUR_HEADOUT_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10    # Replace this with a method to retrieve an API key from the user.
11    # Or supply your own.
12    user_api_key = input("[!] Enter API key")
13
14    connection_request = composio.connected_accounts.initiate(
15        user_id=user_id,
16        auth_config_id=auth_config_id,
17        config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Headout for user {user_id}")
22    print(f"Connection status: {connection_request.status}")
23    
24    return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, headout_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Headout toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Get Product By ID

Description

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

Action Parameters

currencyCode
string
fetch-variants
boolean
language
string
product_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Categories By City

Description

Tool to list all categories/collections filtered by city code. Use when you need to browse available activity categories within a specific geographic location. Supports pagination via offset and limit parameters.

Action Parameters

cityCode
stringRequired
limit
integer
offset
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Categories V2

Description

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.

Action Parameters

cityCode
stringRequired
languageCode
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Cities

Description

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.

Action Parameters

limit
integer
offset
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Collections V2

Description

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.

Action Parameters

cityCode
stringRequired
languageCode
string
limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Inventory by Variant

Description

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

Action Parameters

currencyCode
string
endDateTime
string
limit
integer
offset
string
startDateTime
string
variantId
stringRequired

Action Response

data
array
error
string
nextOffset
integer
nextUrl
string
prevUrl
string
successful
booleanRequired
total
integer

Tool Name: List Products By Category

Description

Tool to list product listings filtered by category ID with pagination support. Use when you need to retrieve products for a specific category.

Action Parameters

categoryId
stringRequired
currencyCode
string
language
string
limit
integer
offset
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Products By City

Description

Tool to list product listings filtered by city code with pagination support. Use when you need to browse or search for available experiences and activities in a specific city. Supports optional currency and language preferences, as well as pagination via limit and offset parameters.

Action Parameters

cityCode
stringRequired
currencyCode
string
language
string
limit
integer
offset
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Products V2

Description

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.

Action Parameters

campaignName
string
categoryId
string
cityCode
stringRequired
collectionId
string
currencyCode
string
languageCode
string
limit
integer
offset
integer
subCategoryId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Subcategories V2

Description

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.

Action Parameters

cityCode
stringRequired
languageCode
string

Action Response

data
objectRequired
error
string
successful
booleanRequired