BAbamboohr
Pay Grades & Bands
Public API

Get Pay Bands

Changed on

Returns the working draft pay band configuration for every compensation level, including the pay-band-step 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. A level is a percentage-based band when percentageRange.value is set, and a min-mid-max band when percentageRange.value is null. This view surfaces validation for the pay-band setup step; for the same structure with levels-step validation use List Compensation Level Groups and Levels (list-compensation-level-groups-and-levels), and for the published configuration without validation state use Get Published Levels and Bands (get-published-levels-and-bands).

OAuth Scopes: pay_grades_and_bands

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

Request

Response

The working pay grades and bands configuration (the draft when one exists, otherwise the currently published configuration): pay band values 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 fb29d4d4790104b6892a4b6d6db67e19 removed and replaced with get-pay-bands

    • 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