/cake/companies

POST /api/cake/companies

Price: 10 credits

Get one company page on Cake (cake.me): description, mission, products, benefits, work environment, sector, headcount band, address and geo details, contact name, phone and email, website and social links, logo, cover and office photos, tech stack with usage level, FAQ, open jobs per profession, followers, page views, application read rate and activity dates

How to use it

Find aliases with cake/companies/search. The company's jobs are in cake/companies/jobs, its team in cake/companies/members and comparable employers in cake/companies/similar.

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: "tsmc", "https://www.cake.me/companies/tsmc")

Response

• @type string (default: "CakeCompany")
• alias string required
• url string required
• name string nullable
• legal_name string nullable
• description string nullable
• overview string nullable
• mission string nullable
• products_or_services string nullable
• work_environment string nullable
• employee_benefits string nullable
• media_coverage string nullable
• sector string nullable
• employee_count_range string nullable
• founded_year integer nullable
• capital string nullable
• tax_id string nullable
• address string nullable
• country_code string nullable
• formatted_address string nullable
• formatted_address_local string nullable
• street_address_local string nullable
• city string nullable
• city_local string nullable
• state string nullable
• state_local string nullable
• country_local string nullable
• postal_code string nullable
• contact_name string nullable
• contact_phone string nullable
• phone string nullable
• email string nullable
• recruiter_contact string nullable
• website_url string nullable
• recruiting_website_url string nullable
• youtube_url string nullable
• facebook_url string nullable
• linkedin_url string nullable
• instagram_url string nullable
• medium_url string nullable
• twitter_handle string nullable
• whatsapp_id string nullable
• image string nullable
• cover string nullable
• share_image string nullable
• images array (default: [])
• labels array (default: [])
• tech_labels array (default: [])
• tech_stack array (default: [])
  • @type string (default: "CakeTech")
  • name string required
  • usage_level string nullable
  • is_custom boolean nullable
• faq array (default: [])
  • @type string (default: "CakeFaqItem")
  • question string nullable
  • answer string nullable
  • created_at integer nullable
  • updated_at integer nullable
• profession_job_counts array (default: [])
  • @type string (default: "CakeProfessionCount")
  • profession string required
  • job_count integer nullable
• listed_job_count integer nullable
• follower_count integer nullable
• view_count integer nullable
• application_read_rate number nullable
• candidate_read_rate number nullable
• currency_code string nullable
• status string nullable
• is_featured boolean nullable
• created_at integer nullable
• updated_at integer nullable
• content_updated_at integer nullable
• published_at integer nullable
• last_active_at 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 — 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.