Skip to content

Search Contracts

Request

Search and filter contracts. Returns a paginated list of contracts matching the filter criteria.

Security
authorization
Bodyapplication/jsonrequired

Search Request

filtersobjectrequired

Filters for contract search.

Example:
{
  "company_ids": [
    "1698C53EBC888758570396E0334965C1"
  ]
}
global_settingsobject

GlobalSettings object

Default:{"hex_encode_ids":true,"install_recency":36,"localize_installs":true}
Example:
{
  "hex_encode_ids": true,
  "install_recency": 12,
  "localize_installs": false
}
limitinteger, [ 1 .. 100 ]

Maximum number of contracts to return

Default:10
Example:10
offsetinteger, >= 0

Number of contracts to skip

Default:0
Example:0
sortsArray of objects

List of sort objects

Default:[]
Example:
[
  {
    "direction": "DESC",
    "field": "end_date"
  }
]
tracking_contextobject

Tracking context for analytics and auditing

curl -i -X POST \
  https://api.hginsights.com/data-api/v2/contracts/search \
  -H 'Authorization: Bearer <YOUR_API_KEY_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "filters": {
      "company_ids": [
        "1698C53EBC888758570396E0334965C1"
      ]
    },
    "limit": 10,
    "offset": 0,
    "sorts": [
      {
        "direction": "DESC",
        "field": "end_date"
      }
    ]
  }'

Responses

Search Response

Bodyapplication/json
countintegerrequired

Total number of contracts matching the filters (before pagination)

Example:1
recordsArray of objectsrequired

List of contract records matching the search criteria

Example:
[
  {
    "announcement_date": "2025-04-23",
    "bid_process": "Competitive",
    "contract_event": "New",
    "contract_structure": "Single Vendor",
    "customer_drivers": "Business Continuity (Run the Business)",
    "customer_name": "LATVENERGO AS",
    "deal_value": 2554421,
    "end_date": "2030-04-17",
    "id": "2F730FBEB8C74FBB753736C5CF74F5B8",
    "larger_contract": false,
    "performance_criteria": "Consistent Quality",
    "pricing_structure": "Incentive Contracts",
    "primary_vendor": { … },
    "service_lines": [ … ],
    "signing_country": "Latvia",
    "start_date": "2025-04-17",
    "summary": "Inavitas Enerji has been selected by Latvenergo of Latvia for provision of renewable electric energy resource management system implementation and five-year support. The contract was awarded on April 17, 2025 which is worth EUR2.2m ($2.5m).",
    "term": 60,
    "title": "Inavitas Enerji secured an IT service contract from Latvenergo of Latvia"
  }
]
Response
{
  "count": 1,
  "records": [
    { … }
  ]
}