(EA) Get Company Schedules

🚧

Early Access API Version

This endpoint version is currently in Early Access and available only to approved early adoption (EA) participants. Do not rely on this version for production workloads unless explicitly authorized. If you have any feedback, please share with your designated Early Adoption program representative.

Summary Description

The Get Company Schedules endpoint retrieves schedule information for employees across a company. This endpoint can be used to access planned shifts, monitor workforce coverage, and synchronize schedule data with workforce management, payroll, or timekeeping systems.

Use cases:

  • Managers can view employee schedules to monitor staffing levels and upcoming shift assignments.
  • HR and workforce management systems can retrieve schedule data to support planning, compliance, and reporting needs.
  • Scheduling applications can synchronize employee schedules across platforms to ensure accurate and up-to-date workforce information.
  • Organizations can use schedule data to analyze shift coverage, labor allocation, and scheduling trends.
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: none
string

A parseable filter expression involving fields, operators, and values to filter the result list by.

  • fields: id, name, isActive, isDefault, owner/companyId, owner/employeeId
  • operators for id: eq, in, ne
  • operators for name: eq, in, contains, startsWith
  • operators for owner/companyId, owner/employeeId: eq, in
  • operators for isActive, isDefault: eq
  • logical operators: 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 100
Defaults to 25

The maximum number of resources to include in the response. The default is 25. The maximum is 100; larger values return at most 100 resources.

int32
0 to 2147483647
Defaults to 0

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.

string

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

Headers
string
required
Defaults to Bearer JWT_GOES_HERE

Authorization token. Ex. Bearer ...

Responses

401

Unauthorized

Language
LoadingLoading…
Response
Choose an example:
application/json