API Reference
API Reference

/jobs

Returns a collection of your account jobs. Required scope: r_jobs. Accessible with all token types.

📘

Timestamp parameters input format

Supported input formats for the timestamp fields created_after & updated_after are:

  • ISO8601 e.g. 20150708T115616Z
  • Unix time (e.g. 1436356721)

Results

Calling the /jobs endpoint will return a collection of the defined jobs sorted by the time inserted on system, in ascending order (older jobs come first).

By default results are limited to 50. The limit can by updated via the request parameter limit. The value specified cannot be more than 100.

keydescription
jobsarray of the defined jobs
pagingIncludes the next URL pointing to the next results page, in case there are more results than the provided limit

Each job will have the following keys:

keytypedescription
idstringThe job identifier
titlestringThe short title of the job
full_titlestringThe full title of the job
shortcodestringSystem generated job code
codestringJob code as defined in editor
statestringThe job state. Possible values are draft, published, closed, archived. Where closed is a job used internally or confidentially
departmentstringThe job department as defined in editor
department_hierarchyarrayA collection with the ancestor departments of the job department including that
department_hierarchy/idintegerThe id of the department
department_hierarchy/namestringThe name of the department
urlstringURL to the job page
application_urlstringURL to the job application form
shortlinkstringshort URL to the job page
locationobjectLocation 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/location_strstringThe location string translated into the language of the job. The location string consists of city, region, and country separated by comma (some of these elements might be missing).
location/countrystringThe country name as defined in job editor
location/country_codestringThe two digit country code
location/regionstringThe region as defined in job editor
location/region_codestringThe two digit region code
location/citystringThe city as defined in job editor
location/zip_codestringThe zip code as defined in job editor
location/telecommutingbooleanIndicates if this is a remote/telecommute job
location/workplace_typestringThe workplace type. Possible values are on_site,hybrid,remote. Superset to telecommuting property.
locationsarrayAll locations of the job as defined in job editor. First entry matches the primary location of the job, as defined in job editor

For 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_attimestampThe timestamp the job created
salary/salary_fromintegerThe lower bound of the salary
salary/salary_tointegerThe upper bound of the salary
salary/salary_currencystringThe ISO code of the salary currency

Each location in locations will have the following keys:

keytypedescription
country_codestringThe two digit country code
country_namestringThe country name as defined in job editor
state_codestringThe two digit state code
subregionstringThe subregion as defined in job editor
zip_codestringThe zip code as defined in job editor
citystringThe city as defined in job editor
coordsstringThe coordinates of the location, if exist
hiddenbooleanThe indication if the location is hidden in
Careers Pages, as defined in job editor
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!