Sign in

v1

latestOpenAPI 3.0.42026-07-2481154567.6 KB
Open Shifts

Get Open Shifts

Summary Description

The GET Open Shifts endpoint returns all shifts that are not currently assigned to an employee. The response includes each open shift and the total number available, allowing supervisors and managers to determine how many shifts can be assigned.

Use cases:

  • Managers can retrieve a list of unassigned shifts and make them available for employees to claim.
  • The endpoint can be used in a third-party system where employees view and request available shifts. Allocation can follow predefined rules such as seniority or skill requirements.
  • The endpoint provides skill requirements for each open shift, enabling organizations to match shifts with qualified employees.
get/apiHub/scheduling/v1/companies/{companyId}/openShifts

Path parameters

companyIdstring required

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

Query parameters

includestring

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

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.

quantityinteger

The number of units, items, or tasks, depending on the context.

startDateTimestring date-time

The scheduled start date and time for the task or event.

durationinteger

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

isPublishedboolean

Indicates whether the information has been published or made public.

scheduleIdinteger

Numeric identifier for the schedule associated with the task or event.

costCentersstring[]

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

positionKeyinteger

A numeric key representing the position associated with the task or event.

hasNoteboolean

A boolean flag indicating whether an additional note is attached.

notestring

The content of the additional note, if applicable.

isEmployeeNoteboolean

A boolean flag indicating whether the note is provided by the employee.

templateAssignmentIdstring

Unique identifier for a template assignment associated with the task or event.