Skip to main content
POST
/
api
/
comparably
/
companies
/
salaries
/comparably/companies/salaries
curl --request POST \
  --url https://api.anysite.io/api/comparably/companies/salaries \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "company": "<string>",
  "timeout": 300
}
'
[
  {
    "alias": "<string>",
    "url": "<string>",
    "@type": "@comparably_company_salary",
    "average_compensation": "<string>",
    "summary": "<string>",
    "record_count": 123,
    "departments": [],
    "roles": []
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
company
string
required

Company alias (URL segment like 'google') or a full company profile URL

Minimum string length: 1
Pattern: ^(?:https?://[^\s]+|[A-Za-z0-9][A-Za-z0-9._-]*)$
Examples:

"google"

"microsoft"

"https://www.comparably.com/companies/google"

​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

​
alias
string
required
​
url
string
required
​
@type
string
default:@comparably_company_salary
​
average_compensation
string | null
​
summary
string | null
​
record_count
integer | null
​
departments
ComparablyDepartmentSalary · object[]
​
roles
ComparablyRoleSalary · object[]