Skip to main content

Get Vendor Information

Resolve a vendor/company name into its HG Insights vendor_id (and metadata) so you can filter other tools by that vendor. Free — no credits consumed. Match by vendorName substring (case-insensitive, relevance-ranked) and/or description substring, or look up an exact vendorId. Returns ranked vendor rows: vendor_id (UInt64), vendor_name, vendor_url, vendor_parent_id (null if top-level), vendor_company_description, and product_count. Set includeProducts: true to attach up to productsLimit products per vendor. Matching is substring, not fuzzy: a single query can return several rows — a parent and its subsidiaries (e.g. 'Oracle' → 'Oracle Corporation' and 'Oracle NetSuite') — so confirm vendor_name/vendor_url before reusing an id. Use this when you must resolve a vendor by name before filtering technographic/spend data — e.g. pass the returned vendor_id into company_technographic's vendorIds filter, or into company_spend. Do NOT use this when you already hold a vendor_id — pass it straight to the downstream tool. Do NOT use this for the product category taxonomy (use get_product_category), for product attributes (use get_product_attribute), or for a product's reviews/pricing/details (use get_product_information). Do NOT call it with no filter — always supply vendorName, description, or vendorId.

Credits

Free — No credits consumed. See the full credit table for how AI Credits work.

Parameters

NameTypeDefaultDescription
vendorNamestring-Case-insensitive substring match on vendor_name (LIKE), which activates relevance ranking. Pass the plain company name, e.g. 'Salesforce', 'Oracle'. A single name can return multiple rows (a parent plus its subsidiaries — e.g. 'Oracle' → 'Oracle Corporation' and 'Oracle NetSuite'); inspect vendor_name/vendor_url and pick the intended row before reusing its vendor_id.
descriptionstring-Case-insensitive substring match on vendor_company_description (the vendor's company blurb) — useful to find vendors by what they do, e.g. 'endpoint security'. ANDed with vendorName when both are provided: the stored description must contain the exact substring AND the name must match. If results are empty when combining both, retry with only vendorName; the stored description text may not contain your exact phrase.
vendorIdinteger-Exact vendor_id (UInt64) match — returns ≤ 1 row. Use when you already hold the ID (e.g. from an earlier search) and want to resolve the vendor's full metadata; do not use vendor_id to re-search by name.
hasProductsWithInstallsboolean-true = only vendors with ≥1 product carrying an install signal; false = catalog-only vendors. Omit to return all. Note: product ownership joins may occasionally surface unrelated vendors — verify vendor_name and vendor_url before using the returned vendor_id.
includeProductsbooleanfalseWhen true, each vendor row carries a products[] of {product_id, product_name} ordered by presence frequency, capped at productsLimit.
productsLimitinteger10Cap on the products[] list per vendor when includeProducts is true (1–100).
sortBystringrelevanceSort order for the returned rows: 'relevance' (best name match first — only meaningful alongside vendorName), 'vendor_name' (A→Z), or 'product_count' (most products first).
limitinteger10Maximum number of vendor rows to return (1–50).
offsetinteger0Pagination offset.

Required Integrations

This tool is only available when your organization has the following integration configured in the Phoenix Integrations settings:

  • HG Insights (v2) (hginsights_v2)

Use Cases

  • Resolve a vendor's vendor_id by name before filtering company_technographic or company_spend
  • Disambiguate a company that resolves to multiple rows (parent vs. subsidiary, e.g. Oracle Corporation vs. Oracle NetSuite)
  • Find vendors by what they do via a description substring (e.g. 'endpoint security')
  • Resolve full vendor metadata from a known vendorId
  • List a vendor's products with includeProducts: true

Example Usage

Resolve Salesforce's vendor_id

{
"tool": "get_vendor_information",
"arguments": {
"vendorName": "Salesforce"
}
}

Vendor plus its top 5 products

{
"tool": "get_vendor_information",
"arguments": {
"vendorName": "Oracle",
"includeProducts": true,
"productsLimit": 5
}
}

Exact lookup by known id

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

Response Format

FieldTypeDescription
vendorsarrayMatching vendor rows, ordered by sortBy.
vendors[].vendor_idintegerUse this ID in downstream tool calls.
vendors[].vendor_namestring
vendors[].vendor_urlstring | null
vendors[].vendor_parent_idinteger | nullNull if this vendor has no parent.
vendors[].vendor_company_idstring | nullPaired HG company id, when known.
vendors[].vendor_company_descriptionstring | null
vendors[].product_countinteger
vendors[].productsarray | nullNull when includeProducts is false/omitted.
totalintegerTotal matching vendors before pagination.
has_moreboolean
credits_consumedinteger

company_technographic, company_spend, get_product_category, get_product_information, get_product_attribute