Skip to main content
GET
Check job status

Authorizations

X-API-Key
string
header
required

Your brk_live_ API key.

Path Parameters

job_id
string
required

Response

Successful Response

Poll response. On done final target people are returned inline.

job_id
string
required
status
enum<string>
required

processing | done | not_found | no_employees | no_people_found | too_large | failed | cancelled.

Available options:
processing,
done,
not_found,
no_employees,
no_people_found,
too_large,
failed,
cancelled
Example:

"done"

processing_state
enum<string> | null

active or delayed while status=processing.

Available options:
active,
delayed
stage
enum<string> | null

Current canonical pipeline stage.

Available options:
match_company,
scan_team,
enrich_profiles,
find_candidates,
verify_candidates,
match_target
next_retry_at
string | null

ISO timestamp for a delayed automatic retry.

message
string | null

Human-readable explanation for a terminal state that needs one — e.g. why a too_large company was not searched. null otherwise.

Example:

"Companies over 100 employees are available on premium plans."

company_id
integer | null
Example:

3384253

company
Company · object | null

Shared company context, present on done.

persona
AppliedPersona · object | null

The immutable persona snapshot used by this job.

team_scanned
integer | null
profiles_enriched
integer | null
preliminary_candidates
integer | null
target_people_count
integer | null
target_people
TargetPerson · object[] | null

Final ranked persona matches, present only on done.

credits_charged
enum<integer>
default:0

Actual numeric charge so far; 0 until/free, 1 after successful metered settlement.

Available options:
0,
1
Example:

1

credits_balance
integer | null

Your remaining credit balance after this job. Present on done for metered keys.

Example:

7