Get Shifts by Company

get

https://dc1demogwext.paylocity.com/apiHub/scheduling/v1/companies/{companyId}/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 Params

companyId

string

required

The Paylocity Company ID. This is the unique value provided by Paylocity to each specific Payroll Entity.

Query Params

include

string

The sub-resources to include in the response.
- sub-resources: breaks, draft, segments, note

filter

string

A parseable filter expression involving fields, operators, and values to filter the result list by.
- fields: startDateTime, positionKey
- operators: eq, in, lt, gt, le, ge, and, or

includeTotalCount

boolean

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.

limit

int32

0 to 2147483647

The maximum number of resources to include in the response. The default is 25.

offset

int32

0 to 2147483647

The number of resources to skip when returning paginated results. The default is 0.

sort

string

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

string

required

Defaults to Bearer JWT_GOES_HERE

Authorization token. Ex. Bearer ...

Responses

401

Unauthorized

Language

Loading…

Response

Choose an example:

application/json

200Success

400Bad Request

500Server Error