(EA) Get Shifts by Employee

🚧

Early Access API Version

This endpoint version is currently in Early Access and available only to approved early adoption (EA) participants. Do not rely on this version for production workloads unless explicitly authorized. If you have any feedback, please share with your designated Early Adoption program representative.

Version: V2

Summary Description

The Get Shifts by Employee endpoint retrieves shifts assigned to a specific employee. It provides detailed scheduling information, including dates, start and end times, pay type, cost center, and other supported shift details, allowing applications to view and manage an employee's work schedule.

Use cases:

  • Employees can view their assigned work schedules in web or mobile applications.
  • Managers can review employee schedules to monitor coverage and make scheduling adjustments.
  • Workforce management systems can retrieve employee shifts for reporting, payroll, or schedule synchronization.
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 100
Defaults to 25

The maximum number of resources to include in the response. The default is 25. The maximum is 100; larger values return at most 100 resources.

int32
0 to 2147483647
Defaults to 0

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.

string

A comma-separated list of fields to include in the response. Limits the returned properties for each shift to only those specified.

Headers
string
required
Defaults to Bearer JWT_GOES_HERE

Authorization token. Ex. Bearer ...

Responses

401

Unauthorized

Language
LoadingLoading…
Response
Choose an example:
application/json