Get Pay Grades
Summary Description
The GET Pay Grades List by Company ID endpoint, retrieves a comprehensive list of Pay Grades from the Paylocity system with each call. Pay grades, commonly referred to as pay scales or wage ranges, are numerical or alphanumeric categorizations employed by corporations to classify tasks or positions according to their relative worth or intricacy within the organization. Pay grades are commonly linked to a spectrum of salaries and fulfill various crucial functions in human resources and pay administration. Pagination can be achieved by using the “payGrades” parameter and specifying the values of “limit” and “offset” to decide the quantity of records to be retrieved. The utilization of the “limit” option permits the user to restrict the quantity of rows that are retrieved from a query, whereas the “offset” option enables the omission of a designated number of rows preceding the commencement of the result set. The utilization of both the limit and offset parameters in a query allows for the skipping of rows as well as the restriction of the number of rows returned. Pay Grades are otherwise optional in HR & Payroll and do not affect any rate calculations that will cause changes in payroll.
Use Cases
- Configure and specify Current Pay Rates for employees in HR & Payroll. Certain reports, such as the CMS PBJ Report, also known as the Centers for Medicare & Medicaid Services Payroll-Based Journal Report, and other specially configured Custom Reports reference Pay Grades.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Paylocity company identifier (COID): up to 9 alphanumeric characters for the target company.
Headers
Media type(s) the client can accept in the response (typically application/json).
Query parameters
A boolean value representing whether the API should return the total number of resources available (even though only a subset may be returned). When includeTotalCount=true, then the X-Pcty-Total-Count response header should be added to the response and will specify the total number of records available. APIs that support X-Pcty-Total-Count should include this parameter in their specification.
Number of pay grades per page.
Default Value: 20
Maximum Value: 100 Used together with offset for offset/limit pagination.
Pagination offset. Uses item-index offset semantics: this is the number of resources to skip (not a page number). Pair with limit for paging.
Response headers
When the request sets includeTotalCount=true, the API returns this header with the total number of resources available (even if only one page is returned).