Skip to main content

Get Vendor Information

get_vendor_information resolves a single vendor in the HG Insights taxonomy by its vendor_id. It proxies POST /v2/products/vendors/search with filters.vendor_id and limit: 1, returning the single matching row (or null when the id is unknown).

For browsing or multi-row search, use company_technographic / catalog search to obtain candidate vendor_ids first.

Parameters

NameTypeRequiredDefaultDescription
vendorIdint (≥ 0)YesExact vendor_id (UInt64).
includeProductsbooleanNofalseWhen true, the row carries a products[] of {product_id, product_name} (capped at productsLimit).
productsLimitint (1–100)No10Cap on the products[] array when includeProducts is true.

Required Integrations

  • hginsights_v2

Credit Cost

Free — no credits consumed.

Example Usage

Single-vendor lookup

{
"tool": "get_vendor_information",
"parameters": { "vendorId": 376 }
}

With product list

{
"tool": "get_vendor_information",
"parameters": { "vendorId": 376, "includeProducts": true, "productsLimit": 5 }
}

Response Format

{
"vendor": {
"vendor_id": 376,
"vendor_name": "Salesforce.com, Inc.",
"vendor_url": "salesforce.com",
"vendor_parent_id": null,
"vendor_company_id": "44A720BBBF1FC3ACAB85A3B9B7D8C7A3",
"vendor_company_description": "Salesforce is a cloud-based software …",
"product_count": 42,
"products": null
},
"credits_consumed": 0
}
  • vendor is null when the vendor_id is unknown.
  • products is null when includeProducts is false/omitted.

Composable Workflow

  1. Obtain a vendor_id (e.g. from company_technographic results).
  2. Call get_vendor_information with that id to fetch metadata.
  3. Use vendor_id/product_id as vendorIds/productIds filters in company_technographic.

Error Handling

CauseSurface
Missing vendorIdTool-side Zod validation error
HG Insights V2 auth failureUpstreamApiError 401/403 with a helpful auth message
Upstream 503 / timeoutStructured upstream error
  • list_product_categories — browse the category taxonomy
  • list_product_attributes — browse the attribute taxonomy
  • get_product_category / get_product_attribute — single-item lookups
  • company_technographic — filter by vendorIds/productIds