Enrich People with Contact Information Job

Start an async job to enrich people with email and/or phone data.

Looks up each person via their LinkedIn URL and returns a job_id immediately for polling.

Flow:

1. Call this endpoint with people_ids → receive job_id
2. Poll GET /api/v1/enrich/people/{job_id} every 3-5 seconds
3. When status is "completed", the result field contains per-person email/phone data

Credit costs:

• Email enrichment: credits charged per email successfully found (not per attempt)
• Phone enrichment: credits charged per phone number successfully found
• Failed lookups cost nothing

Limits:

• Max 500 people per request
• People must belong to the authenticated user
• People must have a LinkedIn URL for enrichment to work

Example request:

{
  "people_ids": [101, 102, 103],
  "enrich_emails": true,
  "enrich_phones": false
}

Error codes:

• INVALID_REQUEST (400) - Empty people_ids or both enrich flags are false
• PERSON_NOT_FOUND (404) - One or more people_ids not found or not owned by user

POST /api/v1/enrich/people

Enrich People with Contact Information Job

cURL

curl --request POST \
  --url https://api.openfunnel.dev/api/v1/enrich/people \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-User-ID: <x-user-id>' \
  --data '
{
  "people_ids": [
    123
  ],
  "enrich_emails": true,
  "enrich_phones": false
}
'

200

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

Headers

X-API-Key · string · required

X-User-ID · string · required

Body

application/json

Request to enrich people with email addresses and/or phone numbers.

Starts an async enrichment job. Each person is looked up via their LinkedIn URL. Credits are charged per successful email or phone found.

Poll the returned job_id via GET /api/v1/enrich/people/{job_id} for results.

people_ids · integer[] · required

List of people IDs to enrich (max 500 per request)

Required array length: 1 - 500 elements

enrich_emails · boolean · default: true

Whether to enrich with work email addresses

enrich_phones · boolean · default: false

Whether to enrich with phone numbers (additional credits per phone found)

Response

200

application/json

Successful Response

Response from starting a people enrichment job.

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

job_id · string · required

Unique job ID for polling status via GET /api/v1/enrich/people/{job_id}

message · string · required

Human-readable status message

total_people · integer · required

Number of people queued for enrichment

status · string · default: pending

Job status - always 'pending' at creation