v1
latestOpenAPI 3.0.42026-07-2481154567.6 KBGet Company shifts
Summary Description
The GET Company Shifts endpoint returns information about the shifts at a company level. The response includes data such as start and end times, tasks associated with the shift, and any recorded overtime.
Use cases:
- Managers can review current shifts for the entire company and make adjustments based on staffing needs.
- Users can view shift details such as start and end times, duration, cost centers, and pay type.
- The endpoint allows retrieval of shift attributes such as timing, assigned tasks, and overtime. This information can be used to analyze work patterns and identify trends.
Path parameters
The Paylocity Company ID. This is the unique value provided by Paylocity to each specific Payroll Entity.
Query parameters
The sub-resources to include in the response.<br /> - sub-resources: breaks, draft, segments, note
A parseable filter expression involving fields, operators, and values to filter the result list by. <br /> - fields: startDateTime, positionKey<br /> - operators: eq, in, lt, gt, le, ge, and, or
When provided and set to true will cause the API to return the X-Pcty-Total-Count header in the response which will be set to the total number of resources available even if only a subset of those were returned. The default is false.
The maximum number of resources to include in the response. The default is 25.
The number of resources to skip when returning paginated results. The default is 0.
A comma-separated, xpath-like formatting string that identifies the fields that you want the API to use for sorting the resources when they are returned. The default value can vary from API to API.
Headers
Authorization token. Ex. Bearer ...
Response
Success