Skip to main content
GET
/
api
/
v1
/
enrich
/
people
/
{job_id}
Poll People Enrichment Job
curl --request GET \
  --url https://api.openfunnel.dev/api/v1/enrich/people/{job_id} \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-User-ID: <x-user-id>'
{
  "job_id": "<string>",
  "status": "<string>",
  "progress": {
    "total": 123,
    "completed": 0,
    "emails_found": 0,
    "phones_found": 0
  },
  "credits_used": {
    "emails": 0,
    "phones": 0,
    "total": 0
  },
  "result": [
    {
      "person_id": 123,
      "status": "<string>",
      "person_name": "<string>",
      "linkedin_url": "<string>",
      "email": "<string>",
      "phone_number": "<string>"
    }
  ],
  "error_message": "<string>"
}

Headers

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

Path Parameters

job_id
string
required

Response

Successful Response

Response from polling a people enrichment job.

Status values:

  • pending — Job created, not yet started
  • running — Enrichment in progress
  • completed — All done; result contains per-person data
  • failed — Job failed; check error_message

Polling recommendation: Every 3-5 seconds. Typical enrichment takes ~2 seconds per person due to upstream API rate limiting.

job_id
string
required

Job ID

status
string
required

'pending', 'running', 'completed', or 'failed'

progress
EnrichPeopleProgress · object

Progress info — available when status is 'running' or 'completed'

credits_used
EnrichPeopleCreditsUsed · object

Credits consumed — available when status is 'completed'

result
EnrichPersonResult · object[] | null

Per-person enrichment results — available when status is 'completed'

error_message
string | null

Error details — present only when status is 'failed'