/townwork/jobs

POST /api/townwork/jobs

Price: 20 credits

Get one job posting from townwork (タウンワーク): title, catch line, employer and office with address, phone, business and website, employment types, occupation, photos, duties, requirements, work location with coordinates and access, hours, pay text and structured pay, pay details, holidays, probation, benefits, workplace description, condition tags, typical age ranges and workplace atmosphere scales

How to use it

Job keys come from townwork/jobs/search or townwork/companies/jobs. company_id opens the employer on townwork/companies.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• job string required — townwork job key or job URL (examples: "55171ba95e519192", "https://townwork.net/viewjob/jobid_55171ba95e519192/"; minLength: 1)

Response

• @type string (default: "TownworkJob")
• id string required
• url string required
• subtitle string nullable
• company_id string nullable
• company_url string nullable
• company_name string nullable
• office_name string nullable
• office_address string nullable
• employer_name string nullable
• employer_address string nullable
• ceo_name string nullable
• phone_number string nullable
• phone_type string nullable
• business string nullable
• industry string nullable
• website string nullable
• is_new boolean nullable
• published_at integer nullable
• employment_types array (default: [])
• occupation string nullable
• images array (default: [])
• employer_message string nullable
• description string nullable
• qualifications string nullable
• work_location string nullable
• access string nullable
• address string nullable
• latitude number nullable
• longitude number nullable
• is_remote boolean nullable
• work_style string nullable
• work_hours string nullable
• shift string nullable
• salary string nullable
• task_salary string nullable
• base_pay object nullable
  • @type string (default: "TownworkPay")
  • min number nullable
  • max number nullable
  • unit string nullable
  • currency string nullable
  • task_minutes integer nullable
• task_pay object nullable
  • @type string (default: "TownworkPay")
  • min number nullable
  • max number nullable
  • unit string nullable
  • currency string nullable
  • task_minutes integer nullable
• salary_details string nullable
• salary_example string nullable
• holidays string nullable
• probation string nullable
• insurance string nullable
• benefits string nullable
• work_environment string nullable
• position_count string nullable
• other string nullable
• how_to_apply string nullable
• tags array (default: [])
  • @type string (default: "TownworkTag")
  • label string required
  • is_highlight boolean nullable
• age_ranges array (default: [])
• workplace_scales array (default: [])
  • @type string (default: "TownworkScale")
  • left_label string nullable
  • right_label string nullable
  • leans_left boolean nullable

Errors

• 422 — job is not a townwork job key or URL 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 townwork job posting under that key 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.