/bamboohr/jobs

POST /api/bamboohr/jobs

Price: 1 credit

Get one job posting from a company's BambooHR careers page by board handle and job id (or a full careers URL): title, the full HTML and plain-text description, the posted date, the opening's status, department, the employment status and minimum experience the company typed, the compensation line when published, the workplace type, and the city, state, postal code and country.

How to use it

Job ids are small per-company integers, so identity is the pair (company, job_id) and a bare id means nothing on its own — the same id under a different handle is a 412 rather than another company's job. job_id also accepts the full careers URL, and the company is then taken from it. compensation is free text a company may leave blank, and minimum_experience is the company's own wording, so neither is comparable across boards.

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: "BamboohrJob")
• id string required
• company string required
• job_title string nullable
• url string nullable
• posted_at integer nullable
• status string nullable
• department string nullable
• department_id string nullable
• employment_status string nullable
• minimum_experience string nullable
• compensation string nullable
• job_category_id string nullable
• workplace_type string nullable
• workplace_type_id string nullable
• location object nullable
  • @type string (default: "BamboohrLocation")
  • city string nullable
  • state string nullable
  • postal_code string nullable
  • country string nullable
• description string nullable
• description_plain 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.