---
title: "Get shifts"
method: GET
path: "/scheduler/v1/schedulers/{schedulerId}/shifts"
tags: ["Schedule:v1:Schedulers:Schedule:Shifts:Shifts"]
---

# Get shifts

`GET /scheduler/v1/schedulers/{schedulerId}/shifts`

Retrieve a list of shifts under a specific schedule

## Path parameters

- `schedulerId` integer, required — The unique identifier of the schedule

## Query parameters

- `startTime` integer, required — The start time to filter by in Unix format (in seconds)
- `endTime` integer, required — The end time to filter by in Unix format (in seconds)
- `isOpenShift` boolean, nullable — Filter shifts that are open shifts
- `isPublished` boolean, nullable — Filter shifts that are published
- `isRequireAdminApproval` boolean, nullable — Filter shifts that require admin approval
- `jobId` string[], nullable — List of job IDs
- `assignedUserIds` integer[], nullable — List of user IDs
- `shiftId` string[], nullable — List of shift IDs
- `title` string, nullable — Title of the shift
- `sort` 'created_at' | 'updated_at'
- `order` 'asc' | 'desc'
- `limit` integer — The maximum number of results to display per page
- `offset` integer — The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results

## Response `200`

Successful Response

- PaginatedBaseResponseV2ShiftBulkResponse
  - `requestId` string
  - `data` ShiftBulkResponse, required
    - `shifts` V2FeaturesShiftschedulerExternalApiV1SchedulersSchedulerShiftsModelsShiftResponseShiftResponse[], required — The shifts
      - `id` string, required — The ID of the shift
      - `color` string, required — The color of the shift
      - `assignedUserIds` integer[] — The IDs of the assigned users
      - `startTime` integer, required — The start time of the shift
      - `endTime` integer, required — The end time of the shift
      - `timezone` string, required — The timezone of the shift
      - `isOpenShift` boolean, required — Whether the shift is an open shift
      - `title` string, required — The title of the shift
      - `jobId` string, nullable — The ID of the job
      - `locationData` LocationDataAPI
        - `isReferencedToJob` boolean, required — Indicates whether the location is referenced to a job. can only be true if job id isn't empty
        - `gps` GpsDataV2
          - `address` string, nullable — The address associated with the GPS data.
          - `longitude` number, nullable — The longitude coordinate.
          - `latitude` number, nullable — The latitude coordinate.
      - `isPublished` boolean, required — Whether the shift is published
      - `isRequireAdminApproval` boolean, nullable — Whether the shift requires admin approval
      - `updateTime` integer, nullable — Integer with minimum value of 1
      - `creationTime` integer, nullable — Integer with minimum value of 1
      - `createdBy` integer, nullable — Integer with minimum value of 1
      - `openSpots` integer, nullable — The number of open spots
      - `notes` union[] — The notes of the shift
        - union
          - HTMLNoteDataOut
            - `type` string — HTML note type
            - `html` string, required — The HTML content of the note
          - AlbumNoteDataOut
            - `type` string — Album note type
            - `album` ImageNoteDataOut[], required — The list of images in the album
              - …
          - FileNoteDataOut
            - `url` string, required — The url of the file to upload
            - `type` string — URL note type
            - `name` string, required — The name of the file
      - `statuses` StatusData[] — The statuses of the shift
        - `statusId` string, required — The ID of the status
        - `status` 'accepted' | 'checked_in' | 'completed' | 'rejected' | 'claimed' | 'claim_requested' | 'unclaimed' | 'unclaim_requested' | 'cancel_claim_request' | 'reset', required
        - `note` string, nullable — The note of the status
        - `attachments` string[], nullable — The attachments of the status
        - `creationTime` integer, nullable — The creation time of the status
        - `updateTime` integer, nullable — The update time of the status
        - `creatingUserId` integer, required — The ID of the user who created the status
        - `modifyingUserId` integer, nullable — The ID of the user who modified the status
        - `gps` GpsDataV2
          - `address` string, nullable — The address associated with the GPS data.
          - `longitude` number, nullable — The longitude coordinate.
          - `latitude` number, nullable — The latitude coordinate.
        - `assignedUserId` integer, nullable — The ID of the user assigned to the status
      - `breaks` ShiftBreakDataApi[] — The breaks of the shift
        - `id` string, required — The id of the break
        - `name` string, required — The name of the break.
        - `type` 'paid' | 'unpaid', required
        - `startTime` integer, nullable — Integer with minimum value of 0
        - `duration` integer, required — The time the break lasts in minutes
      - `shiftDetails` ShiftDetailsOutput, required
        - `shiftLayers` ShiftLayerOutput[] — The various layers of information associated with the shift
          - `id` string, required — The unique identifier of the shift layer
          - `title` string, required — The name of the shift layer
          - `value` ShiftLayerInstanceOutput, required
            - `id` string, required — The unique identifier of the value
            - `displayName` string, required — The name of the value
        - `shiftSource` string, nullable — The source of the shift
      - `customFields` CustomFieldResponseV2[] — The shift's custom fields
        - `customFieldId` integer, required — The custom field unique id
        - `value` unknown, required
        - `type` 'email' | 'date' | 'phone' | 'number' | 'str' | 'dropdown' | 'file' | 'directManager' | 'birthday' | 'link' | 'location', required
        - `name` string, required — The custom field name
  - `paging` PagingResponseModelV2, required
    - `offset` integer, required — The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results
    - `total` integer, nullable — Total number of resources matching the request, ignoring pagination. Use this to retrieve the full count without paginating through every page. Only populated by endpoints that compute it.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/connecteam/apis/connecteam-api-documentation.md) · [All operations](https://skmtc.net/connecteam/apis/connecteam-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/connecteam/connecteam-api-documentation/versions/d8f7f302222e/schema)