The Job Search API allows for programmatic queries to the WE Data Tools job posting database.
Request Format
https://[WEBSITE]/wdt-api/v1/search-jobs/
- Example:
https://www.workforcewindsoressex.com/wdt-api/v1/search-jobs/
- Example:
- Query parameters can be passed via
POST
orGET
.
Query Parameters
Field | Type | Details |
---|---|---|
api_key | string | Required in some deployments, optional in others. |
duration | string | Optional. Any one of the following values: ‘contract’, ‘temporary’, ‘permanent’. If not supplied, queries for all durations. |
excerpt | boolean | Optional. If ‘1’ is supplied, includes a portion of job post content in returned results. Otherwise, does not include this content in returned results. |
limit | integer | Optional. The maximum number of results to return from the query. Default 100, maximum 250. |
occupations | array of strings | Optional. One or more four-digit occupation codes from the National Occupation Classification (NOC) taxonomy. Note that these codes are not integers, as some NOCs have prepended zeros. |
region | string | Optional. A region name such as “Windsor”, “Essex County” or “Peterborough”. Note that queries for a specific region will also include results for any sub-regions. Thus, a query for “Lakeshore” will include results for Emeryville and Belle River, which are part of the Lakeshore region. |
search | string | Optional. A word or phrase to search job post titles and content. |
type | string | Optional. Queries by job type. Use ‘PT’ for part time and ‘FT’ for full time. If not supplied, queries both types. |
page | integer | Optional. Pagination number. Default 1. |
include_meta | boolean | Optional. If true, returns a JSON object instead of an array. Meta data on max pages, current page, and posts-per-page is returned as meta , and the job posts are returned as job_postings . Default false. |