POST /api/jazzhr/companies/search
Price: 20 credits
List the company career boards JazzHR publishes for search-engine indexing: the board handle, the board URL and how many job postings the publication lists for it, optionally narrowed to handles containing a given text.
The only way to discover a JazzHR board handle — JazzHR publishes no directory and the other endpoints all require the handle already. query matches the handle, not the company's display name, so a trading name often will not match while a shortened one will. published_jobs is what the publication lists, which trails the live board by about a day, so use jazzhr/jobs/search for the current board. The publication comes in several files and an answer that could read only some of them still returns 200, carrying an X-Warning that names how many were missed: the directory is then short and published_jobs undercounted, so a handle absent from such an answer is not evidence the board does not exist.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)count integer required — Max number of company boards to return (min: 1; max: 5000)query string nullable — Keep only board handles containing this text (examples: "health", "chiropractic", "ilsos"; minLength: 1)@type string (default: "JazzhrCompany")company string requiredboard_url string nullablepublished_jobs integer nullable422 — 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 — The company publication could not be read 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.X-Error — Error message text (present only on error)X-Request-ID — Unique request identifierX-Execution-Time — Execution time in secondsX-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.