get https://{subdomain}.workable.com/spi/v3/jobs
Returns a collection of your account jobs. Required scope: r_jobs. Accessible with all token types.
Log in to see full request history
| time | status | user agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Timestamp parameters input format
Supported input formats for the timestamp fields
created_after&updated_afterare:
- 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.
| key | description |
|---|---|
jobs | array of the defined jobs |
paging | Includes 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:
| 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 |
| 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 editor |
| department_hierarchy | array | A collection with the ancestor departments of the job department including that |
| department_hierarchy/id | integer | The id of the department |
| department_hierarchy/name | string | The name of the department |
| url | string | 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/location_str | string | The 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/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 | Indicates if this is a remote/telecommute job |
| 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 | timestamp | The timestamp the job created |
| 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 |
Responses