Returns employee shifts

Summary Description

The GET Employee Shifts API endpoint detailed information about the shifts assigned to an individual employee. This endpoint is essential for tracking, analyzing, and managing an employee's schedule. The detailed shift information includes start and end times, roles, required skills, and location details.

The use cases:

  • Employees can use this endpoint to view their upcoming shifts, including start and end times, roles, and locations. Enhances employee awareness of their schedule, reducing missed shifts and improving punctuality
  • Managers can access the shifts of individual employees to ensure adequate staffing and workload distribution. Facilitates effective shift management and helps avoid over-scheduling or under-utilization of staff
  • When scheduling new shifts, managers can use this endpoint to check for conflicts with an employee's existing shifts. Prevents scheduling overlaps, ensuring that employees are not double-booked.
Path Params
string
required

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

string
required

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

Query Params
string

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

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

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.

int32
0 to 2147483647

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

int32
0 to 2147483647

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

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
string
required
Defaults to Bearer JWT_GOES_HERE

Authorization token. Ex. Bearer ...

Responses

401

Unauthorized

Language
LoadingLoading…
Response
Choose an example:
application/json