Skip to content
/
Search Contacts

Search Contacts

Request

Search and filter contacts. Returns a flat list of matching contacts.

Security
authorization
Bodyapplication/jsonrequired

Search Request

filtersobjectrequired

Filters object for contact search. All filters are inclusion-only.

Example:
{
  "companies": {
    "ids": [ … ]
  },
  "contact_location": {
    "countries": [ … ]
  },
  "job_functions": [
    "Engineering"
  ],
  "job_seniority": [
    "Director"
  ],
  "time_in_current_role": [
    "company_veteran"
  ]
}
limitinteger, [ 1 .. 20 ]

Maximum number of contacts to return

Default:10
Example:10
offsetinteger, [ 0 .. 99 ]

Number of contacts to skip (max 99)

Default:0
Example:0
curl -i -X POST \
  https://api.hginsights.com/data-api/v2/contacts/search \
  -H 'Authorization: Bearer <YOUR_API_KEY_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "filters": {
      "companies": {
        "ids": [
          "1698C53EBC888758570396E0334965C1"
        ]
      },
      "contact_location": {
        "countries": [
          "US"
        ]
      },
      "job_functions": [
        "Engineering"
      ],
      "job_seniority": [
        "Director"
      ],
      "time_in_current_role": [
        "company_veteran"
      ]
    },
    "limit": 10,
    "offset": 0
  }'

Responses

Search Response

Bodyapplication/json
contactsArray of objectsrequired
Example:
[
  {
    "company_domain": "acme.com",
    "company_id": "1488903ED478F8C51D09F2EC5F2DCDA2",
    "company_name": "Acme",
    "contact_location_city": "Vancouver",
    "contact_location_country": "Canada",
    "contact_location_region": "British Columbia",
    "first_name": "John",
    "full_name": "John Doe",
    "id": "7a932d2ae5dab0ca88348198c9129c9167ff34f92c4abd47f291f5d1c35d237a",
    "job_functions": [ … ],
    "job_seniority": "Founder",
    "job_title": "Co-Founder",
    "last_name": "Doe",
    "linkedin_url": "https://www.linkedin.com/in/john-dow"
  }
]
countinteger

Total number of contacts matching the filters (before pagination)

Example:1
Response
{
  "contacts": [
    { … }
  ],
  "count": 1
}