BAbamboohr
Pay Grades & Bands
Public API

List Compensation Level Groups and Levels

Changed on

Returns the working draft configuration of compensation level groups and levels, including the per-group and per-level validation errors and warnings used by the setup wizard. When no draft configuration exists, the endpoint returns the currently published configuration instead. The response is a JSON object with a groups array; each group carries its levels, and each level flattens its pay band into min, mid, max, and percentageRange value objects (each wrapping a numeric value plus its own errors and warnings), along with currencyCode, compensationType, and the jobTitles assigned to that level. The pay band value objects are returned on this view, but their errors and warnings are not populated here; pay band values are validated only at review/publish. This is the editable draft/editor view: it reflects in-progress edits and surfaces levels-step validation state. For the same draft structure with pay-band-value validation populated use Get Pay Bands (get-pay-bands), and for the consolidated pre-publish validation across every step use Get Levels and Bands Review (get-levels-and-bands-review). For the currently published pay grades and bands without validation state, use Get Published Levels and Bands (get-published-levels-and-bands) instead.

OAuth Scopes: pay_grades_and_bands

get/api/v1/pay-grades-and-bands/levels

Request

Response

The working pay grades and bands configuration (the draft when one exists, otherwise the currently published configuration): compensation level groups and levels with validation state, as an object with a groups array.

Changes

  • 922fc15f43a7Revision changes
    • breaking

      the response property became optional for the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • info

      api operation id db8c61787c931b69afbf9e501be85256 removed and replaced with list-compensation-level-groups-and-levels

    • info

      api tag Pay Grades & Bands added

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status