Skip to main content
Headout logo
  • Category: scheduling & booking
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 8
  • Triggers: 0
  • Slug: HEADOUT
  • Version: 20261101_00

Tools

Slug: HEADOUT_GET_PRODUCT_BY_IDRetrieve product information by product ID, including supported pricing, images, location and variant details. Variant data can be requested or omitted.

Input Parameters

string
Language code for product details (defaults to EN). Supported languages include EN, ES, FR, IT, DE, PT, NL, etc.
string
required
The unique identifier for the product to retrieve.
string
Currency code for pricing in ISO 4217 format (e.g., USD, EUR, GBP, AED). If not specified, default currency will be used.
boolean
Controls whether to include variant data in the response. Defaults to true if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEADOUT_LIST_CATEGORIES_V2Tool 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

string
required
The city code to fetch categories for (e.g., ‘NEW_YORK’, ‘LONDON’).
string
Language code for the response. Defaults to ‘EN’ if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEADOUT_LIST_CITIESTool 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

integer
Maximum number of results to return. Used for pagination purposes.
string
Starting point for retrieving results. Used for pagination purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEADOUT_LIST_COLLECTIONS_V2Tool 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

integer
Limit for pagination. Defaults to 10 if not provided. Specifies the maximum number of collections to return.
integer
Offset for pagination. Defaults to 0 if not provided.
string
required
The city code to fetch collections for (e.g., ‘DUBAI’, ‘LONDON’, ‘NEW_YORK’).
string
Language code for localized content. Defaults to ‘EN’ if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEADOUT_LIST_INVENTORY_BY_VARIANTRetrieve 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEADOUT_LIST_PRODUCTS_BY_CATEGORYTool to list product listings filtered by category ID with pagination support. Use when you need to retrieve products for a specific category.

Input Parameters

integer
Number of results to return per request. Controls pagination.
string
Offset value for pagination. Use to retrieve next set of results.
string
Language code for the response. Supported languages include EN, ES, FR, IT, DE, PT, NL. Defaults to EN.
string
required
The ID of the category to filter products by.
string
Currency code following ISO 4217 standard (e.g., USD, EUR, AED).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEADOUT_LIST_PRODUCTS_V2List 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

integer
Pagination limit - maximum number of products to return. Defaults to 20.
integer
Pagination offset - the number of items to skip. Defaults to 0.
string
required
The city code for product filtering. Required parameter to fetch products for a specific city.
string
Optional category identifier to filter products by category.
string
Optional campaign name for filtering products by marketing campaign.
string
Optional collection identifier to filter products by collection.
string
Currency code for pricing display.
string
Language preference for product content. Defaults to EN if not specified.
string
Optional subcategory identifier to filter products by subcategory.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HEADOUT_LIST_SUBCATEGORIES_V2Tool 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

string
required
The city code to fetch subcategories for (e.g., ‘NEW_YORK’, ‘LONDON’, ‘PARIS’).
string
Language code for the response. Defaults to ‘EN’ if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not