It is easy to get started retrieving compensation information in just a few steps. Once you have been given a compensation API token by the support team, follow these steps in order to retrieve compensation data for contingent or annual jobs.
- Pick an industry using the industry endpoint and store its id.
- Pick the location you want compensation in using the locations endpoint and store its id.
- Query the job you want compensation for using the title endpoint and its params.
- Make a POST api call to the search endpoint with your location, industry, job and rate type parameters (Hourly for contingent data and Annual for full-time data)
- The search response provides 5 levels of compensation along with other statistics about compensation in the chosen location and industry.
- We recommend storing your search results for each job if you intend to display the information elsewhere, rather than making repeated calls for the same job compensation information.