/workable/jobs/search

POST /api/workable/jobs/search

Price: 1 credit

List and filter the job postings on a single company's Workable board

How to use it

List the open jobs on one company's Workable board (identified by its board handle), with optional filters for keyword, work type, remote-only, and location (country/region/city). Returns a list projection of each job — id, shortcode, title, employment type, workplace, department, location(s), language, state, and published date. Use the returned shortcode with the 'jobs' endpoint for the full description.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• account string required — Company board handle (the Workable subdomain, e.g. 'careers') (examples: "careers", "netguru"; minLength: 1)
• count integer required — Number of jobs to return (min: 1)
• query string — Keyword to match against job titles (default: "")
• worktype array — Filter by work type(s) (default: []; one of: "full", "part", "contract", "temporary"; examples: ["full"], ["contract"])
• is_remote boolean nullable — When true, only return jobs marked as remote
• location array — Filter by one or more locations (country / region / city) (default: []; examples: [{"country":"Greece"}])
  • country string nullable — Country name, e.g. 'Greece'
  • country_code string nullable — ISO country code, e.g. 'GR'
  • region string nullable — Region / state name
  • city string nullable — City name

Response

• @type string (default: "WorkableSearchJob")
• id integer required
• shortcode string required
• code string nullable
• employment_type string nullable
• is_remote boolean (default: false)
• workplace string nullable
• department array (default: [])
• language string nullable
• state string nullable
• published_at string nullable
• location object nullable
  • @type string (default: "WorkableJobLocation")
  • country string nullable
  • country_code string nullable
  • region string nullable
  • city string nullable
• locations array (default: [])
  • @type string (default: "WorkableJobLocation")
  • country string nullable
  • country_code string nullable
  • region string nullable
  • city string nullable
• web_url string (default: "")

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 — The entity was not found, or a precondition failed 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.