Skip to main content
POST
/
api
/
payscale
/
schools
/payscale/schools
curl --request POST \
  --url https://api.anysite.io/api/payscale/schools \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "school": "<string>",
  "timeout": 300,
  "country": "US",
  "report_type": "Salary"
}
'
[
  {
    "@type": "@payscale_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": []
    }
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
school
string
required

School name or Payscale school slug

Minimum string length: 1
Examples:

"Western Governors University (WGU)"

"Arizona_State_University_(ASU)"

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_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