/payscale/employers

POST /api/payscale/employers

Price: 5 credits

Get the full Payscale salary report for an employer (company): pay percentiles (salary, total compensation, bonus, commission, hourly rate, profit sharing), pay by city, degree, gender, job and years of experience, employee satisfaction ratings, benefits, peer-company comparisons, office locations and company facts.

How to use it

Fetch one Payscale employer pay report by company name or slug. Set country (US/CA/UK/AU) and report_type (Salary or HourlyRate). Returns one item with name, compensation (salary/total/bonus/commission/hourly_rate/profit_sharing with p10-p90 and profile_count), by_dimension (pay by city/degree/gender/job/experience), ratings, related employers, benefits (retirement_benefits, health_benefits), comparisons (basis and comparables with satisfaction/stress/gender split), locations, location_count and fact_data (website, domain, industries, founded_on, geo, image, num_employees_min/max, organization_type).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• employer string required — Employer name or Payscale employer slug (examples: "Google, Inc.", "Microsoft_Corp", "Amazon.com Inc"; minLength: 1)
• country string — Country of the salary data (default: "US"; one of: "US", "CA", "UK", "AU")
• report_type string — Pay report type (default: "Salary"; one of: "Salary", "HourlyRate")

Response

• @type string (default: "PayscaleEmployerReport")
• category string nullable
• name string nullable
• country string nullable
• report_type string nullable
• currency_code string nullable
• last_updated string nullable
• multi_dimensional boolean nullable
• refs object nullable
  • @type string (default: "PayscaleRefs")
  • url string nullable
  • default_url string nullable
  • parent_url string nullable
• narratives object nullable
  • @type string (default: "PayscaleNarratives")
  • description string nullable
  • summary_salary string nullable
  • summary_hourly string nullable
  • employer_pay string nullable
• compensation object nullable
  • @type string (default: "PayscaleCompensation")
  • salary object nullable
    • @type string (default: "PayscaleCompensationBlock")
    • p10 number nullable
    • p25 number nullable
    • p50 number nullable
    • p75 number nullable
    • p90 number nullable
    • profile_count integer nullable
  • total object nullable
    • @type string (default: "PayscaleCompensationBlock")
    • p10 number nullable
    • p25 number nullable
    • p50 number nullable
    • p75 number nullable
    • p90 number nullable
    • profile_count integer nullable
  • bonus object nullable
    • @type string (default: "PayscaleCompensationBlock")
    • p10 number nullable
    • p25 number nullable
    • p50 number nullable
    • p75 number nullable
    • p90 number nullable
    • profile_count integer nullable
  • commission object nullable
    • @type string (default: "PayscaleCompensationBlock")
    • p10 number nullable
    • p25 number nullable
    • p50 number nullable
    • p75 number nullable
    • p90 number nullable
    • profile_count integer nullable
  • hourly_rate object nullable
    • @type string (default: "PayscaleCompensationBlock")
    • p10 number nullable
    • p25 number nullable
    • p50 number nullable
    • p75 number nullable
    • p90 number nullable
    • profile_count integer nullable
  • profit_sharing object nullable
    • @type string (default: "PayscaleCompensationBlock")
    • p10 number nullable
    • p25 number nullable
    • p50 number nullable
    • p75 number nullable
    • p90 number nullable
    • profile_count integer nullable
• by_dimension object (default: {})
  • * object
    • @type string (default: "PayscaleDimension")
    • description string nullable
    • profile_count integer nullable
    • last_updated string nullable
    • rows array (default: [])
      • @type string (default: "PayscaleDimensionRow")
      • name string nullable
      • display_name string nullable
      • url string nullable
      • profile_count integer nullable
      • range object nullable (see schema PayscalePercentiles)
      • is_estimated boolean nullable
• ratings array (default: [])
  • @type string (default: "PayscaleRating")
  • name string nullable
  • score number nullable
  • profile_count integer nullable
• related array (default: [])
  • @type string (default: "PayscaleRelated")
  • name string nullable
  • url string nullable
  • profile_count integer nullable
  • average number nullable
  • range object nullable
    • @type string (default: "PayscalePercentiles")
    • p10 number nullable
    • p25 number nullable
    • p50 number nullable
    • p75 number nullable
    • p90 number nullable
• occupational_details object nullable
  • @type string (default: "PayscaleOccupationalDetails")
  • name string nullable
  • url string nullable
  • occupational_category string nullable
  • skills array (default: [])
  • description string nullable
  • sample_size integer nullable
  • estimated_salary array (default: [])
    • @type string (default: "PayscaleEstimatedSalary")
    • name string nullable
    • currency string nullable
    • duration string nullable
    • median string nullable
    • percentile10 string nullable
    • percentile25 string nullable
    • percentile75 string nullable
    • percentile90 string nullable
• benefits object nullable
  • @type string (default: "PayscaleBenefits")
  • description string nullable
  • retirement_benefits array (default: [])
  • health_benefits array (default: [])
• comparisons object nullable
  • @type string (default: "PayscaleComparisons")
  • basis object nullable
    • @type string (default: "PayscaleComparisonItem")
    • name string nullable
    • link string nullable
    • satisfaction_rating number nullable
    • stress_rating number nullable
    • male_percentage number nullable
    • female_percentage number nullable
    • flexibility_rating number nullable
  • comparables array (default: [])
    • @type string (default: "PayscaleComparisonItem")
    • name string nullable
    • link string nullable
    • satisfaction_rating number nullable
    • stress_rating number nullable
    • male_percentage number nullable
    • female_percentage number nullable
    • flexibility_rating number nullable
• locations array (default: [])
  • @type string (default: "PayscaleEmployerLocation")
  • city string nullable
  • state string nullable
  • country string nullable
  • url string nullable
• location_count integer nullable
• fact_data object nullable
  • @type string (default: "PayscaleEmployerFacts")
  • name string nullable
  • website string nullable
  • domain string nullable
  • abstract string nullable
  • image string nullable
  • industries array (default: [])
  • synonyms array (default: [])
  • founded_on string nullable
  • founded_year integer nullable
  • num_employees_min integer nullable
  • num_employees_max integer nullable
  • organization_type string nullable
  • stock_exchange string nullable
  • wikipedia_url string nullable
  • geo object nullable
    • @type string (default: "PayscaleEmployerGeo")
    • street string nullable
    • city string nullable
    • state string nullable
    • postal_code string nullable
    • country string nullable
    • latitude number nullable
    • longitude number nullable
  • source string nullable
  • last_updated string 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 — Employer not found (well-formed but nonexistent employer slug) 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.