Skip to main content

Create an API key to pull down only salary perks

Build something that separates the data so no basic salary can be pulled.

J
Written by Joshua Shooter
Updated over 2 months ago

To create an API key to only take the salary perks, follow the steps below:

To create the query, follow the steps below:

  1. Click Access Button image then click HR Admin.

  2. Click Queries then click the plus + icon.

  3. In the left-hand list, select Salary Details

  4. Then in the right-hand selection pane, tick:

    • Salary Details

    • Perk Amount

    • Perk Type

    • Perk Percentage

    • Perk Comments

    • Perk

  5. Click Next twice, then enter the name, description, and category for the query.

To export the query, click Export To.
​


Create an API key

To create the API key, follow the steps below:

  1. Click Access Button image then click HR Admin.

  2. Click Settings, then click API.

  3. Click the plus + icon, then enter the API name.

  4. Specify certain IP addresses to restrict the use of this key.

  5. Select specific application actions for your relevant categories by selecting the Query Builder endpoint.

  6. Choose the query you created for salary perks, then click Save.

Did this answer your question?