Skip to main content
POST
/
api
/
v1
/
enrich
/
deep-enrich
Deep Enrich
curl --request POST \
  --url https://api.openfunnel.dev/api/v1/enrich/deep-enrich \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-User-ID: <x-user-id>' \
  --data '
{
  "domain": "<string>",
  "goal": "<string>",
  "icp_id": 123,
  "target_icp_roles": [
    "<string>"
  ],
  "timeframe": 90,
  "max_jobs_to_check": 200,
  "campaign_name": "<string>",
  "people_locations": [
    "<string>"
  ],
  "people_sub_locations": [
    "<string>"
  ]
}
'
{
  "status": "<string>",
  "account_id": 123,
  "domain": "<string>",
  "message": "<string>"
}

Headers

​
X-API-Key
string
required
​
X-User-ID
string
required

Body

application/json

Request model for end-to-end company qualification and people enrichment.

​
domain
string
required

Company website domain (e.g. 'stripe.com')

​
goal
string | null

Search goal (overrides default pitch)

​
icp_id
integer | null

ICP ID to fetch target roles from

​
target_icp_roles
string[] | null

Target ICP roles (overrides icp_id roles)

​
timeframe
integer
default:90

Timeframe in days to search back

Required range: 1 <= x <= 365
​
max_jobs_to_check
integer
default:200

Max jobs to check for relevance

Required range: 1 <= x <= 500
​
campaign_name
string | null

Campaign name to create for enriched people

​
people_locations
string[] | null

Target people locations (overrides ICP)

​
people_sub_locations
string[] | null

Target people sub-locations (overrides ICP)

Response

Successful Response

​
status
string
required
​
account_id
integer
required
​
domain
string
required
​
message
string
required