Skip to main content
POST

Authorizations

x-api-key
string
header
required

Your Huntr API key. Get one at tryhuntr.com. Pass as x-api-key header on all authenticated requests.

Body

application/json

Choose one people search input:

  • Natural-language mode: send semantic_query. Add filters only with semantic_query when you need hard constraints.
  • Structured-filter mode: send query when you already have exact filters, or when paginating with a resolved_query.

Optional: add has_email and/or has_phone to return only contacts with available email or phone data.

Do not send query and semantic_query together.

semantic_query
string

Natural-language description of the people to find. Mutually exclusive with query. The response includes resolved_query for deterministic pagination.

Maximum string length: 8000
filters
object

Hard filters for semantic_query. Same supported fields as query.

query
object

At least one supported filter required unless has_email or has_phone is true. Use non-empty include and/or exclude arrays.

pagination
object

Configurable page size. pagination.size min 1, default 100, max 200. Send pagination.size on the first request and with pagination.token on later pages. Keep the same query and has_email/has_phone flags between pages.

has_email
boolean

When true, only return contacts with email data available.

has_phone
boolean

When true, only return contacts with phone data available.

Response

Person search results.

success
boolean
required
request_id
string
required
result
object
required
pagination
object
required
total
number
required

Total matching records for the submitted query. This can be larger than the number returned in this page.

price
number
required

Plan-specific amount multiplied by people returned.

credits_remaining
number
required