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

# Get Open Shifts

`GET /apiHub/scheduling/v1/companies/{companyId}/openShifts`

**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 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

- OpenShiftV1Model[]
  - `stackId` string — Unique identifier for the stack.
  - `quantity` integer — The number of units, items, or tasks, depending on the context.
  - `startDateTime` string, date-time — The scheduled start date and time for the task or event.
  - `duration` integer — The length of time the task or event is scheduled to take, measured in minutes.
  - `isPublished` boolean — Indicates whether the information has been published or made public.
  - `scheduleId` integer — Numeric identifier for the schedule associated with the task or event.
  - `costCenters` string[] — A list of unique identifiers for cost centers associated with the task or event.
  - `positionKey` integer — A numeric key representing the position associated with the task or event.
  - `hasNote` boolean — A boolean flag indicating whether an additional note is attached.
  - `note` string — The content of the additional note, if applicable.
  - `isEmployeeNote` boolean — A boolean flag indicating whether the note is provided by the employee.
  - `breaks` OpenShiftBreakV1Model[] — A list of breaks associated with the open shift.
    - `startDateTime` string — 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.
  - `claims` OpenShiftClaimV1Model[] — A list of claims submitted for the open shift.
    - `claimId` integer — Numeric identifier for the claim.
    - `stackId` string — Unique identifier for the stack associated with the claim.
    - `employee` OpenShiftEmployeeV1Model
      - `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.
    - `status` string — The current status of the claim (e.g., pending, approved, denied).
    - `statusNote` string — Additional note regarding the status of the claim.
    - `type` string — The type of claim being made (e.g., selected, disputed).
    - `dateCreatedUtc` string — The date and time the claim was created, in Coordinated Universal Time (UTC).
  - `templateAssignmentId` string — Unique identifier for a template assignment associated with the task or event.

## Other responses

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

---

[API](https://skmtc.net/paylocity/apis/assessments-api.md) · [All operations](https://skmtc.net/paylocity/apis/assessments-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paylocity/assessments-api/revisions/dd22ab229153/schema)