/breezyhr/jobs/search

POST /api/breezyhr/jobs/search

Price: 10 credits

List the open job postings of one company's BreezyHR career board by board handle. Each row carries the posting id, title, posting URL, publication date, employment type, department, the free-text salary the board publishes, the structured primary location and every additional location, and the company block.

How to use it

Lists one company's board — BreezyHR 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. Rows carry no description; call breezyhr/jobs with the id for it. An unknown handle is a 412, while a registered company with nothing open is an empty list. department and salary are published by fewer than a quarter of postings, so read their absence as the board not filling them in.

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

Response

• @type string (default: "BreezyhrJobSummary")
• id string required
• company string required
• alias string nullable
• job_title string nullable
• url string nullable
• published_at integer nullable
• employment_type string nullable
• employment_type_id string nullable
• department string nullable
• salary string nullable
• location object nullable
  • @type string (default: "BreezyhrLocation")
  • id string nullable
  • name string nullable
  • city string nullable
  • state string nullable
  • state_id string nullable
  • country string nullable
  • country_id string nullable
  • is_remote boolean nullable
  • is_primary boolean nullable
  • is_other_selected boolean nullable
  • remote_type string nullable
  • remote_label string nullable
  • street_address object nullable
    • @type string (default: "BreezyhrStreetAddress")
    • formatted string nullable
    • custom string nullable
    • is_other boolean nullable
    • latitude number nullable
    • longitude number nullable
    • components array (default: [])
      • @type string (default: "BreezyhrAddressComponent")
      • long_name string nullable
      • short_name string nullable
      • types array (default: [])
• locations array (default: [])
  • @type string (default: "BreezyhrLocation")
  • id string nullable
  • name string nullable
  • city string nullable
  • state string nullable
  • state_id string nullable
  • country string nullable
  • country_id string nullable
  • is_remote boolean nullable
  • is_primary boolean nullable
  • is_other_selected boolean nullable
  • remote_type string nullable
  • remote_label string nullable
  • street_address object nullable
    • @type string (default: "BreezyhrStreetAddress")
    • formatted string nullable
    • custom string nullable
    • is_other boolean nullable
    • latitude number nullable
    • longitude number nullable
    • components array (default: [])
• company_info object nullable
  • @type string (default: "BreezyhrCompany")
  • name string nullable
  • alias string nullable
  • image string nullable
  • has_multiple_locations 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 board 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.