/workday/jobs/search

POST /api/workday/jobs/search

Price: 1 credit

List job postings from a Workday-powered company career board by its career-site URL, optionally narrowed by a keyword and facet filters (job category, time type, location, etc.). Each posting includes the title, requisition id, location, posting date, time type and the public job URL.

How to use it

List the job postings of a specific company's Workday career board (*.myworkdayjobs.com). Pass the career_site_url and count. Optional search_text narrows by keyword; applied_facets ({facetParameter: [valueId]}) narrows by job category (jobFamilyGroup), time type (timeType), job type (workerSubType), country or location. Each item has title, req_id, location, posted_on, time_type, external_path and url.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• career_site_url string required — Career-board URL of a Workday-powered company, e.g. https://{tenant}.{dc}.myworkdayjobs.com/{site} (examples: "https://nvidia.wd5.myworkdayjobs.com/NVIDIAExternalCareerSite"; minLength: 1)
• count integer required — Max number of job postings to return (min: 1)
• search_text string nullable — Full-text keyword query (examples: "engineer", "data scientist")
• applied_facets object nullable — Facet filters as {facetParameter: [valueId, ...]}. Common facetParameters include jobFamilyGroup (job category), timeType (full/part time), workerSubType (job type), locationCountry, locationHierarchy1 and locations. Value ids are the ids exposed by the board's own facet list. (examples: {"timeType":["5509c0b5959810ac0029943377d47364"]})
  • * array

Response

• @type string (default: "WorkdayJobListing")
• req_id string nullable
• location string nullable
• posted_on string nullable
• time_type string nullable
• external_path string nullable
• url string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Career board not found or no matching postings Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.