/bamboohr/jobs/search

POST /api/bamboohr/jobs/search

Price: 1 credit

List the open job postings of one company's BambooHR careers page by board handle. Each row carries the job id, title, careers URL, department, the employment status the company typed, the workplace type, the city and state, and the company block with its name, logo and careers URL.

How to use it

Lists one company's board — BambooHR has no cross-company search, so the handle must already be known. The board has no filters: there is no keyword, location or department parameter, and count only trims the rows. A handle that is not a BambooHR customer is a 412, while a customer with nothing open is an empty list. employment_status is free text the company typed, so it varies in spelling between boards and cannot be matched exactly; workplace_type is the normalised in_office / remote / hybrid signal. Rows carry no description — call bamboohr/jobs with the id for it.

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)
• count integer required — Max number of job postings to return (min: 1; max: 1000)

Response

• @type string (default: "BamboohrJobSummary")
• id string required
• company string required
• job_title string nullable
• url string nullable
• department string nullable
• department_id string nullable
• employment_status 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
• company_info object nullable
  • @type string (default: "BamboohrCompany")
  • id string nullable
  • name string nullable
  • alias string nullable
  • image string nullable
  • share_image string nullable
  • careers_url string nullable
  • is_trial boolean 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 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.