Skip to main content
POST
/comparably/companies

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
company
string
required
Minimum string length: 1
Pattern: ^(?:https?://[^\s]+|[A-Za-z0-9][A-Za-z0-9._-]*)$
timeout
integer
default:300
Required range: 20 <= x <= 1500

Response

Successful Response

id
integer
required
alias
string
required
name
string
required
url
string
required
@type
string
default:ComparablyCompany
mission
string | null
website
string | null
image
string | null
cover
string | null
phone
string | null
address
string | null
revenue
integer | null
grade
string | null
grade_score
string | null
score
integer | null
metro
string | null
metro_grade
string | null
metro_grade_score
string | null
participant_count
integer | null
rating_count
integer | null
award_count
integer | null
is_claimed
boolean | null
is_premium
boolean | null
last_modified_date
string | null
owner
object | null
star_rating
object | null
ceo
object | null
awards
object[]
top_dimensions
object[]
bottom_dimensions
object[]