/cutshort/companies

POST /api/cutshort/companies

Price: 10 credits

Get a Cutshort company profile by alias, id or URL: description, type, size, stage, founding year, funding, tech team size, typical developer salary, domains, links, tech stack, photos, FAQs, products, recruiters, open job count and similar companies

How to use it

Company aliases come from cutshort/jobs/search, cutshort/jobs and cutshort/companies/search. The company's open jobs are cutshort/companies/jobs with the same alias.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Cutshort company alias, id or company URL (examples: "metadomeai-19-1XL4kYPm", "64784e08d856360027692066", "https://cutshort.io/company/ekloud-inc-67-ISfPFEWf"; minLength: 1)

Response

• @type string (default: "CutshortCompany")
• id string required
• alias string nullable
• name string nullable
• url string nullable
• description string nullable
• image string nullable
• cover string nullable
• founded_year integer nullable
• type string nullable
• type_code string nullable
• size string nullable
• size_code string nullable
• stage string nullable
• stage_code string nullable
• funding_raised string nullable
• tech_team_size string nullable
• expected_dev_hires string nullable
• typical_dev_salary_currency string nullable
• typical_dev_salary_min number nullable
• typical_dev_salary_max number nullable
• domains array (default: [])
• location_preferences array (default: [])
• followers_count integer nullable
• job_count integer nullable
• is_recruitment_agency boolean nullable
• links array (default: [])
  • @type string (default: "CutshortLink")
  • name string nullable
  • url string nullable
• video_url string nullable
• images array (default: [])
• tech_stack array (default: [])
• faqs array (default: [])
  • @type string (default: "CutshortFaq")
  • question string nullable
  • answer string nullable
• products array (default: [])
  • @type string (default: "CutshortProduct")
  • name string nullable
  • description string nullable
  • url string nullable
  • image string nullable
• team_members array (default: [])
  • @type string (default: "CutshortPerson")
  • id string nullable
  • name string nullable
  • headline string nullable
  • image string nullable
  • linkedin_url string nullable
• recruiters array (default: [])
  • @type string (default: "CutshortPerson")
  • id string nullable
  • name string nullable
  • headline string nullable
  • image string nullable
  • linkedin_url string nullable
• similar_companies array (default: [])
  • @type string (default: "CutshortCompanySummary")
  • id string nullable
  • alias string nullable
  • name string nullable
  • url string nullable
  • image string nullable
  • cover string nullable
  • website_url string nullable
  • founded_year integer nullable
  • type string nullable
  • size string nullable
  • stage string nullable
  • description string nullable
  • job_count integer 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 — Cutshort has no company under that alias or id 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.