/instahyre/companies

POST /api/instahyre/companies

Price: 5 credits

Get one Instahyre (instahyre.com) company profile by id, slug or URL: name, tagline, founding year, employee count, industries, office locations, summary, why join, interview process, benefits, tech stack, social links, ratings, open job count by category and a preview of its open jobs

How to use it

Pass company.id from instahyre/jobs/search, or the slug from a jobs-at-<slug> URL. jobs is a preview; job_count is the full number of open jobs, listed by instahyre/jobs/search with companies set to the company name.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Instahyre company id, slug or URL (examples: "15332", "bazaarvoice", "https://www.instahyre.com/jobs-at-bazaarvoice/"; minLength: 1; maxLength: 200)

Response

• @type string (default: "InstahyreCompany")
• id string required
• url string required
• alias string nullable
• name string nullable
• tagline string nullable
• founded_year integer nullable
• employee_count integer nullable
• industry string nullable
• industries array (default: [])
• locations array (default: [])
• summary string nullable
• why_join string nullable
• interview_process string nullable
• benefits array (default: [])
• tech_stack array (default: [])
• tech_stack_description string nullable
• image string nullable
• video_url string nullable
• images array (default: [])
• media_mentions array (default: [])
  • @type string (default: "InstahyreMediaMention")
  • url string nullable
• website string nullable
• linkedin_url string nullable
• facebook_url string nullable
• twitter_url string nullable
• instagram_url string nullable
• android_app_url string nullable
• ios_app_url string nullable
• ratings object nullable
  • @type string (default: "InstahyreRatings")
  • overall number nullable
  • culture_values number nullable
  • diversity_inclusion number nullable
  • work_life_balance number nullable
  • compensation_benefits number nullable
  • career_opportunities number nullable
  • recommendation number nullable
• is_featured boolean nullable
• is_diversity_employer boolean nullable
• job_count integer nullable
• job_categories array (default: [])
  • @type string (default: "InstahyreJobCategoryCount")
  • name string required
  • count integer nullable
• jobs array (default: [])
  • @type string (default: "InstahyreCompanyJob")
  • id string required
  • url string required
  • display_title string nullable
  • locations array (default: [])
  • description string nullable
  • experience_min_years integer nullable
  • experience_max_years integer nullable
  • is_internship 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 — Instahyre has no company under that id or slug 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.