/greenhouse/jobs/search

POST /api/greenhouse/jobs/search

Price: 10 credits

List all open job postings from a company's Greenhouse job board by board token: title, location, company, requisition id, departments and offices, metadata and posting dates. Set content to also include each job's full description, and pay_transparency to also include its published pay ranges.

How to use it

List the open jobs of a specific company's Greenhouse board. board_token is the company slug from its career board URL (e.g. stripe); count is how many jobs to return; set content=true to include each job's full description. Each item has id, title, location, url, company_name, requisition_id, metadata, updated_at and first_published_at. Pay ranges arrive only when pay_transparency=true, so an empty pay_ranges without that flag means it was not requested, not that the company published no pay. A job can carry several ranges, one per geographic pay zone; min_cents and max_cents are minor currency units of currency_type, and nothing in the response states the pay basis — the range's title usually does not name it, and one identical title carries an hourly rate on one job and an annual salary on another. Most ranges are annual and a few thousand USD cents is an hourly rate, so judge by magnitude against the currency and, where that leaves it open, hand the figure to the user without calling it a salary.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• board_token string required — Company job board token (the company slug from its Greenhouse career board URL) (examples: "stripe", "coinbase", "airbnb"; minLength: 1)
• count integer required — Max number of jobs to return (min: 1)
• content boolean — Include the full job description for every job in the result (default: false)
• pay_transparency boolean — Include the published pay ranges (pay_ranges) for every job in the result. Jobs the company has not published a range for come back with an empty list (default: false)

Response

• @type string (default: "GreenhouseJob")
• id integer required
• location string nullable
• url string nullable
• company_name string nullable
• language string nullable
• requisition_id string nullable
• internal_job_id integer nullable
• description string nullable
• updated_at string nullable
• first_published_at string nullable
• education string nullable
• employment string nullable
• departments array (default: [])
  • @type string (default: "GreenhouseDepartmentRef")
  • id integer required
  • name string nullable
  • parent_id integer nullable
  • child_ids array (default: [])
• offices array (default: [])
  • @type string (default: "GreenhouseOfficeRef")
  • id integer required
  • name string nullable
  • location string nullable
  • parent_id integer nullable
  • child_ids array (default: [])
• questions array (default: [])
  • @type string (default: "GreenhouseQuestion")
  • label string nullable
  • description string nullable
  • required boolean nullable
  • fields array (default: [])
    • @type string (default: "GreenhouseQuestionField")
    • name string nullable
    • type string nullable
    • values array (default: [])
• location_questions array (default: [])
  • @type string (default: "GreenhouseQuestion")
  • label string nullable
  • description string nullable
  • required boolean nullable
  • fields array (default: [])
    • @type string (default: "GreenhouseQuestionField")
    • name string nullable
    • type string nullable
    • values array (default: [])
• demographic_questions object nullable
  • @type string (default: "GreenhouseDemographicQuestions")
  • header string nullable
  • description string nullable
  • questions array (default: [])
    • @type string (default: "GreenhouseDemographicQuestion")
    • id integer nullable
    • label string nullable
    • type string nullable
    • required boolean nullable
    • answer_options array (default: [])
• compliance array (default: [])
  • @type string (default: "GreenhouseCompliance")
  • type string nullable
  • description string nullable
  • questions array (default: [])
    • @type string (default: "GreenhouseQuestion")
    • label string nullable
    • description string nullable
    • required boolean nullable
    • fields array (default: [])
• metadata array (default: [])
  • @type string (default: "GreenhouseJobMetadata")
  • id integer nullable
  • name string nullable
  • value any
  • value_type string nullable
• data_compliance array (default: [])
  • @type string (default: "GreenhouseDataCompliance")
  • type string nullable
  • requires_consent boolean nullable
  • requires_processing_consent boolean nullable
  • requires_retention_consent boolean nullable
  • retention_period integer nullable
• pay_ranges array (default: [])
  • @type string (default: "GreenhousePayRange")
  • min_cents integer nullable
  • max_cents integer nullable
  • currency_type string nullable
  • blurb 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 — Board token does not exist 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.