/yourator/companies

POST /api/yourator/companies

Price: 5 credits

Get one company profile on Yourator (yourator.co): about text, mission, story, short description, city, address, employee count, capital, industry tags, statutory and other benefits, website, social links, media coverage, articles about the company, and logo

How to use it

Find aliases with yourator/companies/search; the company's open jobs are in yourator/companies/jobs.

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 alias or URL (examples: "Pacston", "https://www.yourator.co/companies/Pacston")

Response

• @type string (default: "YouratorCompany")
• alias string required
• url string required
• name string nullable
• short_description string nullable
• description string nullable
• mission string nullable
• story string nullable
• area_code string nullable
• location string nullable
• address string nullable
• city string nullable
• country_code string nullable
• employee_count integer nullable
• capital string nullable
• tags array (default: [])
• statutory_benefits array (default: [])
• benefits string nullable
• website_url string nullable
• social_links array (default: [])
• links array (default: [])
• media_coverage array (default: [])
  • @type string (default: "YouratorMediaLink")
  • url string required
• articles array (default: [])
  • @type string (default: "YouratorArticle")
  • url string required
  • summary string nullable
  • image string nullable
  • published_date integer nullable
• image string 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 — No company under that alias 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.