Skip to main content
POST
/
api
/
payscale
/
employers
/payscale/employers
curl --request POST \
  --url https://api.anysite.io/api/payscale/employers \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "employer": "<string>",
  "timeout": 300,
  "country": "US",
  "report_type": "Salary"
}
'
[
  {
    "@type": "@payscale_employer_report",
    "category": "<string>",
    "name": "<string>",
    "country": "<string>",
    "report_type": "<string>",
    "currency_code": "<string>",
    "last_updated": "<string>",
    "multi_dimensional": true,
    "refs": {
      "@type": "@payscale_refs",
      "url": "<string>",
      "default_url": "<string>",
      "parent_url": "<string>"
    },
    "narratives": {
      "@type": "@payscale_narratives",
      "description": "<string>",
      "summary_salary": "<string>",
      "summary_hourly": "<string>",
      "employer_pay": "<string>"
    },
    "compensation": {
      "@type": "@payscale_compensation",
      "salary": {
        "@type": "@payscale_compensation_block",
        "p10": 123,
        "p25": 123,
        "p50": 123,
        "p75": 123,
        "p90": 123,
        "profile_count": 123
      },
      "total": {
        "@type": "@payscale_compensation_block",
        "p10": 123,
        "p25": 123,
        "p50": 123,
        "p75": 123,
        "p90": 123,
        "profile_count": 123
      },
      "bonus": {
        "@type": "@payscale_compensation_block",
        "p10": 123,
        "p25": 123,
        "p50": 123,
        "p75": 123,
        "p90": 123,
        "profile_count": 123
      },
      "commission": {
        "@type": "@payscale_compensation_block",
        "p10": 123,
        "p25": 123,
        "p50": 123,
        "p75": 123,
        "p90": 123,
        "profile_count": 123
      },
      "hourly_rate": {
        "@type": "@payscale_compensation_block",
        "p10": 123,
        "p25": 123,
        "p50": 123,
        "p75": 123,
        "p90": 123,
        "profile_count": 123
      },
      "profit_sharing": {
        "@type": "@payscale_compensation_block",
        "p10": 123,
        "p25": 123,
        "p50": 123,
        "p75": 123,
        "p90": 123,
        "profile_count": 123
      }
    },
    "by_dimension": {},
    "ratings": [],
    "related": [],
    "occupational_details": {
      "@type": "@payscale_occupational_details",
      "name": "<string>",
      "url": "<string>",
      "occupational_category": "<string>",
      "skills": [],
      "description": "<string>",
      "sample_size": 123,
      "estimated_salary": []
    },
    "benefits": {
      "@type": "@payscale_benefits",
      "description": "<string>",
      "retirement_benefits": [],
      "health_benefits": []
    },
    "comparisons": {
      "@type": "@payscale_comparisons",
      "basis": {
        "@type": "@payscale_comparison_item",
        "name": "<string>",
        "link": "<string>",
        "satisfaction_rating": 123,
        "stress_rating": 123,
        "male_percentage": 123,
        "female_percentage": 123,
        "flexibility_rating": 123
      },
      "comparables": []
    },
    "locations": [],
    "location_count": 123,
    "fact_data": {
      "@type": "@payscale_employer_facts",
      "name": "<string>",
      "website": "<string>",
      "domain": "<string>",
      "abstract": "<string>",
      "image": "<string>",
      "industries": [],
      "synonyms": [],
      "founded_on": "<string>",
      "founded_year": 123,
      "num_employees_min": 123,
      "num_employees_max": 123,
      "organization_type": "<string>",
      "stock_exchange": "<string>",
      "wikipedia_url": "<string>",
      "geo": {
        "@type": "@payscale_employer_geo",
        "street": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>",
        "latitude": 123,
        "longitude": 123
      },
      "source": "<string>",
      "last_updated": "<string>"
    }
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
employer
string
required

Employer name or Payscale employer slug

Minimum string length: 1
Examples:

"Google, Inc."

"Microsoft_Corp"

"Amazon.com Inc"

timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
country
enum<string>
default:US

Country of the salary data

Available options:
US,
CA,
UK,
AU
report_type
enum<string>
default:Salary

Pay report type

Available options:
Salary,
HourlyRate

Response

Successful Response

@type
string
default:@payscale_employer_report
category
string | null
name
string | null
country
string | null
report_type
string | null
currency_code
string | null
last_updated
string | null
multi_dimensional
boolean | null
refs
PayscaleRefs · object
narratives
PayscaleNarratives · object
compensation
PayscaleCompensation · object
by_dimension
By Dimension · object
ratings
PayscaleRating · object[]
occupational_details
PayscaleOccupationalDetails · object
benefits
PayscaleBenefits · object
comparisons
PayscaleComparisons · object
locations
PayscaleEmployerLocation · object[]
location_count
integer | null
fact_data
PayscaleEmployerFacts · object