Get Employee Shifts

get

https://dc1demogwext.paylocity.com/apiHub/scheduling/v1/companies/{companyId}/employees/{employeeId}/shifts

Summary Description

The GET Employee Shifts endpoint returns information about the shifts assigned to a specific employee. The response includes structured data such as shift start and end times, roles, required skills, and location details.

Use cases:

Retrieve employee-assigned shifts, including timing, role information, and location.
Managers can access an employee's scheduled shifts to review staffing coverage and workload distribution.
When creating or adjusting schedules, managers can use this endpoint to identify potential conflicts with an employee's existing shifts, such as overlapping times.

Path Params

companyId

string

required

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

employeeId

string

required

The Paylocity Employee ID. This is a unique value per Paylocity Company ID.

Query Params

include

string

The sub-resources to include in the response.
- sub-resources: breaks, 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

200Success

400Bad Request

500Server Error