PApaylocity
Employee Shifts

Get Shifts by Employee

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

Request

  • Base URL
    dc1demogwext.paylocity.com (relative, and the document’s source URL is not known)
  • URL
    dc1demogwext.paylocity.com/apiHub/scheduling/v2/companies/{companyId}/employees/{employeeId}/shifts
  • Auth
    none declared. Required headers: Authorization

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.

  • sub-resources: breaks, segments, note
filterstring

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
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.

fieldsstring

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

Headers

Authorizationstring required

Authorization token. Ex. Bearer ...

Response

Success

costCentersstring[] nullable

TODO: fill this out

durationinteger nullable

TODO: fill this out

hasNoteboolean nullable

TODO: fill this out

idstring uuid

TODO: fill this out

isEmployeeNoteboolean nullable

TODO: fill this out

isPublishedboolean

TODO: fill this out

legacyAssignmentIdinteger nullable

TODO: fill this out

notestring nullable

TODO: fill this out

positionKeyinteger nullable

TODO: fill this out

relativeEndDateTimestring date-time

TODO: fill this out

relativeStartDateTimestring date-time

TODO: fill this out

scheduleIdstring uuid nullable

TODO: fill this out

templateVersionedAssignmentIdstring uuid nullable

TODO: fill this out

Changes

No recorded changes to this operation across all 1 revision of this API.