Skip to main content
POST
Create a job

Authorizations

x-api-key
string
header
required

API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.

Body

application/json
companyId
string
required
Minimum string length: 1
name
string
required
Minimum string length: 1
description
string | null
required
stageId
string
required
Minimum string length: 1
salaryRange
object | null
required
location
object | null
required
deprecated

Deprecated: use locations instead. A single physical location for the job. Ignored when locations is provided.

employmentType
enum<string> | null
required
Available options:
fullTime,
partTime,
temporary,
internship,
permanent,
fixedTermContract,
interimOrTemporary,
contract
locationType
enum<string> | null
required
Available options:
remote,
hybrid,
onsite
startAt
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
endAt
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
teamUserIds
string[]
required
Minimum string length: 1
clientContactIds
string[]
required
Minimum string length: 1
targetCompanyId
string | null
required
Minimum string length: 1
locations
object[]

Physical locations for the job (0 to 15). Takes precedence over the deprecated location field.

Maximum array length: 15
languages
object[]

Languages required for the job (0 to 100).

Maximum array length: 100
restricted
boolean

Response

Job created successfully. Returns the job ID.

id
string
required
Minimum string length: 1