Enrich Account with People Job

Start an async job to discover people at a company using Seniority & Department Filters.

This typically takes 1-5 seconds.

Flow:

1. Call this endpoint with account_id + filters -> receive job_id
2. Poll GET /api/v1/enrich/fast-people-enrichment/{job_id} every 2-3 seconds
3. When status is "completed", the result field contains discovered people ids
4. Use the Get People Endpoint /api/v1/people/batch to get the people details

People locations:

• Optional list of 2-letter country codes (e.g. ["us", "uk", "eu"])
• Available country codes can be fetched from GET /api/v1/icp/options

Credit costs:

• Credits charged per new person stored
• Optionally limit spend with max_credit_limit

Example request:

{
  "account_id": 12345,
  "seniority_filters": ["VP", "DIRECTOR"],
  "department_filters": ["ENGINEERING", "PRODUCT"]
}

Error codes:

• INVALID_REQUEST (400) - Empty filters or credits exceeded
• ACCOUNT_NOT_FOUND (404) - Account ID not found
• CREDITS_EXCEEDED (400) - Monthly credit limit reached

POST /api/v1/enrich/fast-people-enrichment

Enrich Account with People Job

cURL

curl --request POST \
  --url https://api.openfunnel.dev/api/v1/enrich/fast-people-enrichment \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-User-ID: <x-user-id>' \
  --data '
{
  "account_id": 123,
  "seniority_filters": [],
  "department_filters": [],
  "audience_name": "<string>",
  "max_credit_limit": 2,
  "people_locations": [
    "<string>"
  ]
}
'

200

{
  "job_id": "<string>",
  "message": "<string>",
  "account_id": 123,
  "status": "pending",
  "audience_url": "<string>"
}

Headers

X-API-Key · string · required

X-User-ID · string · required

Body

application/json

account_id · integer · required

account ID to discover people for

seniority_filters · enum<string>[] · required

Seniority levels to filter by (e.g., ['VP', 'DIRECTOR', 'HEAD'])

Minimum array length: 1

Job seniority levels for people discovery filtering.

Available options: FOUNDER, CXO, PARTNER, VP, HEAD, DIRECTOR, MANAGER, SENIOR, ENTRY, INTERN

department_filters · enum<string>[] · required

Departments to filter by (e.g., ['ENGINEERING', 'PRODUCT', 'SALES'])

Minimum array length: 1

Job department/function categories for people discovery filtering.

Available options: ENGINEERING, PRODUCT, DATA, SALES, MARKETING, OPERATIONS, FINANCE, HR, LEGAL, EXECUTIVE, CUSTOMER_SUCCESS, SECURITY, IT, OTHER

audience_name · string | null

Optional audience name. If provided, discovered people are added to this audience.

max_credit_limit · integer | null

Maximum number of credits to spend. If omitted, uses your account default.

Required range: x >= 1

people_locations · string[] | null

List of 2-letter country codes to filter people by location (e.g., ['us', 'uk', 'eu'])

Response

200

application/json

Successful Response

Response from starting a fast people discovery job.

Returns immediately with a job_id. Poll GET /api/v1/enrich/fast-people-enrichment/{job_id} for progress and results.

job_id · string · required

Unique job ID for polling via GET /api/v1/enrich/fast-people-enrichment/{job_id}

message · string · required

Human-readable status message

account_id · integer · required

Account ID being searched

status · string · default: pending

Job status - always 'pending' at creation

audience_url · string | null

Audience URL if audience_name was provided