/breezyhr/jobs

POST /api/breezyhr/jobs

Price: 10 credits

Get one job posting from a company's BreezyHR career board by board handle and posting id (or a full posting URL): title, the full HTML and plain-text description, the board's publication date and the posting's original posted date, employment type, department, free-text salary and structured salary range, workplace type, applicant location requirement, the primary and additional locations, and the company block with its website.

How to use it

A posting is addressed by the pair (company, posting_id) — an id from another company's board is a 412, so never carry an id across boards. posting_id also accepts the id-slug form and the full posting URL, and the company is then taken from it. published_at and posted_at are different dates and must not be merged: posted_at is when the posting was first created and can be a year older than published_at, which is when the board last published it. salary is whatever free text the board typed, while salary_range is structured and only a few postings carry it. workplace_type reads remote on the postings BreezyHR flags as remote and is absent on the rest, which does not mean the job is on site — the board says nothing.

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: "BreezyhrJob")
• id string required
• company string required
• alias string nullable
• job_title string nullable
• url string nullable
• published_at integer nullable
• posted_at integer nullable
• employment_type string nullable
• employment_type_id string nullable
• department string nullable
• salary string nullable
• salary_range object nullable
  • @type string (default: "BreezyhrSalaryRange")
  • currency string nullable
  • min number nullable
  • max number nullable
  • unit string nullable
• description string nullable
• description_plain string nullable
• summary string nullable
• workplace_type string nullable
• applicant_location_requirement 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
• company_website 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.