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

# Get Company Shifts

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

**Version:** V1

**Summary Description**

The GET Company Shifts endpoint returns information about the shifts at a company level. The response includes data such as start and end times, tasks associated with the shift, and any recorded overtime.

**Use cases:**
- Managers can review current shifts for the entire company and make adjustments based on staffing needs.
- Users can view shift details such as start and end times, duration, cost centers, and pay type. 
- The endpoint allows retrieval of shift attributes such as timing, assigned tasks, and overtime. This information can be used to analyze work patterns and identify trends.

## Path parameters

- `companyId` string, required

## Query parameters

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

## Headers

- `Authorization` string, required

## Response `200`

Success

- ShiftV1Model[]
  - `stackId` string: Unique identifier for the stack.
  - `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.
  - `startDateTime` string, date-time: The scheduled start date and time for the task, in ISO 8601 format.
  - `duration` integer: The length of time the task is scheduled to take, measured in minutes.
  - `hasNote` boolean: Indicates whether there is an additional note attached to the task.
  - `note` string: The content of the additional note, if any.
  - `isEmployeeNote` boolean: Indicates whether the note is made by the employee.
  - `costCenters` string[]: A list of identifiers for cost centers associated with the task.
  - `positionKey` integer: Numeric key representing the position associated with the task.
  - `breaks` ShiftBreakV1Model[]: A list of breaks associated with the shift.
    - `startDateTime` string, date-time: The scheduled start time for each break, formatted as an ISO 8601 date and time.
    - `duration` integer: The duration of each break, typically measured in minutes.
    - `payType` string: The type of pay (e.g., regular, overtime) applicable during the break.
  - `segments` ShiftSegmentV1Model[]: A list of segments associated with the shift.
    - `payType` 'unknown' | 'break' | 'meal' | 'work'
    - `actualTimeIn` string, date-time: The actual start time for the segment.
    - `actualTimeOut` string, date-time: The actual end time for the segment.
    - `regDuration` integer: Duration of regular time worked during the segment.
    - `ot1Duration` integer: Duration of the first overtime period worked during the segment.
    - `ot2Duration` integer: Duration of the second overtime period worked during the segment.
    - `nonWorkDuration` integer: Duration of non-work time during the segment.
    - `unpaidDuration` integer: Duration of unpaid time during the segment.
    - `cost` number, double: The cost associated with the segment.
    - `applyToDate` string: The date to which the segment's details apply.
  - `legacyAssignmentId` integer: Numeric identifier for a legacy assignment linked to the task.
  - `templateAssignmentId` string, uuid: Unique identifier for a template assignment associated with the task.
  - `shiftId` integer: Numeric identifier for the shift associated with the task.
  - `scheduleId` integer: Numeric identifier for the schedule associated with the task.
  - `isPublished` boolean: Indicates whether the task has been published.
  - `isDeleted` boolean: Indicates whether the task has been marked as deleted.
  - `draft` ShiftDetailsV1Model
    - `stackId` string: Unique identifier for the stack.
    - `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.
    - `startDateTime` string, date-time: The scheduled start date and time for the task, in ISO 8601 format.
    - `duration` integer: The length of time the task is scheduled to take, measured in minutes.
    - `hasNote` boolean: Indicates whether there is an additional note attached to the task.
    - `note` string: The content of the additional note, if any.
    - `isEmployeeNote` boolean: Indicates whether the note is made by the employee.
    - `costCenters` string[]: A list of identifiers for cost centers associated with the task.
    - `positionKey` integer: Numeric key representing the position associated with the task.
    - `breaks` ShiftBreakV1Model[]: A list of breaks associated with the shift.
      - `startDateTime` string, date-time: The scheduled start time for each break, formatted as an ISO 8601 date and time.
      - `duration` integer: The duration of each break, typically measured in minutes.
      - `payType` string: The type of pay (e.g., regular, overtime) applicable during the break.
    - `segments` ShiftSegmentV1Model[]: A list of segments associated with the shift.
      - `payType` 'unknown' | 'break' | 'meal' | 'work'
      - `actualTimeIn` string, date-time: The actual start time for the segment.
      - `actualTimeOut` string, date-time: The actual end time for the segment.
      - `regDuration` integer: Duration of regular time worked during the segment.
      - `ot1Duration` integer: Duration of the first overtime period worked during the segment.
      - `ot2Duration` integer: Duration of the second overtime period worked during the segment.
      - `nonWorkDuration` integer: Duration of non-work time during the segment.
      - `unpaidDuration` integer: Duration of unpaid time during the segment.
      - `cost` number, double: The cost associated with the segment.
      - `applyToDate` string: The date to which the segment's details apply.
    - `legacyAssignmentId` integer: Numeric identifier for a legacy assignment linked to the task.
    - `templateAssignmentId` string, uuid: Unique identifier for a template assignment associated with the task.

## 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)