/incruit/companies/search

POST /api/incruit/companies/search

Price: 5 credits

Search Incruit (incruit.com) companies by name or keyword, among companies hiring now or all listed companies: id, name, CEO, industry, size, sales with year and rank, headcount, open job and follower counts, logo, address, top-1000 and listed flags

How to use it

Pass a returned id to incruit/companies for salary figures and headcount history.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Company name or keyword (examples: "삼성"; minLength: 1; maxLength: 50)
• count integer required — Max number of results (min: 1; max: 3000)
• scope string — Companies with open postings, or every listed company (default: "hiring"; one of: "hiring", "all")

Response

• @type string (default: "IncruitCompanySearchResult")
• id string required
• url string required
• cid string nullable
• name string nullable
• display_name string nullable
• ceo string nullable
• industry string nullable
• size string nullable
• sales number nullable
• sales_year integer nullable
• sales_rank integer nullable
• employee_count integer nullable
• open_job_count integer nullable
• follower_count integer nullable
• image string nullable
• address string nullable
• is_top1000 boolean nullable
• is_public 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 — The entity was not found, or a precondition failed 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.