Pay Levels

Authentication: All endpoints require an Authorization: Bearer <access token> header.

Most endpoints require an X-Company-ID: <company_id> header to scope requests to a specific company. This is the recommended header for most API operations.

Some endpoints require an X-Location-ID: <location_id> header when the query doesn't accept a locationId parameter.

See Authentication for details on how to obtain and use these headers.

Query Pay Levels

Retrieve all pay levels configured for the company. Pay levels define compensation structures and can have multiple versions over time to track historical changes in rates and conditions.

Query Parameters:

This query takes no parameters and returns all pay levels configured for the company.

Response Fields:

Field	Description
`id`	Unique identifier for the pay level
`name`	Name of the pay level (e.g., "Standard FT Developer")
`description`	Description of the pay level
`versions`	Array of pay level versions (historical rates)
`versions[].id`	Unique identifier for the version
`versions[].name`	Name of the version
`versions[].description`	Description of the version
`versions[].commencedAt`	Date when this version became effective
`versions[].modifiedAt`	Timestamp when the version was last modified
`versions[].modifiedBy.fullName`	Name of the user who last modified the version
`versions[].deletedAt`	Timestamp when the version was deleted (null if active)
`modifiedAt`	Timestamp when the pay level was last modified
`modifiedBy.fullName`	Name of the user who last modified the pay level
`deletedAt`	Timestamp when the pay level was deleted (null if active)

For the complete PayLevel type reference and all available fields, see the GraphQL Schema Reference.

Implementation Notes:

Pay levels can have multiple versions to track changes in rates over time
Each version has a commencedAt date indicating when it becomes effective
The versions array may be empty if no versions have been created yet
Only active (non-deleted) pay levels are returned by default (deletedAt is null)
Versions with a deletedAt value are historical and no longer active
Pay levels are typically used in conjunction with pay rules to determine employee compensation
The modifiedBy field tracks audit information for compliance purposes

GraphQL Query

query PayLevels {
  payLevels {
    id
    name
    description
    versions {
      id
      name
      description
      commencedAt
      modifiedAt
      modifiedBy {
        fullName
      }
      deletedAt
    }
    modifiedAt
    modifiedBy {
      fullName
    }
    deletedAt
  }
}

Example Variables

{}

Example Response

{
  "data": {
    "payLevels": [
      {
        "id": "541",
        "name": "Standard FT Developer",
        "description": "Standard FT Developer",
        "versions": [
          {
            "id": "63",
            "name": "v1",
            "description": null,
            "commencedAt": "2000-01-01",
            "modifiedAt": "2023-11-07T06:15:17.155Z",
            "modifiedBy": {
              "fullName": "Roubler Support"
            },
            "deletedAt": null
          }
        ],
        "modifiedAt": "2024-06-05T21:53:26.753Z",
        "modifiedBy": {
          "fullName": "Roubler Support"
        },
        "deletedAt": null
      }
    ]
  }
}