/forkwell/jobs/search

POST /api/forkwell/jobs/search

Price: 5 credits

Search software engineering jobs on Forkwell Jobs (jobs.forkwell.com), the Japanese job board for engineers, by keyword, job role, employment type, job feature and salary. Each result carries the title, company, skills, employment types, role, location, annual salary or hourly rate range and features.

How to use it

Sort by newest to list every matching job; the popularity order reaches fewer jobs than newest. Pass a result's id to forkwell/jobs for the full posting, or its company.id to forkwell/companies.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of jobs to return (min: 1)
• keyword string nullable — Search words (examples: "Rails", "機械学習"; minLength: 1)
• professions array nullable — Job roles, any of (one of: "web_application_engineer", "frontend_engineer", "backend_engineer", "infrastructure_engineer", "site_reliability_engineer", "platform_engineer", "ios_engineer", "android_engineer", "cross_platform_mobile_engineer", "desktop_app_engineer", "design_engineer", "product_manager", "project_manager", "tech_lead", "engineering_manager", "cto", "architect", "data_scientist_analyst", "data_engineer", "ml_ai_engineer", "research_engineer", "corporate_it", "consultant_presales", "security_engineer", "qa_engineer", "support_engineer", "hardware_engineer", "devrel")
• employment_types array nullable — Employment types, any of (one of: "full_time", "contract", "intern", "other")
• features array nullable — Job features, all of (one of: "partly_remote", "start_as_side_job", "fully_remote", "new_language_ok", "online_interview", "side_jobs_allowed", "one_or_two_days_a_week", "three_to_five_days_a_week", "code_review_culture", "agile", "sier_welcome", "own_services", "b2b_services", "b2c_services", "outside_tokyo", "has_cto", "premium_chairs", "bootcamp_graduates_welcome")
• salary_min integer nullable — Minimum lower bound of the annual salary in JPY (examples: 6000000; min: 1)
• salary_min_from_5m boolean — Only jobs whose annual salary starts at 5,000,000 JPY or more (default: false)
• salary_max_from_10m boolean — Only jobs whose annual salary reaches 10,000,000 JPY or more (default: false)
• sort string — Result order (default: "popularity"; one of: "popularity", "newest", "salary_max", "salary_min")

Response

• @type string (default: "ForkwellJobCard")
• 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
• image string nullable
• skill_names array (default: [])
• employment_types array (default: [])
• profession string nullable
• location string nullable
• feature_names array (default: [])
• is_closed boolean nullable
• company object required
  • @type string (default: "ForkwellCompanyRef")
  • id string required
  • url string required
  • name string nullable
  • image string nullable

Errors

• 422 — An unknown enum value 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 — The entity was not found, or a precondition failed 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.