/internshala/companies

POST /api/internshala/companies

Price: 5 credits

Get one Internshala (internshala.com) company profile by URL or id: name, headquarters, logo, website, about text, hiring since, employee count, opportunities posted, candidates hired, industries, a preview of open internships and jobs, salaries by role and perks

How to use it

Pass company_id from internshala/internships or internshala/jobs. openings is a preview; internshala/companies/openings lists every open internship and job.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Internshala company URL or id (examples: "https://internshala.com/company/upgrad-learnings-private-limited-1788944144/", "upgrad-learnings-private-limited-1788944144"; minLength: 1; maxLength: 300)

Response

• @type string (default: "InternshalaCompany")
• id string required
• url string required
• name string nullable
• headquarters string nullable
• image string nullable
• website string nullable
• about string nullable
• hiring_since_year integer nullable
• employee_count string nullable
• opportunities_posted integer nullable
• candidates_hired integer nullable
• location string nullable
• industries array (default: [])
• openings array (default: [])
  • @type string (default: "InternshalaCompanyOpeningPreview")
  • url string required
  • alias string nullable
  • kind string nullable
  • is_actively_hiring boolean nullable
  • location string nullable
  • salary string nullable
  • duration string nullable
  • label string nullable
  • posted_at integer nullable
• salaries array (default: [])
  • @type string (default: "InternshalaCompanySalary")
  • salary string nullable
• perks array (default: [])

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 — Internshala has no company under that URL 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.