Skip to content
/
Search vendors

Search vendors

Request

Search vendor catalog with filtering, relevance scoring, and optional product listing. When a text filter (vendor_name, description) is present and no explicit sort is given, results are ranked by relevance (exact > prefix > substring + popularity bonus).

Security
authorization
Bodyapplication/json

Vendor search request

filtersobject

Filter criteria for vendor search. All filters are optional and AND-combined.

include_productsboolean

When true, attach a products list per vendor.

Default:false
limitinteger, [ 1 .. 100 ]

Maximum number of vendors to return.

Default:50
offsetinteger, [ 0 .. 10000 ]

Pagination offset.

Default:0
products_limitinteger, [ 1 .. 100 ]

Cap on products listed per vendor, ordered by presence_frequency descending.

Default:10
sortArray of objects, <= 3 items

Sort fields (max 3). Default: relevance when text filter present, else vendor_name ascending.

Default:[]
POST
/data-api/v2/products/vendors/search
curl -i -X POST \
  https://api.hginsights.com/data-api/v2/products/vendors/search \
  -H 'Authorization: Bearer <YOUR_API_KEY_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "filters": {
      "description": "string",
      "has_products_with_installs": true,
      "vendor_id": 0,
      "vendor_name": "string"
    },
    "include_products": false,
    "limit": 50,
    "offset": 0,
    "products_limit": 10,
    "sort": []
  }'

Responses

Vendor search results

Bodyapplication/json
countinteger

Record count

Example:1
dataArray of objects
Example:
[
  {
    "product_count": 0,
    "products": [ … ],
    "vendor_company_description": "",
    "vendor_company_id": "",
    "vendor_id": 0,
    "vendor_name": "",
    "vendor_parent_id": 0,
    "vendor_url": ""
  }
]
Response
{
  "count": 1,
  "data": [
    { … }
  ]
}