{ "openapi": "3.0.3", "info": { "title": "The Jobs API", "version": "1.0.0", "description": "Verified active jobs collected directly from employers' career sites and applicant tracking systems in Canada and the United States." }, "servers": [ { "url": "https://api.thejobsapi.com" } ], "tags": [ { "name": "Feeds", "description": "Polling feeds for keeping your own copy of the catalogue: new, modified and expired jobs." }, { "name": "Search", "description": "Query the live catalogue and follow its change log." }, { "name": "Organizations", "description": "Employers in the catalogue." } ], "paths": { "/v1/active-ats": { "get": { "tags": [ "Feeds" ], "operationId": "activeAts", "summary": "New jobs", "description": "Active jobs first collected within `time_frame`, newest posting first (or by `id` with `cursor`). Poll `1h` every hour or `24h` once a day in the same hour to receive every job once.", "parameters": [ { "name": "time_frame", "in": "query", "required": false, "description": "`1h`: the last full UTC hour. `24h`: the 24 hours up to the last full hour. `7d` and `6m`: rolling windows for backfills.", "schema": { "type": "string", "enum": [ "1h", "24h", "7d", "6m" ], "default": "24h" } }, { "name": "limit", "in": "query", "required": false, "description": "Jobs per page, 1\u20131000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 100 } }, { "name": "offset", "in": "query", "required": false, "description": "Jobs to skip (offset pagination, ordered by `date_posted` descending).", "schema": { "type": "integer", "minimum": 0 } }, { "name": "cursor", "in": "query", "required": false, "description": "Cursor pagination: pass the last `id` of the previous page. Orders by `id` ascending and overrides `offset`. Use it for `6m` backfills.", "schema": { "type": "integer", "format": "int64" } }, { "name": "description_format", "in": "query", "required": false, "description": "Adds `description_text` or `description_html`. Omit it to leave descriptions out.", "schema": { "type": "string", "enum": [ "text", "html" ] } }, { "name": "include_source_fields", "in": "query", "required": false, "description": "Adds `source_fields`: employer-published structured facts (department, pay tiers, qualifications\u2026) with the path where each was found.", "schema": { "type": "boolean" } }, { "name": "include_derived", "in": "query", "required": false, "description": "Adds `derived`: values read by rules from the posting text (skills, work arrangement, experience, education, hours, benefits...), kept apart from employer-published fields.", "schema": { "type": "boolean" } }, { "name": "id", "in": "query", "required": false, "description": "Only these job ids, comma-separated.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "include_basic_organization_details", "in": "query", "required": false, "description": "Fills `organization_url`, `organization_logo` and `domain_derived` from the employer's verified official website, and adds `organization_id`.", "schema": { "type": "boolean" } }, { "name": "title", "in": "query", "required": false, "description": "Search the job title. Google-style: `software engineer` needs both words, `\"software engineer\"` is a phrase, `software OR engineer` either word, `-intern` excludes, `engineer*` matches a prefix. Accents and case are ignored.", "schema": { "type": "string" } }, { "name": "title_advanced", "in": "query", "required": false, "description": "Boolean search on the job title. Boolean expression: `&` AND, `|` OR, `!` NOT, `<->` followed by, `` within N words, `'quoted phrase'`, `( )` grouping and `:*` prefix. Takes precedence over the plain parameter.", "schema": { "type": "string" } }, { "name": "description", "in": "query", "required": false, "description": "Search title, employer and description together. Google-style: `software engineer` needs both words, `\"software engineer\"` is a phrase, `software OR engineer` either word, `-intern` excludes, `engineer*` matches a prefix. Accents and case are ignored.", "schema": { "type": "string" } }, { "name": "description_advanced", "in": "query", "required": false, "description": "Boolean search on title, employer and description. Boolean expression: `&` AND, `|` OR, `!` NOT, `<->` followed by, `` within N words, `'quoted phrase'`, `( )` grouping and `:*` prefix. Takes precedence over the plain parameter.", "schema": { "type": "string" } }, { "name": "location", "in": "query", "required": false, "description": "Full place names as `City, Region, Country`: `Canada`, `Ontario, Canada`, `\"Toronto, Ontario, Canada\" OR \"Vancouver, British Columbia, Canada\"`, `California, United States`. A single name matches a region or city of that name. Countries must be written out (`United States`, not `US`).", "schema": { "type": "string" } }, { "name": "location_advanced", "in": "query", "required": false, "description": "Boolean search on the derived location text (\"City Region Country\"). Boolean expression: `&` AND, `|` OR, `!` NOT, `<->` followed by, `` within N words, `'quoted phrase'`, `( )` grouping and `:*` prefix. Takes precedence over the plain parameter.", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "description": "Country views to include, comma-separated: `CA`, `US` or both (default both). A posting with locations in both countries appears once in each view, with a different `id`.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "organization", "in": "query", "required": false, "description": "Exact, case-sensitive employer names, comma-separated. Wrap a name containing a comma in double quotes: `\"Acme, Inc.\"`.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "exclude_organization", "in": "query", "required": false, "description": "Employer names to exclude; same rules as `organization`.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "organization_advanced", "in": "query", "required": false, "description": "Boolean search on the employer name. Boolean expression: `&` AND, `|` OR, `!` NOT, `<->` followed by, `` within N words, `'quoted phrase'`, `( )` grouping and `:*` prefix. Takes precedence over the plain parameter.", "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": false, "description": "Source systems to include, comma-separated, e.g. `workday,greenhouse,icims`. `lever.co`, `phenompeople` and `taleo` are accepted as aliases.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "exclude_source", "in": "query", "required": false, "description": "Source systems to exclude.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "date_posted_gte", "in": "query", "required": false, "description": "Posted at or after this time (ISO 8601, UTC when no zone is given).", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_posted_lt", "in": "query", "required": false, "description": "Posted before this time.", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_created_gte", "in": "query", "required": false, "description": "First collected at or after this time. Use it to replay a missed window exactly.", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_created_lt", "in": "query", "required": false, "description": "First collected before this time.", "schema": { "type": "string", "format": "date-time" } }, { "name": "has_salary", "in": "query", "required": false, "description": "`true` for jobs whose employer published pay, `false` for jobs without.", "schema": { "type": "boolean" } }, { "name": "remote", "in": "query", "required": false, "description": "`true` for jobs the employer marks remote, `false` to exclude them.", "schema": { "type": "boolean" } }, { "name": "has_no_location", "in": "query", "required": false, "description": "`true` for jobs without a resolved location.", "schema": { "type": "boolean" } }, { "name": "skill", "in": "query", "required": false, "description": "Jobs whose text names any of these skills, comma-separated: names or spellings (`Excel`, `Auto CAD`, `forklift`) or dictionary ids (`microsoft-excel`). Matched by rules against our skills dictionary (O*NET, ESCO and curated Canadian licences); see `derived.skills`.", "schema": { "type": "string", "description": "Comma-separated values." } } ], "responses": { "200": { "description": "Successful response. See the full response schemas at https://thejobsapi.com/openapi.json", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid filters or cursor." }, "401": { "description": "Authentication required." }, "429": { "description": "Rate or usage limit reached." } } } }, "/v1/active-ats-count": { "get": { "tags": [ "Feeds" ], "operationId": "activeAtsCount", "summary": "Count new jobs", "description": "How many jobs match the filters in `time_frame`, without returning them. `1m` counts jobs first collected in the last 31 days including those since expired; other windows count active jobs only.", "parameters": [ { "name": "time_frame", "in": "query", "required": false, "description": "Window to count.", "schema": { "type": "string", "enum": [ "1h", "24h", "7d", "1m", "6m" ], "default": "1m" } }, { "name": "title", "in": "query", "required": false, "description": "Search the job title. Google-style: `software engineer` needs both words, `\"software engineer\"` is a phrase, `software OR engineer` either word, `-intern` excludes, `engineer*` matches a prefix. Accents and case are ignored.", "schema": { "type": "string" } }, { "name": "title_advanced", "in": "query", "required": false, "description": "Boolean search on the job title. Boolean expression: `&` AND, `|` OR, `!` NOT, `<->` followed by, `` within N words, `'quoted phrase'`, `( )` grouping and `:*` prefix. Takes precedence over the plain parameter.", "schema": { "type": "string" } }, { "name": "description", "in": "query", "required": false, "description": "Search title, employer and description together. Google-style: `software engineer` needs both words, `\"software engineer\"` is a phrase, `software OR engineer` either word, `-intern` excludes, `engineer*` matches a prefix. Accents and case are ignored.", "schema": { "type": "string" } }, { "name": "description_advanced", "in": "query", "required": false, "description": "Boolean search on title, employer and description. Boolean expression: `&` AND, `|` OR, `!` NOT, `<->` followed by, `` within N words, `'quoted phrase'`, `( )` grouping and `:*` prefix. Takes precedence over the plain parameter.", "schema": { "type": "string" } }, { "name": "location", "in": "query", "required": false, "description": "Full place names as `City, Region, Country`: `Canada`, `Ontario, Canada`, `\"Toronto, Ontario, Canada\" OR \"Vancouver, British Columbia, Canada\"`, `California, United States`. A single name matches a region or city of that name. Countries must be written out (`United States`, not `US`).", "schema": { "type": "string" } }, { "name": "location_advanced", "in": "query", "required": false, "description": "Boolean search on the derived location text (\"City Region Country\"). Boolean expression: `&` AND, `|` OR, `!` NOT, `<->` followed by, `` within N words, `'quoted phrase'`, `( )` grouping and `:*` prefix. Takes precedence over the plain parameter.", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "description": "Country views to include, comma-separated: `CA`, `US` or both (default both). A posting with locations in both countries appears once in each view, with a different `id`.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "organization", "in": "query", "required": false, "description": "Exact, case-sensitive employer names, comma-separated. Wrap a name containing a comma in double quotes: `\"Acme, Inc.\"`.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "exclude_organization", "in": "query", "required": false, "description": "Employer names to exclude; same rules as `organization`.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "organization_advanced", "in": "query", "required": false, "description": "Boolean search on the employer name. Boolean expression: `&` AND, `|` OR, `!` NOT, `<->` followed by, `` within N words, `'quoted phrase'`, `( )` grouping and `:*` prefix. Takes precedence over the plain parameter.", "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": false, "description": "Source systems to include, comma-separated, e.g. `workday,greenhouse,icims`. `lever.co`, `phenompeople` and `taleo` are accepted as aliases.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "exclude_source", "in": "query", "required": false, "description": "Source systems to exclude.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "date_posted_gte", "in": "query", "required": false, "description": "Posted at or after this time (ISO 8601, UTC when no zone is given).", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_posted_lt", "in": "query", "required": false, "description": "Posted before this time.", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_created_gte", "in": "query", "required": false, "description": "First collected at or after this time. Use it to replay a missed window exactly.", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_created_lt", "in": "query", "required": false, "description": "First collected before this time.", "schema": { "type": "string", "format": "date-time" } }, { "name": "has_salary", "in": "query", "required": false, "description": "`true` for jobs whose employer published pay, `false` for jobs without.", "schema": { "type": "boolean" } }, { "name": "remote", "in": "query", "required": false, "description": "`true` for jobs the employer marks remote, `false` to exclude them.", "schema": { "type": "boolean" } }, { "name": "has_no_location", "in": "query", "required": false, "description": "`true` for jobs without a resolved location.", "schema": { "type": "boolean" } }, { "name": "skill", "in": "query", "required": false, "description": "Jobs whose text names any of these skills, comma-separated: names or spellings (`Excel`, `Auto CAD`, `forklift`) or dictionary ids (`microsoft-excel`). Matched by rules against our skills dictionary (O*NET, ESCO and curated Canadian licences); see `derived.skills`.", "schema": { "type": "string", "description": "Comma-separated values." } } ], "responses": { "200": { "description": "Successful response. See the full response schemas at https://thejobsapi.com/openapi.json", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid filters or cursor." }, "401": { "description": "Authentication required." }, "429": { "description": "Rate or usage limit reached." } } } }, "/v1/modified-ats": { "get": { "tags": [ "Feeds" ], "operationId": "modifiedAts", "summary": "Modified jobs", "description": "Active jobs whose published content changed in the 24 hours up to the last full UTC hour (or the `date_modified_*` window, at most 31 days). `date_modified` is the job's latest change, so a job changed again after the window appears in the later window. Ordered by `date_modified` descending.", "parameters": [ { "name": "date_modified_gte", "in": "query", "required": false, "description": "Changed at or after this time.", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_modified_lt", "in": "query", "required": false, "description": "Changed before this time.", "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "required": false, "description": "Jobs per page, 1\u20131000.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 100 } }, { "name": "offset", "in": "query", "required": false, "description": "Jobs to skip (offset pagination, ordered by `date_posted` descending).", "schema": { "type": "integer", "minimum": 0 } }, { "name": "cursor", "in": "query", "required": false, "description": "Cursor pagination: pass the last `id` of the previous page. Orders by `id` ascending and overrides `offset`. Use it for `6m` backfills.", "schema": { "type": "integer", "format": "int64" } }, { "name": "description_format", "in": "query", "required": false, "description": "Adds `description_text` or `description_html`. Omit it to leave descriptions out.", "schema": { "type": "string", "enum": [ "text", "html" ] } }, { "name": "include_source_fields", "in": "query", "required": false, "description": "Adds `source_fields`: employer-published structured facts (department, pay tiers, qualifications\u2026) with the path where each was found.", "schema": { "type": "boolean" } }, { "name": "include_derived", "in": "query", "required": false, "description": "Adds `derived`: values read by rules from the posting text (skills, work arrangement, experience, education, hours, benefits...), kept apart from employer-published fields.", "schema": { "type": "boolean" } }, { "name": "id", "in": "query", "required": false, "description": "Only these job ids, comma-separated.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "include_basic_organization_details", "in": "query", "required": false, "description": "Fills `organization_url`, `organization_logo` and `domain_derived` from the employer's verified official website, and adds `organization_id`.", "schema": { "type": "boolean" } }, { "name": "title", "in": "query", "required": false, "description": "Search the job title. Google-style: `software engineer` needs both words, `\"software engineer\"` is a phrase, `software OR engineer` either word, `-intern` excludes, `engineer*` matches a prefix. Accents and case are ignored.", "schema": { "type": "string" } }, { "name": "title_advanced", "in": "query", "required": false, "description": "Boolean search on the job title. Boolean expression: `&` AND, `|` OR, `!` NOT, `<->` followed by, `` within N words, `'quoted phrase'`, `( )` grouping and `:*` prefix. Takes precedence over the plain parameter.", "schema": { "type": "string" } }, { "name": "description", "in": "query", "required": false, "description": "Search title, employer and description together. Google-style: `software engineer` needs both words, `\"software engineer\"` is a phrase, `software OR engineer` either word, `-intern` excludes, `engineer*` matches a prefix. Accents and case are ignored.", "schema": { "type": "string" } }, { "name": "description_advanced", "in": "query", "required": false, "description": "Boolean search on title, employer and description. Boolean expression: `&` AND, `|` OR, `!` NOT, `<->` followed by, `` within N words, `'quoted phrase'`, `( )` grouping and `:*` prefix. Takes precedence over the plain parameter.", "schema": { "type": "string" } }, { "name": "location", "in": "query", "required": false, "description": "Full place names as `City, Region, Country`: `Canada`, `Ontario, Canada`, `\"Toronto, Ontario, Canada\" OR \"Vancouver, British Columbia, Canada\"`, `California, United States`. A single name matches a region or city of that name. Countries must be written out (`United States`, not `US`).", "schema": { "type": "string" } }, { "name": "location_advanced", "in": "query", "required": false, "description": "Boolean search on the derived location text (\"City Region Country\"). Boolean expression: `&` AND, `|` OR, `!` NOT, `<->` followed by, `` within N words, `'quoted phrase'`, `( )` grouping and `:*` prefix. Takes precedence over the plain parameter.", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "description": "Country views to include, comma-separated: `CA`, `US` or both (default both). A posting with locations in both countries appears once in each view, with a different `id`.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "organization", "in": "query", "required": false, "description": "Exact, case-sensitive employer names, comma-separated. Wrap a name containing a comma in double quotes: `\"Acme, Inc.\"`.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "exclude_organization", "in": "query", "required": false, "description": "Employer names to exclude; same rules as `organization`.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "organization_advanced", "in": "query", "required": false, "description": "Boolean search on the employer name. Boolean expression: `&` AND, `|` OR, `!` NOT, `<->` followed by, `` within N words, `'quoted phrase'`, `( )` grouping and `:*` prefix. Takes precedence over the plain parameter.", "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": false, "description": "Source systems to include, comma-separated, e.g. `workday,greenhouse,icims`. `lever.co`, `phenompeople` and `taleo` are accepted as aliases.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "exclude_source", "in": "query", "required": false, "description": "Source systems to exclude.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "date_posted_gte", "in": "query", "required": false, "description": "Posted at or after this time (ISO 8601, UTC when no zone is given).", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_posted_lt", "in": "query", "required": false, "description": "Posted before this time.", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_created_gte", "in": "query", "required": false, "description": "First collected at or after this time. Use it to replay a missed window exactly.", "schema": { "type": "string", "format": "date-time" } }, { "name": "date_created_lt", "in": "query", "required": false, "description": "First collected before this time.", "schema": { "type": "string", "format": "date-time" } }, { "name": "has_salary", "in": "query", "required": false, "description": "`true` for jobs whose employer published pay, `false` for jobs without.", "schema": { "type": "boolean" } }, { "name": "remote", "in": "query", "required": false, "description": "`true` for jobs the employer marks remote, `false` to exclude them.", "schema": { "type": "boolean" } }, { "name": "has_no_location", "in": "query", "required": false, "description": "`true` for jobs without a resolved location.", "schema": { "type": "boolean" } }, { "name": "skill", "in": "query", "required": false, "description": "Jobs whose text names any of these skills, comma-separated: names or spellings (`Excel`, `Auto CAD`, `forklift`) or dictionary ids (`microsoft-excel`). Matched by rules against our skills dictionary (O*NET, ESCO and curated Canadian licences); see `derived.skills`.", "schema": { "type": "string", "description": "Comma-separated values." } } ], "responses": { "200": { "description": "Successful response. See the full response schemas at https://thejobsapi.com/openapi.json", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid filters or cursor." }, "401": { "description": "Authentication required." }, "429": { "description": "Rate or usage limit reached." } } } }, "/v1/expired-ats": { "get": { "tags": [ "Feeds" ], "operationId": "expiredAts", "summary": "Expired jobs", "description": "Ids of jobs that left the feed in the window: removed by the employer, or found not to be in the country after all. Delete them from your copy.", "parameters": [ { "name": "time_frame", "in": "query", "required": false, "description": "`1h`: the last hour (rolling). `1d`: the previous UTC day. `1m`: 31 days. `6m`: 183 days.", "schema": { "type": "string", "enum": [ "1h", "1d", "1m", "6m" ], "default": "1d" } }, { "name": "country", "in": "query", "required": false, "description": "Country views, comma-separated (default both).", "schema": { "type": "string", "description": "Comma-separated values." } } ], "responses": { "200": { "description": "Successful response. See the full response schemas at https://thejobsapi.com/openapi.json", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid filters or cursor." }, "401": { "description": "Authentication required." }, "429": { "description": "Rate or usage limit reached." } } } }, "/v1/ats-organizations": { "get": { "tags": [ "Organizations" ], "operationId": "organizations", "summary": "Organization list", "description": "Every employer with active jobs, with its source systems, countries and active job count. Refreshed hourly. Use the names with `organization`.", "parameters": [ { "name": "format", "in": "query", "required": false, "description": "Response format.", "schema": { "type": "string", "enum": [ "json", "csv" ], "default": "json" } }, { "name": "country", "in": "query", "required": false, "description": "Only employers with jobs in these countries.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "apiKey", "in": "query", "required": false, "description": "Your API key, for downloading in a browser. Prefer the Authorization header.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response. See the full response schemas at https://thejobsapi.com/openapi.json", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid filters or cursor." }, "401": { "description": "Authentication required." }, "429": { "description": "Rate or usage limit reached." } } } }, "/v1/jobs": { "get": { "tags": [ "Search" ], "operationId": "searchJobs", "summary": "Search jobs", "description": "Active jobs in one country, newest first, with `next_cursor` pagination. A text or place search answers within about 5 seconds: when matches are sparse among the newest jobs, a page can hold fewer than `limit` jobs (even none) while `next_cursor` is set. Keep passing `next_cursor` back until it is null.", "parameters": [ { "name": "country", "in": "query", "required": false, "description": "Country view.", "schema": { "type": "string", "enum": [ "CA", "US" ], "default": "CA" } }, { "name": "q", "in": "query", "required": false, "description": "Search title, employer and description. Google-style: `software engineer` needs both words, `\"software engineer\"` is a phrase, `software OR engineer` either word, `-intern` excludes, `engineer*` matches a prefix. Accents and case are ignored.", "schema": { "type": "string" } }, { "name": "title", "in": "query", "required": false, "description": "Search the title only.", "schema": { "type": "string" } }, { "name": "province", "in": "query", "required": false, "description": "Canadian provinces, codes or names: `ON,BC` or `Ontario`.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "state", "in": "query", "required": false, "description": "US states, codes or names: `NY,CA` or `Texas` (with `country=US`).", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "city", "in": "query", "required": false, "description": "A city, optionally with its region and country: `Toronto`, `Toronto, ON`, `Montr\u00e9al, Qu\u00e9bec`, `Houston, Texas, United States`. A place we cannot find, or one in the other country, is a 400.", "schema": { "type": "string" } }, { "name": "source", "in": "query", "required": false, "description": "Source systems.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "employment_type", "in": "query", "required": false, "description": "`FULL_TIME`, `PART_TIME`, `CONTRACTOR`, `TEMPORARY`, `INTERN`, `VOLUNTEER`, `PER_DIEM`.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "remote", "in": "query", "required": false, "description": "Remote only, or exclude remote.", "schema": { "type": "boolean" } }, { "name": "has_salary", "in": "query", "required": false, "description": "With or without published pay.", "schema": { "type": "boolean" } }, { "name": "skill", "in": "query", "required": false, "description": "Jobs whose text names any of these skills, comma-separated: names or spellings (`Excel`, `Auto CAD`, `forklift`) or dictionary ids (`microsoft-excel`). Matched by rules against our skills dictionary (O*NET, ESCO and curated Canadian licences); see `derived.skills`.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "derived", "in": "query", "required": false, "description": "Include the `derived` object (values read by rules from the text).", "schema": { "type": "boolean", "default": true } }, { "name": "window", "in": "query", "required": false, "description": "First collected within this window.", "schema": { "type": "string", "enum": [ "1h", "24h", "7d", "30d", "6m" ] } }, { "name": "description", "in": "query", "required": false, "description": "Description fields to add.", "schema": { "type": "string", "enum": [ "none", "text", "html", "both" ] } }, { "name": "source_fields", "in": "query", "required": false, "description": "Add `source_fields`.", "schema": { "type": "boolean" } }, { "name": "include_organization", "in": "query", "required": false, "description": "Adds `organization_id` and `organization_profile` (a short employer profile; the full one is at `/v1/organizations/{id}`).", "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "required": false, "description": "Jobs per page.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 100 } }, { "name": "cursor", "in": "query", "required": false, "description": "`next_cursor` from the previous page.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response. See the full response schemas at https://thejobsapi.com/openapi.json", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid filters or cursor." }, "401": { "description": "Authentication required." }, "429": { "description": "Rate or usage limit reached." } } } }, "/v1/jobs/{id}": { "get": { "tags": [ "Search" ], "operationId": "getJob", "summary": "Get a job", "description": "One job with both descriptions, `source_fields` and `derived`, whatever its status.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "description": "Job id." }, { "name": "derived_evidence", "in": "query", "required": false, "description": "Adds `derived_evidence`: the passage each derived value was read from.", "schema": { "type": "boolean" } }, { "name": "include_organization", "in": "query", "required": false, "description": "Adds `organization_id` and `organization_profile`.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Successful response. See the full response schemas at https://thejobsapi.com/openapi.json", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid filters or cursor." }, "401": { "description": "Authentication required." }, "429": { "description": "Rate or usage limit reached." } } } }, "/v1/changes": { "get": { "tags": [ "Search" ], "operationId": "changes", "summary": "Changes feed", "description": "Every created, updated, expired and excluded event for one country, in order. Store `next_since` and pass it back; `more` is true while events remain.", "parameters": [ { "name": "country", "in": "query", "required": false, "description": "Country view.", "schema": { "type": "string", "enum": [ "CA", "US" ], "default": "CA" } }, { "name": "since", "in": "query", "required": false, "description": "Last sequence number you processed.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "limit", "in": "query", "required": false, "description": "Events per page.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 500 } }, { "name": "description", "in": "query", "required": false, "description": "Description fields to add.", "schema": { "type": "string", "enum": [ "none", "text", "html", "both" ] } }, { "name": "source_fields", "in": "query", "required": false, "description": "Include `source_fields`.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Successful response. See the full response schemas at https://thejobsapi.com/openapi.json", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid filters or cursor." }, "401": { "description": "Authentication required." }, "429": { "description": "Rate or usage limit reached." } } } }, "/v1/organizations": { "get": { "tags": [ "Organizations" ], "operationId": "listOrganizations", "summary": "Find organizations", "description": "Employer profiles, most active jobs first, with `next_cursor` pagination. Each item is the short profile; get the full one with `/v1/organizations/{id}`.", "parameters": [ { "name": "name", "in": "query", "required": false, "description": "Name starts with (case, accents and legal endings like Inc. are ignored).", "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": false, "description": "Employers with jobs in this country.", "schema": { "type": "string", "enum": [ "CA", "US" ] } }, { "name": "industry", "in": "query", "required": false, "description": "Industries, comma-separated, as the profile's `about.industries` names them (Wikidata industry or SEC SIC description), e.g. `retail`.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "size", "in": "query", "required": false, "description": "Employee size bands, from a count the employer, the SEC or Wikidata states.", "schema": { "type": "string", "description": "Comma-separated values." } }, { "name": "hiring_trend", "in": "query", "required": false, "description": "New jobs in the last 30 days against the 30 days before.", "schema": { "type": "string", "enum": [ "growing", "steady", "slowing", "new" ] } }, { "name": "has_lmia", "in": "query", "required": false, "description": "Canada: named on ESDC's list of employers approved to hire temporary foreign workers (positive LMIA) in the last two years.", "schema": { "type": "boolean" } }, { "name": "states_visa_sponsorship", "in": "query", "required": false, "description": "At least one active posting says it offers visa sponsorship.", "schema": { "type": "boolean" } }, { "name": "has_website", "in": "query", "required": false, "description": "A verified or likely official website is known.", "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "required": false, "description": "Organizations per page.", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "description": "`next_cursor` from the previous page.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response. See the full response schemas at https://thejobsapi.com/openapi.json", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid filters or cursor." }, "401": { "description": "Authentication required." }, "429": { "description": "Rate or usage limit reached." } } } }, "/v1/organizations/{id}": { "get": { "tags": [ "Organizations" ], "operationId": "getOrganization", "summary": "Get an organization", "description": "The full employer profile. Every value is a fact object that says who stated it: `stated` (the employer's own website, quoted with its address), `registry` (Wikidata, SEC EDGAR, GLEIF, ESDC) or `derived` (computed by us from our jobs, with method and version). Values from different sources are listed side by side.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" }, "description": "Organization id (`organization_id` on jobs)." } ], "responses": { "200": { "description": "Successful response. See the full response schemas at https://thejobsapi.com/openapi.json", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid filters or cursor." }, "401": { "description": "Authentication required." }, "429": { "description": "Rate or usage limit reached." } } } }, "/v1/stats": { "get": { "tags": [ "Search" ], "operationId": "stats", "summary": "Stats", "description": "Active jobs per source and region, and board counts, for one country. Recomputed every 30 minutes; `generated_at` says when.", "parameters": [ { "name": "country", "in": "query", "required": false, "description": "Country view.", "schema": { "type": "string", "enum": [ "CA", "US" ], "default": "CA" } } ], "responses": { "200": { "description": "Successful response. See the full response schemas at https://thejobsapi.com/openapi.json", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid filters or cursor." }, "401": { "description": "Authentication required." }, "429": { "description": "Rate or usage limit reached." } } } } }, "components": {} }