POST
Add a found job as an Application

Authorizations

x-api-key
string
header
required

An API key from Settings → Developers → API keys in Hiresweep.

Path Parameters

matchId
string
required

The ID of the Match.

Minimum string length: 1

Body

application/json
clientId
string | null

The client whose data this is, for an operator applying on behalf of clients. Omit for your own.

Minimum string length: 1

Response

200 - application/json

The Match, added or tracked, with the Application it now links to.

id
string
required

The ID of the Match.

runId
string
required
clientId
string | null
required

The client this Match is for; null for your own.

resumeId
string | null
required
url
string
required

The link to the job, reduced to the job itself.

originalUrl
string
required
externalId
string | null
required
board
enum<string>
required

The company job board (the applicant tracking system) the job was found on, such as greenhouse, lever, ashby or workday; linkedin or indeed only for jobs found before those were retired.

Available options:
greenhouse,
lever,
ashby,
workday,
smartrecruiters,
workable,
recruitee,
personio,
rippling,
gem,
bamboohr,
breezy,
pinpoint,
teamtailor,
jazzhr,
jobvite,
homerun,
trakstar,
polymer,
comeet,
hibob,
remoteok,
weworkremotely,
himalayas,
jobicy,
arbeitnow,
adzuna,
usajobs,
linkedin,
indeed
title
string
required
company
string | null
required
location
string | null
required
isRemote
boolean | null
required
postedAt
string<date-time> | null
required
snippet
string | null
required
salary
string | null
required

The pay the board lists, as it words it; null when it does not say.

companyStage
enum<string> | null
required

How far along the company is: early (seed to Series B), growth, or public; null when unknown.

Available options:
early,
growth,
public
targetTitles
string[]
required

Every Target whose search found this job.

score
integer
required

A rough fit from keyword overlap; the review scores accurately.

Required range: 0 <= x <= 100
fitReason
string | null
required

The AI's one sentence on why the job fits the resume, once asked for; null until then.

fitGap
string | null
required

The AI's line on the job's biggest gap against the resume, written with the reason; null if none.

state
enum<string>
required

New, added, tracked, dismissed, or expired.

Available options:
new,
added,
tracked,
dismissed,
expired
applicationId
string | null
required

The Application Add job led to, if any.

foundAt
string<date-time>
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required