/openwork/jobs

POST /api/openwork/jobs

Price: 5 credits

Get one job posting from the OpenWork (openwork.jp) job board: title, job category, the full job description and requirements, salary, locations, working hours, holidays, benefits and other terms, the posting date, the recruiting agent for agent jobs, and the employer with its employee score and introduction.

How to use it

Job URLs come from openwork/jobs/search and openwork/companies/jobs.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• job string required — Job URL (examples: "https://www.openwork.jp/a0C1000000s1nIR/recruit?j=ef04ebc959885bb0", "https://www.openwork.jp/a0910000000G2Ox/recruit_agent?j=b3b53060be18eb42da")

Response

• @type string (default: "OpenworkJob")
• id string required
• url string required
• position string nullable
• job_category string nullable
• labels array (default: [])
• description string nullable
• requirements string nullable
• salary_text string nullable
• salary_min number nullable
• salary_max number nullable
• salary_currency string nullable
• salary_period string nullable
• location_text string nullable
• regions array (default: [])
• employment_type string nullable
• published_date integer nullable
• is_agent boolean required
• details array (default: [])
  • @type string (default: "OpenworkInfoItem")
  • name string required
  • value string nullable
  • note string nullable
• agent object nullable
  • @type string (default: "OpenworkAgent")
  • name string required
  • url string nullable
  • license_number string nullable
  • licensed_year integer nullable
• company object required
  • @type string (default: "OpenworkJobEmployer")
  • id string required
  • url string required
  • name string nullable
  • image string nullable
  • description string nullable
  • website_url string nullable
  • score number nullable
  • review_count integer nullable
• intro_sections array (default: [])
  • @type string (default: "OpenworkIntroSection")
  • headline string nullable
  • text string nullable
  • image 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 — No job under that URL 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.