---
title: "Get Shifts"
method: GET
path: "/staff/v1/businessLocations/{businessLocationId}/shift"
tags: ["Staff"]
---

# Get Shifts

`GET /staff/v1/businessLocations/{businessLocationId}/shift`

## Request

- Base URL: `https://api.trial.lsk.lightspeed.app`
- URL: `https://api.trial.lsk.lightspeed.app/staff/v1/businessLocations/{businessLocationId}/shift`
- Auth: OAuth 2
  - Authorization code: `https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/auth`
  - Token URL: `https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/token` scopes: `staff-api`

## Path parameters

- `businessLocationId` integer, required

## Query parameters

- `page` integer
- `size` integer
- `sort` string[]
- `startTime` string, date-time
- `endTime` string, date-time
- `staffId` integer

## Response `200`

List of shifts with related links.

- object
  - `data` object
    - `shifts` StaffApiShift[]
      - `uuid` string: The unique identifier for the shift.
      - `businessId` integer: The unique identifier for the business.
      - `businessLocationId` integer: The unique identifier for the business location.
      - `deviceId` integer: The unique identifier for the device.
      - `staffId` integer: The unique identifier for the user.
      - `declaredCashTips` string: The declared tips for the shift.
      - `dateInUTC` string, date-time: The timestamp of the last update to the shift.
      - `events` StaffApiEvent[]: List of events during the shift.
        - `uuid` string: The unique identifier for the event.
        - `timestamp` string, date-time: The time of the event.
        - `createdOn` string, date-time: The creation time of the event.
        - `eventType` 'CLOCK_IN' | 'CLOCK_OUT': The type of event.
  - `links` object
    - `first` object
      - `href` string, uri: The URL for the first page of results.
    - `self` object
      - `href` string, uri: The URL for the current page of results.
    - `next` object
      - `href` string, uri: The URL for the next page of results.
    - `last` object
      - `href` string, uri: The URL for the last page of results.
  - `page` StaffApiPageInfo
    - `page` integer: The current page number.
    - `size` integer: The number of elements in the page.
    - `totalElements` integer: The total number of elements.
    - `totalPages` integer: The total number of pages of results.

## Changes

> 31 revisions in range; 1 not diffed.

- **2025-01-21** `707b55d222ab`: 2 warning, 4 info
  - deleted the `query` request parameter `endDate`
  - deleted the `query` request parameter `startDate`
  - added the new optional `query` request parameter `endTime`
  - added the new optional `query` request parameter `startTime`
  - …2 more
- **2024-09-15** `4c87668cd4dd`: 2 warning, 4 info
  - deleted the `query` request parameter `endTime`
  - deleted the `query` request parameter `startTime`
  - api tag `Staff` added
  - api tag `Shift` removed
  - …2 more
- **2024-07-22** `f0328406dcdb`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api/changes/staff/v1/businessLocations/:businessLocationId/shift/get.md)

---

[API](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api.md) - [All operations](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api/llms.txt) - [OpenAPI document](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api/revisions/af001485cf2b?raw)