Get Position Codes
Summary Description
The GET Position Codes List by Company ID endpoint, retrieves a comprehensive list of Position Codes from the Paylocity system with each call. Position codes are alphanumeric or numeric designations employed by corporations to classify and oversee various job responsibilities and positions within their workforce. These codes fulfill several crucial functions in the domains of human resources, talent management, and organizational structure. Pagination can be achieved by using the “positions” 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.
Use Cases
- Human Resources Management: HR departments often use position codes to categorize and manage job roles within an organization. The API can facilitate the creation, updating, and retrieval of position codes, ensuring that job roles are accurately documented and maintained.
- Payroll and Compensation Management: Position codes are crucial for determining salary scales and compensation packages. The API can be used to link position codes with salary information, simplifying payroll processing and compensation management.
- Recruitment and Onboarding: When hiring new employees, organizations can use the API to identify vacant positions and manage the recruitment process more efficiently. It can help HR teams keep track of available job roles and their requirements.
- Compliance and Reporting: Many regulatory agencies require organizations to report on specific job roles and positions. The API can assist in generating compliance reports by providing access to accurate position code data.
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 position codes 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).