/breezyhr/jobs/questions

POST /api/breezyhr/jobs/questions

Price: 5 credits

Get the company-authored application questions of one BreezyHR posting, grouped into the sections the board presents them in. Each question carries its prompt, an optional HTML and plain-text explanatory body, its answer type, whether it is required, and the choices offered for multiple-choice questions.

How to use it

Covers only the questions the company wrote itself. Most postings have none and answer with an empty list — that means the application asks nothing beyond BreezyHR's standard name, contact and resume fields, which this endpoint does not return. An empty list is therefore an answer, not a failure; a posting that does not exist on the board is a 412 instead.

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 board handle from the career-page URL ({company}.breezy.hr) (examples: "recruiting", "ablefy", "breezy"; minLength: 1)
• posting_id string required — Job posting identifier. Accepts a bare posting id, the id-slug form, or a full posting URL (examples: "9f0d48bae2ef", "9f0d48bae2ef-senior-data-engineer", "https://recruiting.breezy.hr/p/9f0d48bae2ef"; minLength: 1)

Response

• @type string (default: "BreezyhrQuestionSection")
• id string nullable
• company string required
• posting_id string required
• section_title string nullable
• description string nullable
• questions array (default: [])
  • @type string (default: "BreezyhrQuestion")
  • id string nullable
  • text string nullable
  • body string nullable
  • body_plain string nullable
  • question_type string nullable
  • question_type_name string nullable
  • is_required boolean nullable
  • options array (default: [])
    • @type string (default: "BreezyhrQuestionOption")
    • text 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 board not found, or the posting is closed or unknown on that board 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.