Skip to main content
POST
/
enrich
curl --request POST \
  --url https://api.audiencelab.io/enrich \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "request_id": "req_123456",
  "filter": {
    "company_name": "Nike"
  },
  "is_or_match": false
}
'
{
  "request_id": "req_123456",
  "timestamp": 1704067200000,
  "found": 2,
  "result": [
    {
      "email": "john.doe@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "business_email": "jdoe@acmecorp.com",
      "sha256_email": "a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3",
      "company_name": "Acme Corp",
      "company_domain": "acmecorp.com",
      "job_title": "Senior Software Engineer",
      "industry": "Technology",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94105",
      "address": "123 Market St",
      "linkedin_url": "https://linkedin.com/in/johndoe"
    },
    {
      "email": "jane.smith@example.com",
      "first_name": "Jane",
      "last_name": "Smith",
      "business_email": "jsmith@acmecorp.com",
      "sha256_email": "b665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae4",
      "company_name": "Acme Corp",
      "company_domain": "acmecorp.com",
      "job_title": "Product Manager",
      "industry": "Technology",
      "city": "New York",
      "state": "NY",
      "zip": "10001",
      "address": "456 Broadway",
      "linkedin_url": "https://linkedin.com/in/janesmith"
    }
  ]
}

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:
{
"first_name": "John",
"last_name": "Doe",
"email": "user@example.com",
"phone": "555-123-4567",
"company_name": "Nike",
"personal_city": "San Francisco",
"company_domain": "nike.com"
}
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:
[
"first_name",
"last_name",
"b2b_email",
"company",
"job_title"
]
is_or_match
boolean
default:false

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

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:
[
{
"email": "john.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"business_email": "jdoe@acmecorp.com",
"sha256_email": "a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3",
"company_name": "Acme Corp",
"company_domain": "acmecorp.com",
"job_title": "Senior Software Engineer",
"industry": "Technology",
"city": "San Francisco",
"state": "CA",
"zip": "94105",
"address": "123 Market St",
"linkedin_url": "https://linkedin.com/in/johndoe"
},
{
"email": "jane.smith@example.com",
"first_name": "Jane",
"last_name": "Smith",
"business_email": "jsmith@acmecorp.com",
"sha256_email": "b665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae4",
"company_name": "Acme Corp",
"company_domain": "acmecorp.com",
"job_title": "Product Manager",
"industry": "Technology",
"city": "New York",
"state": "NY",
"zip": "10001",
"address": "456 Broadway",
"linkedin_url": "https://linkedin.com/in/janesmith"
}
]