BAbamboohr
Pay Grades & Bands
Public API

Get Published Levels and Bands

Changed on

Returns the currently published pay grades and bands as a JSON object with a groups array. Each group carries its published compensation levels, and each level flattens its pay band into min, mid, max, currencyCode, percentageRange, and compensationType, plus the job titles assigned to that level. Note the asymmetry: min, mid, and max are plain numbers, while percentageRange is an object (LevelsAndBands-PayBandValue) carrying its own validation state whose value is null for min-mid-max bands. Only published groups are returned; the groups array is empty when nothing has been published (this is a status filter, not a permission filter). Unlike the configuration-wizard endpoints, this published view omits the per-group and per-level validation errors and warnings. For the editable draft configuration with validation state, use List Compensation Level Groups and Levels (list-compensation-level-groups-and-levels) instead.

OAuth Scopes: pay_grades_and_bands

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

Request

Response

Published pay grades and bands 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

    • 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 cfacff2b34cf1e65ccd1ab188c5e1d12 removed and replaced with get-published-levels-and-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

      response property groups/items/levels/items/levelId list-of-types was narrowed by removing types null from media type application/json of response 200