v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB
Employee Shifts

Get Employee 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.
get/apiHub/scheduling/v1/companies/{companyId}/employees/{employeeId}/shifts

Path parameters

companyIdstring required

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

employeeIdstring required

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

Query parameters

includestring

The sub-resources to include in the response.<br /> - sub-resources: breaks, segments, note

filterstring

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

includeTotalCountboolean

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.

limitinteger

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

offsetinteger

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

sortstring

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

Authorizationstring required

Authorization token. Ex. Bearer ...

Response

Success

stackIdstring

Unique identifier for the stack.

startDateTimestring date-time

The scheduled start date and time for the task, in ISO 8601 format.

durationinteger

The length of time the task is scheduled to take, measured in minutes.

hasNoteboolean

Indicates whether there is an additional note attached to the task.

notestring

The content of the additional note, if any.

isEmployeeNoteboolean

Indicates whether the note is made by the employee.

costCentersstring[]

A list of identifiers for cost centers associated with the task.

positionKeyinteger

Numeric key representing the position associated with the task.

legacyAssignmentIdinteger

Numeric identifier for a legacy assignment linked to the task.

templateAssignmentIdstring uuid

Unique identifier for a template assignment associated with the task.

shiftIdinteger

Numeric identifier for the shift associated with the task.

scheduleIdinteger

Numeric identifier for the schedule associated with the task.

isPublishedboolean

Indicates whether the task has been published.

isDeletedboolean

Indicates whether the task has been marked as deleted.