/hellowork/jobs

POST /api/hellowork/jobs

Price: 10 credits

Get one job posting from Hello Work (ハローワーク), Japan's public job board, by job number: employer, office and corporate numbers, address, job title and duties, employment type and period, work location with map coordinates, wage breakdown, working hours, holidays, insurance, company profile, selection process, contact phone, notes and every other labelled field of the posting

How to use it

Job numbers come from hellowork/jobs/search. Fields the posting template carries beyond the named ones are in other_fields with their section and label.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• job string required — Hello Work job number (求人番号) or job URL (examples: "03060-05156761", "0306005156761", "https://www.hellowork.mhlw.go.jp/kensaku/GECA110010.do?screenId=GECA110010&action=dispDetailBtn&kJNo=0306005156761&kJKbn=1"; minLength: 1)

Response

• @type string (default: "HelloworkJob")
• id string required
• number string required
• url string required
• category_label string nullable
• received_at integer nullable
• referral_deadline_at integer nullable
• hello_work_office string nullable
• industry string nullable
• online_application string nullable
• company_name string nullable
• company_name_kana string nullable
• has_employer_images boolean required
• office_number string nullable
• corporate_number string nullable
• company_postal_code string nullable
• company_address string nullable
• job_description string nullable
• employment_type string nullable
• employment_period string nullable
• work_postal_code string nullable
• work_address string nullable
• latitude number nullable
• longitude number nullable
• wage string nullable
• base_wage string nullable
• wage_type string nullable
• working_hours array (default: [])
• annual_holidays integer nullable
• insurance string nullable
• employees_total integer nullable
• employees_at_workplace integer nullable
• founded string nullable
• capital string nullable
• business_description string nullable
• company_features string nullable
• representative_title string nullable
• representative string nullable
• openings integer nullable
• selection_method string nullable
• contact_phone string nullable
• special_notes string nullable
• employer_message string nullable
• tags array (default: [])
• pr_logos array (default: [])
• job_sheet_url string required
• other_fields array (default: [])
  • @type string (default: "HelloworkField")
  • section string nullable
  • label string nullable
  • sublabel string nullable
  • code string nullable
  • value string required

Errors

• 422 — job is not a Hello Work job number 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 open job posting under that number 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.