---
title: "Get Shifts by Company"
method: GET
path: "/apiHub/scheduling/v2/companies/{companyId}/shifts"
tags: ["Company Shifts"]
---

# Get Shifts by Company

`GET /apiHub/scheduling/v2/companies/{companyId}/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}/shifts`
- Auth: none declared. Required headers: `Authorization`

**Version:** V2

**Summary Description**

The GET Shifts by Company endpoint provides access to detailed shift information at the company level. This endpoint retrieves comprehensive shift data, serving as an essential tool for viewing, analyzing, and managing employee work schedules.

**Use cases:**
- The GET Shifts API allows the manager to access current shift details in real-time, enabling quick adjustments to staffing levels based on demand. This ensures optimal coverage and improves customer service.
- By utilizing the Shifts API, track shift details such as start and end times, tasks performed, and any overtime worked. This data helps in analyzing worker productivity and identifying trends for performance improvement.

## Path parameters

- `companyId` string, required

## Query parameters

- `include` string
- `filter` string
- `includeTotalCount` boolean
- `limit` integer
- `offset` integer
- `sort` string
- `fields` string

## Headers

- `Authorization` string, required

## Response `200`

Success

- ShiftV2Model[]
  - `assignedTo` EmployeeV1Model
    - `companyId` string: Identifier of the company to which the task is assigned.
    - `employeeId` string: Identifier of the employee to whom the task is assigned within the company.
  - `breaks` ShiftBreakV2Model[], nullable: TODO: fill this out
    - `duration` integer: TODO: fill this out
    - `payType` 'break' | 'meal': TODO: fill this out
    - `relativeEndDateTime` string, date-time, required: TODO: fill this out
    - `relativeStartDateTime` string, date-time, required: TODO: fill this out
  - `costCenters` string[], nullable: TODO: fill this out
  - `draft` ShiftDetailsV2Model: TODO: fill this out
    - `assignedTo` EmployeeV1Model
      - `companyId` string: Identifier of the company to which the task is assigned.
      - `employeeId` string: Identifier of the employee to whom the task is assigned within the company.
    - `breaks` ShiftBreakV2Model[], nullable: TODO: fill this out
      - `duration` integer: TODO: fill this out
      - `payType` 'break' | 'meal': TODO: fill this out
      - `relativeEndDateTime` string, date-time, required: TODO: fill this out
      - `relativeStartDateTime` string, date-time, required: TODO: fill this out
    - `costCenters` string[], nullable: TODO: fill this out
    - `duration` integer, nullable: TODO: fill this out
    - `hasNote` boolean, nullable: TODO: fill this out
    - `isEmployeeNote` boolean, nullable: TODO: fill this out
    - `legacyAssignmentId` integer, nullable: TODO: fill this out
    - `note` string, nullable: TODO: fill this out
    - `positionKey` integer, nullable: TODO: fill this out
    - `relativeEndDateTime` string, date-time: TODO: fill this out
    - `relativeStartDateTime` string, date-time: TODO: fill this out
    - `segments` ShiftSegmentV2Model[], nullable: TODO: fill this out
      - `cost` number, double: TODO: fill this out
      - `nonWorkDuration` integer: TODO: fill this out
      - `ot1Duration` integer: TODO: fill this out
      - `ot2Duration` integer: TODO: fill this out
      - `payType` 'break' | 'meal' | 'work': TODO: fill this out
      - `regDuration` integer: TODO: fill this out
      - `relativeApplyToDate` string, date: TODO: fill this out
      - `relativeTimeIn` string, date-time: TODO: fill this out
      - `relativeTimeOut` string, date-time: TODO: fill this out
      - `unpaidDuration` integer: TODO: fill this out
    - `templateVersionedAssignmentId` string, uuid, nullable: TODO: fill this out
  - `duration` integer, nullable: TODO: fill this out
  - `hasNote` boolean, nullable: TODO: fill this out
  - `id` string, uuid: TODO: fill this out
  - `isEmployeeNote` boolean, nullable: TODO: fill this out
  - `isPublished` boolean: TODO: fill this out
  - `legacyAssignmentId` integer, nullable: TODO: fill this out
  - `note` string, nullable: TODO: fill this out
  - `positionKey` integer, nullable: TODO: fill this out
  - `relativeEndDateTime` string, date-time: TODO: fill this out
  - `relativeStartDateTime` string, date-time: TODO: fill this out
  - `scheduleId` string, uuid, nullable: TODO: fill this out
  - `segments` ShiftSegmentV2Model[], nullable: TODO: fill this out
    - `cost` number, double: TODO: fill this out
    - `nonWorkDuration` integer: TODO: fill this out
    - `ot1Duration` integer: TODO: fill this out
    - `ot2Duration` integer: TODO: fill this out
    - `payType` 'break' | 'meal' | 'work': TODO: fill this out
    - `regDuration` integer: TODO: fill this out
    - `relativeApplyToDate` string, date: TODO: fill this out
    - `relativeTimeIn` string, date-time: TODO: fill this out
    - `relativeTimeOut` string, date-time: TODO: fill this out
    - `unpaidDuration` integer: TODO: fill this out
  - `templateVersionedAssignmentId` string, uuid, nullable: TODO: fill this out

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `500`: Server Error

---

[API](https://skmtc.dev/paylocity/apis/scheduling-api.md) - [All operations](https://skmtc.dev/paylocity/apis/scheduling-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paylocity/apis/scheduling-api/revisions/51ca447f2b45?raw)