LIlightspeed
Staff

Get Shifts

Changed on
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

businessLocationIdinteger required

The unique identifier for the business location.

Query parameters

pageinteger

The page number, when paginating.

sizeinteger

Number of results to return per page, when paginating.

sortstring[]

Sort by field and direction.

startTimestring date-time

Show results after this start time. The format should be yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format).

endTimestring date-time

Show results before this end time. The format should be yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format).

staffIdinteger

Filter on the unique identifier for the user.

Response

List of shifts with related links.

Example response

{
  "data": {
    "shifts": [
      {
        "uuid": "REcdfpCwQJKUR53gdzIk5Q==",
        "businessId": 12345,
        "businessLocationId": 1234567890,
        "deviceId": 54321,
        "staffId": 1234,
        "declaredCashTips": "10.00",
        "dateInUTC": "2020-01-01T00:00:00Z",
        "events": [
          {
            "uuid": "REcdfpCwQJKUR53gdzIk5Q==",
            "timestamp": "2020-01-01T00:00:00Z",
            "createdOn": "2020-01-01T00:00:00Z"
          }
        ]
      }
    ]
  },
  "links": {
    "first": {
      "href": "https://api-trial.ikentoo.com/staff/v1/businessLocations/40570261078018/userTypes/POS?page=1&size=1&sort=userId,desc"
    },
    "self": {
      "href": "https://api-trial.ikentoo.com/staff/v1/businessLocations/40570261078018/userTypes/POS?page=1&size=1&sort=userId,desc"
    },
    "next": {
      "href": "https://api-trial.ikentoo.com/staff/v1/businessLocations/40570261078018/userTypes/POS?page=2&size=1&sort=userId,desc"
    },
    "last": {
      "href": "https://api-trial.ikentoo.com/staff/v1/businessLocations/40570261078018/userTypes/POS?page=5&size=1&sort=userId,desc"
    }
  },
  "page": {
    "page": 1,
    "size": 10,
    "totalElements": 100,
    "totalPages": 10
  }
}

Changes

  • 707b55d222abRevision changes
    • warning

      deleted the query request parameter endDate

    • warning

      deleted the query request parameter startDate

    • info

      added the new optional query request parameter endTime

    • info

      added the new optional query request parameter startTime

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ////// to the response with the status

  • 4c87668cd4ddRevision changes
    • warning

      deleted the query request parameter endTime

    • warning

      deleted the query request parameter startTime

    • info

      api tag Staff added

    • info

      api tag Shift removed

    • info

      added the new optional query request parameter endDate

    • info

      added the new optional query request parameter startDate