GET
/
api
/
v1
/
match
/
job
/
{job_id}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

job_id
string
required

Response

200 - application/json
id
string
required

the id of the job

name
string
required

the name of the job

job_type
enum<string>
required
Available options:
match,
transform,
categorize
processing
string | null
required

processing id of the job, should be ignored

user_instructions
string[]
required

the instructions for the system to follow when completing the job, ordered by earliest to latest

updated_at
string
required
dataset_id
string
required

the dataset id of the dataset that the job is processing. For match jobs, this is the base dataset id

match_dataset_id
string
required

the dataset id of the dataset that the job records are being matched against

dataset_name
string | null

the dataset name of the dataset that the job is processing. For match jobs, this is the base dataset name

match_dataset_name
string | null

the dataset name of the dataset that the job records are being matched against

Get match job statusStart match job