/bamboohr/jobs/questions

POST /api/bamboohr/jobs/questions

Price: 1 credit

Get the application form of one BambooHR job: every field an applicant must fill in, in the order the form presents them. Each entry carries its key, the label the company shows, whether it is required, whether it is a question the company wrote itself, its answer type for those, whether it offers a free-text alternative, and the choices offered for fields answered from a list.

How to use it

Returns the standard BambooHR fields and the company's own questions in one list — read is_custom to tell them apart, since only the custom ones differ between jobs. A company that added no questions of its own still returns the standard fields, so an is_custom=true entry is never guaranteed. The equal opportunity fields appear only where the company enabled them, and the country and state choices are BambooHR's own reference lists rather than anything the company chose.

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 careers URL ({company}.bamboohr.com/careers) (examples: "sealevelinc", "pinnacle", "demo"; minLength: 1)
• job_id string required — Job identifier. Accepts a bare numeric id or a full careers URL (examples: "24", "1", "https://sealevelinc.bamboohr.com/careers/24"; minLength: 1)

Response

• @type string (default: "BamboohrApplicationField")
• key string required
• company string required
• job_id string required
• label string nullable
• field_type string nullable
• is_required boolean nullable
• is_custom boolean (default: false)
• allows_other boolean nullable
• options array (default: [])
  • @type string (default: "BamboohrFieldOption")
  • id string nullable
  • 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 careers page not found, or the job 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.