/openwork/companies/jobs

POST /api/openwork/companies/jobs

Price: 10 credits

List the open jobs of one employer on the OpenWork (openwork.jp) job board, each with its salary, locations, employment type, a description teaser and the employer's employee score.

How to use it

Pass a job URL to openwork/jobs for the full posting.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Company id or URL (examples: "a0C1000000s1nIR", "https://www.openwork.jp/a0C1000000s1nIR/job/")
• count integer required — Max number of jobs to return (min: 1; max: 1000)
• sort string — Result order (default: "recommended"; one of: "recommended", "newest")

Response

• @type string (default: "OpenworkJobCard")
• id string required
• url string required
• job_number string nullable
• position string nullable
• job_category string nullable
• description string nullable
• salary_text string nullable
• salary_min number nullable
• salary_max number nullable
• salary_currency string nullable
• salary_period string nullable
• is_salary_hidden boolean nullable
• locations array (default: [])
• location_text string nullable
• work_area_text string nullable
• remote_work string nullable
• is_regular_employee boolean nullable
• is_contract_employee boolean nullable
• is_new_graduate boolean nullable
• is_direct_application boolean nullable
• is_agent boolean nullable
• application_count integer nullable
• image string nullable
• published_at integer nullable
• company object required
  • @type string (default: "OpenworkJobCompany")
  • id string required
  • url string required
  • company_number string nullable
  • name string nullable
  • name_detail string nullable
  • image string nullable
  • score number nullable
  • industry_name string nullable
  • description 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 company under that id 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.