Get Started with Compensation Benchmarks API

Everything you need to know to get started with the Compensation Benchmarks API.

Generate your API key

To make an API request, you will need an API key.

  • If you have a Visier account with a profile that has the API capability, then you can generate an API key in the studio experience. For more information on how to get an API key, see API Authentication.
  • If you don't have a Visier account, contact your Client Success Manager to get an API key.

Note: The Compensation Benchmarks API does not require a security token at this time.

Choose your tool

To use Visier APIs, you need to choose a tool to make your first request. This can be Postman or whichever method you usually use to make HTTP requests. For more information about using Postman for your first request, see Use Postman to Call Visier APIs.

Make your first request

To test that you have everything set up correctly, we’ll create a request to retrieve a list of all members in the jobs dimension using the /v1/compensation-benchmarks/jobs endpoint. For a complete list of available endpoints, see API Reference.

The following sample request is used to retrieve a list of all jobs. Replace {vanity-name} with your tenant name and include the API key as a header.

Copy
cURL sample request: Retrieve a list of all jobs
curl -X GET --url 'https://{vanity_name}.api.visier.io/v1/compensation-benchmarks/jobs' \
-H 'apikey: {api_key}'

If the request is successful, you should see a similar response:

Copy
Sample response
[
    ...,
    {
        "id": "87ff2708",
        "name": "Dental care",
        "description": "This subdomain involves providing dental services, including preventive care, diagnosis, and treatment of oral health issues.",
        "hasBenchmarkValue": false,
        "hasChildren": true
    },
    {
        "id": "141a2c80",
        "name": "Dental Assistant",
        "description": "People in this job support dental practitioners in clinical treatments, as preparation and helping in practical execution and follow-up, and administrative tasks under supervision and following the orders of the dental practitioner.",
        "hasBenchmarkValue": true,
        "hasChildren": false
    },
    {
        "id": "a684aa76",
        "name": "Dental Lab Technician",
        "description": "People in this job manufacture dental custom-made devices like bridges, crowns, dentures and appliances under the supervision of dental practitioners following their directions and specifications.",
        "hasBenchmarkValue": true,
        "hasChildren": false
    },
    ...
]

Next steps

Now that you've successfully authenticated and completed your first API request, you can call more Visier APIs!

To learn more: