/inhersight/companies/questions

POST /api/inhersight/companies/questions

Price: 1 credit

Get InHerSight (inhersight.com) yes/no workplace survey questions and vote breakdowns for a company

How to use it

Get InHerSight (inhersight.com) workplace survey questions for a company by alias, id or profile URL. Each question (e.g. about support for caregivers, dads' parental leave, fair starting pay) has its answer options with vote counts and percentages, plus the rating group it belongs to.

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._-]*)$)
• count integer required — Max number of survey questions to return (min: 1)

Response

• @type string (default: "InhersightQuestion")
• id integer required
• uuid string nullable
• question string required
• rating_group_slug string nullable
• rating_group_name string nullable
• response_count integer nullable
• vote_count integer nullable
• created_at integer nullable
• options array (default: [])
  • @type string (default: "InhersightQuestionOption")
  • id integer nullable
  • text string required
  • order integer nullable
  • is_primary boolean nullable
  • vote_count integer nullable
  • percentage number 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.