--- updatedAt: 2026-02-10T18:50:36.000Z agentTools: siteIndex: https://developer.paylocity.com/llms.txt projectIndex: https://developer.paylocity.com/integrations/llms.txt --- # 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. # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Company Level Information", "version": "v1" }, "servers": [ { "url": "dc1demogwext.paylocity.com" } ], "paths": { "/apiHub/positionManagement/v1/companies/{companyId}/payGrades": { "get": { "tags": [ "Payroll/HR" ], "summary": "Get Pay Grades", "description": "**Summary Description**\n\nThe 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.\nPagination 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.\nPay Grades are otherwise optional in HR & Payroll and do not affect any rate calculations that will cause changes in payroll.\n\n**Use Cases**\n\n- 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.\n", "x-explorer-enabled": false, "parameters": [ { "name": "companyId", "in": "path", "description": "The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.\r\n **Allowable Values:**\r\n 9 char max", "required": true, "schema": { "type": "string" }, "example": "A12345" }, { "name": "Authorization", "in": "header", "description": "Authorization token. Ex. Bearer ...", "schema": { "type": "string" } }, { "name": "includeTotalCount", "in": "query", "description": "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.", "schema": { "type": "boolean", "default": true } }, { "name": "testMode", "in": "header", "description": "If true all responses are mocked and generated randomly.", "schema": { "type": "boolean", "default": false } }, { "name": "limit", "in": "query", "description": "Number of pay grades per page.\r\n **Default Value:** 20\r\n **Maximum Value:** 100", "schema": { "type": "integer", "format": "int32", "default": 20 }, "example": 5 }, { "name": "offset", "in": "query", "description": "Pagination offset.", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PayGradeDto" } } } } } } } } }, "components": { "schemas": { "PayGradeCompaniesDto": { "type": "object", "properties": { "companyId": { "type": "string", "description": "The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.", "nullable": true }, "active": { "type": "boolean", "description": "An indicator denoting the active state of the company's association with the pay grade (True or False).", "nullable": true } }, "additionalProperties": { "type": "object", "nullable": true } }, "PayGradeDto": { "type": "object", "properties": { "payGradeKey": { "type": "integer", "description": "A unique identifier associated with the pay grade, serving as a primary reference for identification.", "format": "int32", "nullable": true }, "legacyPayGradeId": { "type": "integer", "description": "An identifier representing the pay grade in legacy systems, aiding in data migration and compatibility.", "format": "int32", "nullable": true }, "clientId": { "type": "integer", "description": "ClientId is the company set ID when the client is a company set. If the client is a standalone company, then clientId will be the same as the companyId.", "format": "int32", "nullable": true }, "active": { "type": "boolean", "description": "An indicator denoting the current status or active state of the pay grade.", "nullable": true }, "code": { "type": "string", "description": "A code representing the pay grade, offering a concise reference for identification and categorization.", "nullable": true }, "description": { "type": "string", "description": "A detailed textual explanation or label for the pay grade, providing additional context and meaning.", "nullable": true }, "minimum": { "type": "number", "description": "The minimum value associated with the pay grade.", "format": "double", "nullable": true }, "maximum": { "type": "number", "description": "The maximum value associated with the pay grade.", "format": "double", "nullable": true }, "midpoint": { "type": "number", "description": "The midpoint value within the pay grade range, helping to define salary structures and compensation levels.", "format": "double", "nullable": true }, "positionsAssigned": { "type": "integer", "description": "The number of positions assigned to the pay grade, indicating the extent of its use within the organization.", "format": "int32", "nullable": true }, "payGradeCompanies": { "type": "array", "items": { "$ref": "#/components/schemas/PayGradeCompaniesDto" }, "description": "Companies associated with the pay grade, identified by their unique \"companyId.\"", "nullable": true } }, "additionalProperties": { "type": "object", "nullable": true } } } } } ```