/openwork/companies

POST /api/openwork/companies

Price: 10 credits

Get one employer on OpenWork (openwork.jp), the Japanese employee review site: overall and eight category scores from current and former employees, monthly overtime, paid-leave usage, average salary and age, review counts per category, highlight badges, follower count, company facts, workplace statistics, the company's own introduction and companies in the same industry.

How to use it

Company ids come from openwork/companies/search. Reviews, salaries, questions and jobs of the company are openwork/companies/reviews, openwork/companies/salaries, openwork/companies/questions and openwork/companies/jobs.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Company id or URL (examples: "a0C1000000s1nIR", "https://www.openwork.jp/company.php?m_id=a0C1000000s1nIR")

Response

• @type string (default: "OpenworkCompany")
• id string required
• url string required
• name string nullable
• image string nullable
• description string nullable
• is_official boolean nullable
• badges array (default: [])
• review_count integer nullable
• salary_review_count integer nullable
• question_count integer nullable
• job_count integer nullable
• score number nullable
• score_top_percent number nullable
• rating_count integer nullable
• respondent_count integer nullable
• compensation_score number nullable
• morale_score number nullable
• openness_score number nullable
• mutual_respect_score number nullable
• young_growth_score number nullable
• talent_development_score number nullable
• compliance_score number nullable
• evaluation_fairness_score number nullable
• overtime_hours number nullable
• paid_leave_rate number nullable
• average_salary number nullable
• salary_min number nullable
• salary_max number nullable
• salary_currency string nullable
• average_age number nullable
• salary_respondent_count integer nullable
• review_categories array (default: [])
  • @type string (default: "OpenworkReviewCategoryCount")
  • category string required (one of: "culture", "salary", "joining_reasons", "growth", "women", "work_life_balance", "leaving_reasons", "company_analysis", "advice_to_management")
  • name string nullable
  • review_count integer nullable
• industries array (default: [])
  • @type string (default: "OpenworkIndustryRef")
  • code string nullable
  • name string required
• website_url string nullable
• address string nullable
• employee_count_range string nullable
• founded_year integer nullable
• capital number nullable
• capital_text string nullable
• representative string nullable
• fiscal_year_end_month integer nullable
• stock_code string nullable
• stock_market string nullable
• listed_year integer nullable
• workplace_info array (default: [])
  • @type string (default: "OpenworkInfoItem")
  • name string required
  • value string nullable
  • note string nullable
• intro_sections array (default: [])
  • @type string (default: "OpenworkIntroSection")
  • headline string nullable
  • text string nullable
  • image string nullable
• similar_companies array (default: [])
  • @type string (default: "OpenworkSimilarCompany")
  • id string required
  • url string required
  • name string nullable
  • image string nullable
  • score number nullable
  • review_count integer nullable
  • job_count integer nullable
• highlights array (default: [])
• follower_count integer 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 company 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.