Skip to main content
POST

Authorizations

X-Api-Key
string
header
required

Body

application/json
filter
object
required

Search filter parameters with field names as keys and single string values.

Available fields:

Personal Information:

  • uuid - Unique identifier
  • first_name - First name
  • last_name - Last name
  • email - Email address
  • email_domain - Email domain
  • sha256_email - SHA256 hash of email
  • phone - Phone number

Location Information:

  • personal_zip - Personal ZIP/postal code
  • personal_address - Personal street address
  • personal_state - Personal state/province
  • personal_city - Personal city

Company Information:

  • company_name - Company name
  • company_domain - Company domain name

Social/Professional:

  • linkedin_url - LinkedIn profile URL
Example:
is_or_match
boolean
required

Determines how multiple criteria are combined:

  • true: OR logic - returns contacts matching ANY of the criteria
  • false: AND logic - returns contacts matching ALL of the criteria
Example:

false

request_id
string

Optional request ID for tracking

Example:

"req_123456"

fields
enum<string>[]

Optional array of field names to include in the response. If not specified, all available fields are returned.

Available output fields:

  • company - Company name
  • job_title - Job title/position
  • first_name - First name
  • last_name - Last name
  • b2b_email - Business email address
  • personal_email - Personal email address
  • b2b_phone - Business phone number
  • personal_phone - Personal phone number
  • sha256 - SHA256 hash identifier
  • linkedin_url - LinkedIn profile URL
  • address - Street address
  • city - City
  • state - State/province
  • zip - ZIP/postal code
  • industry - Industry classification
  • company_domain - Company domain
Available options:
company,
job_title,
first_name,
last_name,
b2b_email,
personal_email,
b2b_phone,
personal_phone,
sha256,
linkedin_url,
address,
city,
state,
zip,
industry,
company_domain
Example:

Response

Successfully retrieved enriched contact data

request_id
string

Request ID if provided in the request

Example:

"req_123456"

timestamp
integer<int64>

Unix timestamp in milliseconds

Example:

1704067200000

found
integer

Number of matching records found

Example:

2

result
object[]

Array of enriched contact records with complete profile information

Example: