Get Open Shifts by Company

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.
Path Params
string
required

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

Query Params
string

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

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 2147483647

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

int32
0 to 2147483647

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.

Headers
string
required
Defaults to Bearer JWT_GOES_HERE

Authorization token. Ex. Bearer ...

Responses

401

Unauthorized

Language
LoadingLoading…
Response
Choose an example:
application/json