/openwork/questions

POST /api/openwork/questions

Price: 5 credits

Get one question asked to employees of an employer on OpenWork (openwork.jp): title, full question text, the asker's situation, who the asker wants answers from, date, topic, and each answer's tenure, role, date and opening words, plus related questions on the same topic.

How to use it

Question URLs come from openwork/companies/questions. An answer marked is_excerpt carries only its opening words.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• question string required — Question URL (examples: "https://www.openwork.jp/asking/a0C1000000s1nIR/questions/16910")

Response

• @type string (default: "OpenworkQuestion")
• id string required
• url string required
• company_id string required
• company_name string nullable
• text string nullable
• asker_status string nullable
• wanted_respondents string nullable
• asked_date integer nullable
• tag string nullable
• tag_id string nullable
• answer_count integer nullable
• answers array (default: [])
  • @type string (default: "OpenworkAnswer")
  • id string required
  • tenure string nullable
  • role string nullable
  • excerpt string nullable
  • is_excerpt boolean nullable
  • answered_date integer nullable
• related_questions array (default: [])
  • @type string (default: "OpenworkRelatedQuestion")
  • id string required
  • url string required
  • answer_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 question under that URL 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.