Skip to content
/
Search products

Search products

Request

Search the HG product catalog with multi-field filters. Returns paginated results with product, vendor, and category details. Does not consume credits.

Security
authorization
Bodyapplication/json

Product search parameters

filtersobject

Filters for product search

Example:
{
  "attribute_ids": [
    1,
    5,
    12
  ],
  "attribute_name": "SaaS",
  "category_id": "368B0C2D14F47CC1A7DB3BB7C2B41C7E",
  "category_name": "CRM",
  "has_install": true,
  "product_description": "customer relationship",
  "product_name": "Salesforce",
  "vendor_id": 376,
  "vendor_name": "Microsoft"
}
limitinteger, [ 1 .. 100 ]

Maximum number of products to return

Default:50
offsetinteger, >= 0

Number of products to skip

Default:0
sortArray of objects

List of sort objects

Default:[]
Example:
[
  {
    "field": "product_name",
    "order": "asc"
  }
]
POST
/data-api/v2/products/search
curl -i -X POST \
  https://api.hginsights.com/data-api/v2/products/search \
  -H 'Authorization: Bearer <YOUR_API_KEY_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "filters": {
      "attribute_ids": [
        1,
        5,
        12
      ],
      "attribute_name": "SaaS",
      "category_id": "368B0C2D14F47CC1A7DB3BB7C2B41C7E",
      "category_name": "CRM",
      "has_install": true,
      "product_description": "customer relationship",
      "product_name": "Salesforce",
      "vendor_id": 376,
      "vendor_name": "Microsoft"
    },
    "limit": 50,
    "offset": 0,
    "sort": []
  }'

Responses

Product search results

Bodyapplication/json
countinteger

Total number of matching products

Example:1
productsArray of objects

Matching products

Example:
[
  {
    "category_id": "368B0C2D14F47CC1A7DB3BB7C2B41C7E",
    "category_name": "Customer Relationship Management Applications",
    "product_description": "Salesforce CRM is a customer relationship platform...",
    "product_id": 22,
    "product_name": "Salesforce CRM",
    "vendor_id": 376,
    "vendor_name": "Salesforce.com, Inc."
  }
]
Response
{
  "count": 1,
  "products": [
    { … }
  ]
}