GET
List products
Returns a paginated catalog of all products. Each item includes the SKU, SRN, type, and a HATEOAS self-link to the full record at its type-specific endpoint (e.g. /products/v2.0/indoor-units/{sku}). Note: branch controllers, branch boxes, ventilation, and accessories all have category INDOOR or OUTDOOR — use the subcategory or the self-link path to determine the specific product type.
query Parameters
categoryFilter by product type using the route slug (e.g. indoor-units, outdoor-units, branch-controllers, branch-boxes, ventilation, accessories)
countNumber of results per page (default: 100, min: 1, max: 1000)
pagePage number (default: 1, min: 1)
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List products › Responses
Successful product catalog
successPagination information
List indoor units
Returns a paginated list of indoor product units with optional filters. Includes full specification, performance, and compatibility data.
query Parameters
series.nameFilter by series name
family.nameFilter by family name
brandFilter by brand name
countNumber of results per page (default: 100, min: 1, max: 1000)
pagePage number (default: 1, min: 1)
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List indoor units › Responses
Successful unit list
successPagination information
Get indoor unit by SKU
Returns a single indoor unit by its SKU. Returns 404 if the SKU does not exist or belongs to a different product type.
path Parameters
skuThe product SKU (brand model number) to retrieve
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get indoor unit by SKU › Responses
Successful unit lookup
successA single an indoor unit product record.
List outdoor units
Returns a paginated list of outdoor product units with optional filters. Includes full specification, performance, and compatibility data.
query Parameters
series.nameFilter by series name
family.nameFilter by family name
brandFilter by brand name
countNumber of results per page (default: 100, min: 1, max: 1000)
pagePage number (default: 1, min: 1)
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List outdoor units › Responses
Successful unit list
successPagination information
Get outdoor unit by SKU
Returns a single outdoor unit by its SKU. Returns 404 if the SKU does not exist or belongs to a different product type.
path Parameters
skuThe product SKU (brand model number) to retrieve
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get outdoor unit by SKU › Responses
Successful unit lookup
successA single an outdoor unit product record.
List branch controllers
Returns a paginated list of branch controller units with optional filters.
query Parameters
series.nameFilter by series name
family.nameFilter by family name
brandFilter by brand name
countNumber of results per page (default: 100, min: 1, max: 1000)
pagePage number (default: 1, min: 1)
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List branch controllers › Responses
Successful unit list
successPagination information
Get branch controller by SKU
Returns a single branch controller unit by its SKU. Returns 404 if the SKU does not exist or belongs to a different product type.
path Parameters
skuThe product SKU (brand model number) to retrieve
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get branch controller by SKU › Responses
Successful unit lookup
successA single a branch controller product record.
List branch boxes
Returns a paginated list of branch box units with optional filters.
query Parameters
series.nameFilter by series name
family.nameFilter by family name
brandFilter by brand name
countNumber of results per page (default: 100, min: 1, max: 1000)
pagePage number (default: 1, min: 1)
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List branch boxes › Responses
Successful unit list
successPagination information
Get branch box by SKU
Returns a single branch box unit by its SKU. Returns 404 if the SKU does not exist or belongs to a different product type.
path Parameters
skuThe product SKU (brand model number) to retrieve
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get branch box by SKU › Responses
Successful unit lookup
successA single a branch box product record.
List ventilation units
Returns a paginated list of ventilation units with optional filters.
query Parameters
series.nameFilter by series name
family.nameFilter by family name
brandFilter by brand name
countNumber of results per page (default: 100, min: 1, max: 1000)
pagePage number (default: 1, min: 1)
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List ventilation units › Responses
Successful unit list
successPagination information
Get ventilation unit by SKU
Returns a single ventilation unit by its SKU. Returns 404 if the SKU does not exist or belongs to a different product type.
path Parameters
skuThe product SKU (brand model number) to retrieve
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get ventilation unit by SKU › Responses
Successful unit lookup
successA single a ventilation unit product record.
List accessories
Returns a paginated list of accessory products with optional filters.
query Parameters
series.nameFilter by series name
family.nameFilter by family name
brandFilter by brand name
countNumber of results per page (default: 100, min: 1, max: 1000)
pagePage number (default: 1, min: 1)
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List accessories › Responses
Successful unit list
successPagination information
Get accessory by SKU
Returns a single accessory product by its SKU. Returns 404 if the SKU does not exist or belongs to a different product type.
path Parameters
skuThe product SKU (brand model number) to retrieve
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get accessory by SKU › Responses
Successful accessory lookup
successA single an accessory product record.
List pairings
Returns a paginated list of product pairings and relationships (Pairing, Standalone, Combinations). Each pairing contains an array of up to 3 products with HATEOAS links to their full unit records. Filter by SKU to find all pairings a given unit participates in.
query Parameters
skuFilter to pairings where this SKU appears as P1, P2, or P3
relTypeFilter by relationship type
countNumber of results per page (default: 100, min: 1, max: 1000)
pagePage number (default: 1, min: 1)
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List pairings › Responses
Successful pairings list
successPairings list with embedded pagination
Get pairing by relationship ID
Returns a single product pairing by its relationship ID. The response includes all products in the pairing with HATEOAS links to their full unit records via GET /products/v2.0/units/{sku}.
path Parameters
relationship_idThe product relationship ID to retrieve
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get pairing by relationship ID › Responses
Successful pairing lookup
successA product pairing or relationship record