/comparably/companies

POST /api/comparably/companies

Price: 1 credit

Get Comparably (comparably.com) company employer profile by alias or profile URL

How to use it

Get the full Comparably (comparably.com) employer profile of a company by alias (URL segment like 'google') or profile URL. Returns mission, website, phone, address, employee participant and rating counts, overall culture letter-grade and star-rating, CEO rating, awards, and the top/bottom culture dimensions with their letter grades. Resolve the alias first via /comparably/companies/search if you only have the company name.

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 (the URL segment, e.g. 'google') or a full company profile URL. The alias can be resolved via /comparably/companies/search. (examples: "google", "microsoft", "https://www.comparably.com/companies/google"; minLength: 1; pattern: ^(?:https?://[^\s]+|[A-Za-z0-9][A-Za-z0-9._-]*)$)

Response

• @type string (default: "ComparablyCompany")
• id integer required
• alias string required
• name string required
• url string required
• mission string nullable
• website string nullable
• image string nullable
• cover string nullable
• phone string nullable
• address string nullable
• revenue integer nullable
• grade string nullable
• grade_score string nullable
• score integer nullable
• metro string nullable
• metro_grade string nullable
• metro_grade_score string nullable
• participant_count integer nullable
• rating_count integer nullable
• award_count integer nullable
• is_claimed boolean nullable
• is_premium boolean nullable
• last_modified_date string nullable
• owner object nullable
  • @type string (default: "ComparablyCompanyOwner")
  • name string nullable
  • job_title string nullable
  • image string nullable
• star_rating object nullable
  • @type string (default: "ComparablyStarRating")
  • letter_grade string nullable
  • star_rating number nullable
  • participant_count integer nullable
  • is_choice_employer boolean nullable
• ceo object nullable
  • @type string (default: "ComparablyCeo")
  • name string nullable
  • score string nullable
  • total_score integer nullable
  • image string nullable
• awards array (default: [])
  • @type string (default: "ComparablyAward")
  • name string required
  • image string nullable
• top_dimensions array (default: [])
  • @type string (default: "ComparablyDimension")
  • category string required
  • grade string nullable
  • score string nullable
  • percent integer nullable
• bottom_dimensions array (default: [])
  • @type string (default: "ComparablyDimension")
  • category string required
  • grade string nullable
  • score string nullable
  • percent 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 — Company not found 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.