GET /api/v1/jobs
List jobs

Params

Param name Description
company_id
optional

Only show jobs belonging to that company if specified.


Value:

Must be a number

start
optional

Start offset of the result set. Default is 0.


Value:

Must be a number

rows
optional

Amount of rows in the result set. Default is 10.


Value:

Must be a number

filter_title
optional

Search filter on job title.


Value:

Must be String

filter_status
optional

Search filter on job status. Should be “Open”, “Pending”, “Closed” or “Disabled”.


Value:

Must be String


GET /api/v1/job/:id
Show a job


GET /api/v1/job
Show a job identified by external reference

Params

Param name Description
externalReference
required

External reference value


Value:

Must be String


POST /api/v1/jobs
Creates a job. NOTE: Take care that this call has to be made in a 'multipart/form-data' format to transfer the 'file' parameter!

Supported Formats

multipart/form-data

Errors

409 In case a document with the same externalReference already exists
455 Could not detect language (or language not allowed on this instance)
456 Found no usable content in the file

Params

Param name Description
file
required

Job description file (.txt, .doc(x), .pdf are supported)


Value:

Must be File

title
required

Job title


Value:

Must be String

status
optional

Job status ('open', 'pending' or 'closed'). Default is 'open'.


Value:

Must be String

maxdistance
optional

Maximum distance for candidate matches from the company location in km. Pass nil or '-1' to disable this filter. Default is nil (disabled).


Value:

Must be a number

company_id
required

Id of the company that this job should be attached to


Value:

Must be a number

independentlocation
optional

Independent location from the company (true) or same location as the company (false). If true the 'city', 'country', 'lat' and 'lng' parameters have to be present. Default is false.


Value:

Must be 'true' or 'false'

lat
optional

Independent job location latitude (only if 'independentlocation' is true)


Value:

Must be Float

lng
optional

Independent job location longitude (only if 'independentlocation' is true)


Value:

Must be Float

city
optional

Independent job location city (only if 'independentlocation' is true)


Value:

Must be String

country
optional

Independent job location country (only if 'independentlocation' is true)


Value:

Must be String

externalReference
optional

External reference value which can be used to 'link' this job to an external store


Value:

Must be String


PUT /api/v1/job/:id
Update a job

Params

Param name Description
title
optional

Job title


Value:

Must be String

status
optional

Job status ('open', 'pending' or 'closed').


Value:

Must be String

read
optional

Mark a job read or unread


Value:

Must be a boolean

maxdistance
optional

Maximum distance for candidate matches from the company location in km. Pass nil or '-1' to disable this filter.


Value:

Must be a number

independentlocation
optional

Independent location from the company (true) or same location as the company (false). If true the 'city', 'country', 'lat' and 'lng' parameters have to be present.


Value:

Must be 'true' or 'false'

lat
optional

Independent job location latitude (only if 'independentlocation' is true)


Value:

Must be Float

lng
optional

Independent job location longitude (only if 'independentlocation' is true)


Value:

Must be Float

city
optional

Independent job location city (only if 'independentlocation' is true)


Value:

Must be String

country
optional

Independent job location country (only if 'independentlocation' is true)


Value:

Must be String

externalReference
optional

External reference value which can be used to 'link' this job to an external store


Value:

Must be String


DELETE /api/v1/job/:id
Destroy a job


POST /api/v1/job/:id/matches/download
Download all matches for a job