/jobtalk/companies/search

POST /api/jobtalk/companies/search

Price: 1 credit

Search Japanese companies on Jobtalk (転職会議) by name, head-office prefecture and industry: overall and per-category ratings, review count, the latest review, website, logo, industry and location

How to use it

Results are ordered by review count, most reviewed first. Pass a returned id to jobtalk/companies for the full profile, or to jobtalk/companies/reviews, jobtalk/companies/interviews and jobtalk/companies/salaries.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string nullable — Company name or keyword (examples: "トヨタ", "ソニー"; minLength: 1)
• prefecture_id integer nullable — Prefecture of the head office, JIS prefecture code (examples: 13, 23; min: 1; max: 47)
• industry_id integer nullable — Jobtalk industry id (examples: 18, 4; min: 1; max: 63)
• include_bankrupt boolean — Also return bankrupt and dissolved companies (default: false)
• include_without_reviews boolean — Also return companies that have no reviews yet (default: false)
• count integer required — Max number of results (min: 1; max: 2000)

Response

• @type string (default: "JobtalkCompanySearchResult")
• id string required
• url string required
• name string required
• former_name string nullable
• common_name string nullable
• rating number nullable
• category_ratings array (default: [])
  • @type string (default: "JobtalkCategoryRating")
  • category string required
  • rating number nullable
  • review_count integer nullable
  • company_count integer nullable
• review_count integer nullable
• latest_review string nullable
• website string nullable
• image string nullable
• industry_id string nullable
• industry string nullable
• prefecture_id string nullable
• prefecture string nullable
• city string nullable
• status string nullable
• is_bankrupt boolean 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 — 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.