Skip to main content
GET

Quick Answer

How do I know when my contact job is done? Poll this endpoint with the job_id from Contact Append or Contact Prospect until status is completed or failed.Common questions this endpoint answers:
  • Is my contact-append / contact-prospect job still running?
  • How many contacts matched before the size cap?
  • Have results already been unlocked for billing?
What you need: The UUID job_id from a previous submit call.What you get back: Current job status, optional result counts, unlock flag, and error details when failed.

Overview

Returns the current state of a contact job owned by your organization. Use this after Contact Append or Contact Prospect. Recommended polling: every 2–5 seconds until status is terminal (completed or failed). Once completed, unlock results with Contact Job Results.

Status values

This endpoint does not bill. Billing occurs only on the first successful POST .../results unlock.

Request

Headers

x-api-key
string
required
Your API key for authentication.

Path Parameters

job_id
string
required
UUID of the contact job returned by Contact Append or Contact Prospect.

Response

Success Response (200 OK)

job_id
string
Job UUID.
job_type
string
contact_append or contact_prospect.
status
string
One of queued, running, retrying, completed, failed.
created_at
string
ISO-8601 creation timestamp.
result_count
integer
Number of stored result rows when the job completed. null while in progress.
total_matched
integer
Contacts matched in evaluated title batches before applying the size cap. null while in progress.
results_unlocked
boolean
true after a successful unlock via POST .../results.
error_code
string
Machine-readable failure code when status is failed.
message
string
Public error message when the job failed.
started_at
string
When the worker claimed the job, if started.
completed_at
string
When the job reached a terminal state, if finished.
updated_at
string
Last status update timestamp.
Response Example (completed)

Errors