BAbamboohr
Pay Grades & Bands
Public API

Get Levels and Bands Status

Changed on

Returns the configuration status of the Pay Grades & Bands (levels and bands) setup, broken down by setup step. The response is an object with four step keys, levels, payBands, jobTitles, and review, each reporting an isComplete flag plus errors (blocking issues) and warnings (non-blocking issues) arrays; the arrays are empty when a step has no outstanding issues. A setup step that has not yet been visited reports isComplete: false with empty errors and warnings, so empty arrays do not necessarily mean the step has no outstanding issues; the step simply has not been evaluated yet. For the levels, payBands, and review steps, each error or warning identifies the offending compensation level group and level; a levelId of 0 is a sentinel meaning the issue applies to the group as a whole rather than to a specific level. For jobTitles, each warning is a job title that is not yet assigned to a level. Use this to check whether the setup is complete before publishing. For the number of compensation level groups in each status (draft, published, historic), use Get Compensation Level Group Status Counts (get-compensation-level-group-status-counts) instead.

OAuth Scopes: pay_grades_and_bands

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

Request

Response

Successful response. Returns an object keyed by setup step (levels, payBands, jobTitles, review).

Changes

  • 922fc15f43a7Revision changes
    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • info

      api operation id 6fbb2fe60e374d2204f1222252105945 removed and replaced with get-levels-and-bands-status

    • info

      api tag Pay Grades & Bands added

    • info

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

    • info

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