PApaylocity
Get Company Schedules

Get Company Schedules

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.
get/apiHub/scheduling/v1/companies/{companyId}/schedules

Request

  • Base URL
    dc1demogwext.paylocity.com (relative, and the document’s source URL is not known)
  • URL
    dc1demogwext.paylocity.com/apiHub/scheduling/v1/companies/{companyId}/schedules
  • 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.

Query parameters

includestring

The sub-resources to include in the response.

  • sub-resources: breaks, note, claims
filterstring

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
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 open shift to only those specified.

Headers

Authorizationstring required

Authorization token. Ex. Bearer ...

Response

Success

idstring uuid

TODO: fill this out

isActiveboolean

TODO: fill this out

isDefaultboolean

TODO: fill this out

isOpenShiftClaimEnabledboolean

TODO: fill this out

isOpenShiftsEnabledboolean

TODO: fill this out

isRestrictToGroupboolean

TODO: fill this out

isShiftSwappingApprovalsEnabledboolean

TODO: fill this out

isShiftSwappingEnabledboolean

TODO: fill this out

namestring nullable

TODO: fill this out

Changes

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