/inhersight/companies

POST /api/inhersight/companies

Price: 5 credits

Get InHerSight (inhersight.com) company employer profile by alias, id or profile URL

How to use it

Get the full InHerSight (inhersight.com) employer profile of a company by alias (URL segment like 'aro-homes'), numeric id, or profile URL. Returns the overall InHerSight composite score, industry, headquarters, size, employee range, rating count, company website, stock ticker (for public companies), and — for employer partners — branding with headline, description and social links. Resolve the alias first via /inhersight/companies/search if you only have the company name. Passing the numeric id avoids an extra lookup.

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 alias (the URL segment, e.g. 'aro-homes'), numeric company id, or a full company profile URL. Resolve the alias via /inhersight/companies/search if you only have the name. (examples: "aro-homes", "297729", "https://www.inhersight.com/company/aro-homes"; minLength: 1; pattern: ^(?:https?://[^\s]+|[A-Za-z0-9][A-Za-z0-9._-]*)$)

Response

• @type string (default: "InhersightCompany")
• id integer required
• alias string required
• name string required
• url string required
• composite_score number nullable
• website string nullable
• ticker string nullable
• industry string nullable
• industry_group string nullable
• headquarters string nullable
• other_locations array (default: [])
• is_fully_remote boolean nullable
• employee_range string nullable
• size string nullable
• company_type string nullable
• image string nullable
• uuid string nullable
• is_valid boolean nullable
• is_top_company boolean nullable
• rating_count integer nullable
• participant_count integer nullable
• description string nullable
• has_indeed_jobs boolean nullable
• branding object nullable
  • @type string (default: "InhersightEmployerBranding")
  • employer_id integer required
  • has_branding boolean nullable
  • has_enhanced_branding boolean nullable
  • headline string nullable
  • description string nullable
  • website string nullable
  • banner string nullable
  • twitter string nullable
  • facebook string nullable
  • linkedin string nullable
  • instagram string nullable
  • pinterest string nullable
  • youtube string nullable
  • github 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 — Company not found 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.