/hellowork/jobs/search

POST /api/hellowork/jobs/search

Price: 10 credits

Search Hello Work (ハローワーク), Japan's public job board, newest first, by keywords, excluded keywords, posting category, full- or part-time and prefecture: job number, title, employer, received and referral deadline dates, location, duties, wage, hours, holidays, tags and openings

How to use it

Pass a returned number to hellowork/jobs for the full posting with every labelled field.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Free-text keywords separated by spaces (examples: "看護師"; minLength: 1; maxLength: 50)
• keyword_match string — Whether a posting must contain any or all of the keywords (default: "any"; one of: "any", "all")
• exclude_keyword string nullable — Keywords a posting must not contain (examples: "夜勤"; minLength: 1; maxLength: 50)
• job_category string — Hello Work posting category (default: "general"; one of: "general", "new_graduate", "seasonal", "migrant", "disability")
• working_styles array nullable — Full-time or part-time postings, for the general and disability categories (one of: "full_time", "part_time")
• prefecture string nullable — Prefecture of the workplace (one of: "hokkaido", "aomori", "iwate", "miyagi", "akita", "yamagata", "fukushima", "ibaraki", "tochigi", "gunma", "saitama", "chiba", "tokyo", "kanagawa", "niigata", "toyama", "ishikawa", "fukui", "yamanashi", "nagano", "gifu", "shizuoka", "aichi", "mie", "shiga", "kyoto", "osaka", "hyogo", "nara", "wakayama", "tottori", "shimane", "okayama", "hiroshima", "yamaguchi", "tokushima", "kagawa", "ehime", "kochi", "fukuoka", "saga", "nagasaki", "kumamoto", "oita", "miyazaki", "kagoshima", "okinawa", "overseas")
• count integer required — Max number of results (min: 1; max: 5000)

Response

• @type string (default: "HelloworkJobSearchResult")
• id string required
• number string required
• url string required
• company_name string nullable
• has_employer_images boolean required
• received_at integer nullable
• referral_deadline_at integer nullable
• is_new boolean required
• labels array (default: [])
• location string nullable
• occupation_code string nullable
• job_description string nullable
• work_location string nullable
• wage string nullable
• working_hours string nullable
• holidays string nullable
• disclosure string nullable
• tags array (default: [])
• openings integer nullable
• job_sheet_url string nullable
• 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 — 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 — Hello Work rejected the search conditions 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.