get https://{subdomain}.workable.com/spi/v3/jobs/
Returns the details of the specified job. Required scope: r_jobs
. Accessible with all token types.
Results
Calling the jobs/:shortcode
will return the full job JSON object.
key | type | description |
---|---|---|
id | string | The job identifier |
title | string | The short title of the job |
full_title | string | The full title of the job (title + code) |
shortcode | string | System generated job code |
code | string | Job code as defined in editor |
state | string | The job state. Possible values are draft , published , closed , archived . Where closed is a job used internally or confidentially |
department | string | The job department as defined in job editor |
url | string | short URL to the job page |
application_url | string | URL to the job application form |
shortlink | string | short URL to the job page |
location | object | Location of the job. When advertise elsewhere is used it contains the advertise location . When advertise elsewhere is not used, it contains the primary location of the job as defined in the job editor. |
location/country | string | The country name as defined in job editor |
location/country_code | string | The two digit country code |
location/region | string | The region as defined in job editor |
location/region_code | string | The two digit region code |
location/city | string | The city as defined in job editor |
location/zip_code | string | The zip code as defined in job editor |
location/telecommuting | boolean | True if job is telecommuting |
location/workplace_type | string | The workplace type. Possible values are on_site ,hybrid ,remote . Superset to telecommuting property. |
locations | array | All locations of the job as defined in job editor. First entry matches the primary location of the job, as defined in job editorFor the keys of each location entry, please check the table below. Note: Will not contain entries for older draft , archived and closed jobs, until they have a state transition |
created_at | string | The timestamp the job was created |
full_description | string | Description + requirements + benefits |
description | string | The description of the job |
requirements | string | The requirements section of the job |
benefits | string | The benefits section of the job |
employment_type | string | The employment type of the job |
industry | string | The job's industry |
function | string | The job's function |
experience | string | The experience required for the job |
education | string | The education level required for the job |
keywords | array | The keywords of the job |
salary/salary_from | integer | The lower bound of the salary |
salary/salary_to | integer | The upper bound of the salary |
salary/salary_currency | string | The ISO code of the salary currency |
Each location
in locations
will have the following keys:
key | type | description |
---|---|---|
country_code | string | The two digit country code |
country_name | string | The country name as defined in job editor |
state_code | string | The two digit state code |
subregion | string | The subregion as defined in job editor |
zip_code | string | The zip code as defined in job editor |
city | string | The city as defined in job editor |
coords | string | The coordinates of the location, if exist |
hidden | boolean | The indication if the location is hidden inCareers Pages , as defined in job editor |