Skip to main content

Get Product Category

get_product_category resolves a single category in the HG Insights product taxonomy by categoryId (Int128 hex) or categoryCode. It proxies POST /v2/products/categories/search with the matching filter and limit: 1, returning the single matching row (or null when the id/code is unknown).

For browsing/search, use list_product_categories.

Parameters

NameTypeRequiredDefaultDescription
categoryIdstring (uppercase 32-char hex)One ofExact match on category_id (Int128 hex).
categoryCodestring (1–32 chars)One ofExact match on category_code, e.g. "SW049".

At least one of categoryId or categoryCode is required.

Required Integrations

  • hginsights_v2

Credit Cost

Free — no credits consumed.

Example Usage

By category id

{
"tool": "get_product_category",
"parameters": { "categoryId": "0123456789ABCDEF0123456789ABCDEF" }
}

By category code

{
"tool": "get_product_category",
"parameters": { "categoryCode": "SW049" }
}

Response Format

{
"category": {
"category_id": "0123456789ABCDEF0123456789ABCDEF",
"category_code": "SW049",
"category_name": "CRM",
"category_parent_id": null,
"category_id_tree": ["0123456789ABCDEF0123456789ABCDEF"],
"category_name_tree": ["Sales and Marketing", "CRM"],
"has_category_installs": true,
"product_count": 42
},
"credits_consumed": 0
}
  • category is null when the id/code is unknown.

Error Handling

CauseSurface
Neither categoryId nor categoryCode providedTool-side Zod validation error
categoryId not 32-char uppercase hexTool-side Zod validation error
HG Insights V2 auth failureUpstreamApiError 401/403 with a helpful auth message
  • list_product_categories — browse / search the category taxonomy
  • get_product_attribute — single-attribute lookup
  • company_technographic — filter by category id