Skip to navigation
Scheduling

Get Employee Shifts

View as Markdown
Beta Phase

This resource is in closed beta. Paylocity Technology Partners interested may contact the marketplace team to explore early adopter opportunities at marketplaceapisupport@paylocity.com

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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

companyIdstringRequired
employeeIdstringRequired

Headers

AcceptstringOptional

Query parameters

includestringOptional

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

filterstringOptional

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

includeTotalCountstringOptional

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.

limitstringOptional
The maximum number of resources to include in the response. The default is 25.
offsetstringOptional
The number of resources to skip when returning paginated results. The default is 0.
sortstringOptional

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.

Response

Successful response