/forkwell/jobs

POST /api/forkwell/jobs

Price: 5 credits

Get one job on Forkwell Jobs (jobs.forkwell.com): the full posting with service and product, required and preferred skills, ideal candidate, working conditions, benefits, annual salary and hourly rate ranges, role, employment types, location, features, the tech stack by category, the team environment, team gender composition and the hiring company. Closed postings are returned with status closed.

How to use it

Find job ids with forkwell/jobs/search or forkwell/companies/jobs; pass company.id to forkwell/companies for the company profile.

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 id or URL (examples: "36185", "https://jobs.forkwell.com/nintendo-systems/jobs/36185"; minLength: 1)

Response

• @type string (default: "ForkwellJob")
• salary_min number nullable
• salary_max number nullable
• hourly_rate_min number nullable
• hourly_rate_max number nullable
• salary_currency string nullable
• id string required
• url string required
• status string nullable
• service_and_product string nullable
• required_skills string nullable
• preferred_skills string nullable
• ideal_candidate string nullable
• message string nullable
• working_conditions string nullable
• benefits string nullable
• profession string nullable
• profession_alias string nullable
• employment_types array (default: [])
• location string nullable
• role_change_scope string nullable
• location_change_scope string nullable
• features array (default: [])
  • @type string (default: "ForkwellNamed")
  • id string nullable
  • alias string nullable
  • name string required
• salary_highlights array (default: [])
  • @type string (default: "ForkwellNamed")
  • id string nullable
  • alias string nullable
  • name string required
• skills array (default: [])
  • @type string (default: "ForkwellSkill")
  • id string required
  • name string required
  • display_name string nullable
  • category string nullable
  • hands_on boolean required
• environment array (default: [])
  • @type string (default: "ForkwellEnvironment")
  • category string required
  • points array (default: [])
• team_male_count integer nullable
• team_female_count integer nullable
• team_other_count integer nullable
• image string nullable
• images array (default: [])
  • @type string (default: "ForkwellImage")
  • url string required
  • thumbnail string nullable
  • width integer nullable
  • height integer nullable
• published_at integer nullable
• updated_at integer nullable
• closed_at integer nullable
• company object required
  • @type string (default: "ForkwellJobCompany")
  • id string required
  • url string required
  • name string nullable
  • image string nullable
  • numeric_id string nullable
  • employee_count integer nullable
  • engineer_count integer nullable
  • article_title string nullable
  • article 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 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.