Jobs
Get Job Status
Get the status and progress of an import or account research job
GET
Get detailed status and progress for a specific import or account research job.
status is one of QUEUED, PROCESSING, COMPLETED, FAILED, CANCELLED. A job is QUEUED when it has been
accepted and charged but has not started yet, typically because your workspace already had imports
in progress. It starts automatically, oldest first, once capacity frees up, so no action is needed;
keep polling this endpoint until it moves to PROCESSING.
When a job fails
AFAILED job carries two more fields:
failure_reason: why it failed, as a sentence that says what to do next. Show this to your user.reason_code: the same as a stable code, for your code to branch on.
New codes may be added.
error_messages keeps the raw text for support.
When a finished job is still settling
overlaps_pending is true when the job has finished (COMPLETED, FAILED or CANCELLED) but some
of its warm-intro overlaps are still being worked out in the background. The job’s opportunity count
can still grow until it turns false, so wait and read again before you treat the numbers as final.
It is false once nothing is left, and always false while the job is still PROCESSING or
QUEUED: check status first. If it is missing, the lookup could not be made; read again.
When an import finishes with derivation incomplete
ACOMPLETED import carries derive_incomplete: true when the warm-intro derivation did not finish
inside the run. derive_incomplete_reason says why: stalled (no progress for two hours) or backstop
(the job time limit). derive_note is a plain-English sentence to show next to the status. The import
is usable; the remaining intros are calculated in the background and appear over the next hours, with
nothing to do. The three fields are absent on every other job. New reasons may be added.
Authorizations
The API key you created on the API settings page of the Clustr app.