/forkwell/companies

POST /api/forkwell/companies

Price: 1 credit

Get one company on Forkwell Jobs (jobs.forkwell.com): name, logo, website and social links, offices with coordinates, company articles, engineers' published writing, answers to engineering questions, and its open jobs.

How to use it

The company id is the name in its URL, as returned in company.id by forkwell/jobs/search and forkwell/jobs. Pass a job id to forkwell/jobs for the full posting.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Company id or URL (examples: "nintendo-systems", "https://jobs.forkwell.com/nintendo-systems"; minLength: 1)

Response

• @type string (default: "ForkwellCompany")
• id string required
• numeric_id string nullable
• url string required
• name string nullable
• english_name string nullable
• image string nullable
• cover_image string nullable
• website string nullable
• twitter_url string nullable
• facebook_url string nullable
• linkedin_url string nullable
• offices array (default: [])
  • @type string (default: "ForkwellOffice")
  • id string nullable
  • address string required
  • latitude number nullable
  • longitude number nullable
  • map_url string nullable
• articles array (default: [])
  • @type string (default: "ForkwellArticle")
  • id string nullable
  • text string nullable
• authorships array (default: [])
  • @type string (default: "ForkwellAuthorship")
  • id string nullable
  • url string nullable
  • image string nullable
• answers array (default: [])
  • @type string (default: "ForkwellAnswer")
  • id string nullable
  • question_id string nullable
  • question string nullable
  • question_background string nullable
  • question_tags array (default: [])
  • answerer_position string nullable
  • text string nullable
  • published_at integer nullable
• open_job_count integer nullable
• jobs array (default: [])
  • @type string (default: "ForkwellCompanyJob")
  • id string required
  • url string required
  • image string nullable
  • profession string nullable
  • employment_types array (default: [])
  • company_id string required

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 — No company under that 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.