Get Enrichment

Poll an enrichment job for status and scored results.

Get Enrichment

POST /get_enrichment

Free — no credits are charged. Poll until data.job.status is done (or error).

Headers

Name	Value
Content-Type	application/json

Body

Name	Type	Description
api_key	string	Your API Key.
job_id	string	The enrichment job id to poll.
only_matches	boolean	Optional. Return only matched contacts (default false).
limit	integer	Optional. Max results (default 500).
offset	integer	Optional. Result offset (default 0).

Response

Field inside data	Type	Description
job	object	The job, including job_id, status, and the run counts.
results	array	The scored contacts. Empty until the job finishes.

The top-level status mirrors the job's status, and total is how many results came back. The job handle is also repeated at the top level as job_id. See Response Format for the fields every endpoint returns.

Example

Input

{
  "api_key": "your_api_key",
  "job_id": "011709e1-8310-429c-8e7a-34533670ec25"
}

Output

{
  "status": "done",
  "data": {
    "job": {
      "icp_id": 26,
      "status": "done",
      "total": 2,
      "passed_deterministic": 1,
      "semantic_scored": 1,
      "scored_count": 1,
      "matched": 0,
      "threshold": 0.75,
      "job_id": "011709e1-8310-429c-8e7a-34533670ec25",
      "view": "verified"
    },
    "results": [
      {
        "current_title": "VP of Sales",
        "country": "United States",
        "match_score": 0.7,
        "is_match": false,
        "detail": [ { "id": "sales_director", "verdict": "true", "reason": "VP of Sales is a senior sales leadership role" } ]
      }
    ]
  },
  "credits_used": 0,
  "credits_remaining": 4004.8,
  "total": 1,
  "job_id": "011709e1-8310-429c-8e7a-34533670ec25",
  "success": true
}