Get Shifts

GET /staff/v1/businessLocations/{businessLocationId}/shift
O auth2

Path parameters

Query parameters

  • page integer(int32)

    The page number, when paginating.

    Minimum value is 1. Default value is 1.

  • size integer(int32)

    Number of results to return per page, when paginating.

    Minimum value is 1. Default value is 10.

  • sort array[string]

    Sort by field and direction.

    Default value is ["date,desc"].

  • startTime string(date-time)

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

  • endTime string(date-time)

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

  • staffId integer(int64)

    Filter on the unique identifier for the user.

Responses

  • 200 application/json

    List of shifts with related links.

    Hide response attributes Show response attributes object
    • data object
      Hide data attribute Show data attribute object
      • shifts array[object]

        Shift details.

        Hide shifts attributes Show shifts attributes object
        • uuid string

          The unique identifier for the shift.

        • businessId integer(int64)

          The unique identifier for the business.

        • businessLocationId integer(int64)

          The unique identifier for the business location.

        • deviceId integer(int64)

          The unique identifier for the device.

        • staffId integer(int64)

          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 array[object]

          List of events during the shift.

          Shift event such as clock in/out, please use the newest one when multiple events existing with same event type.

          Hide events attributes Show events attributes object
          • 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 string

            The type of event.

            Values are CLOCK_IN or CLOCK_OUT.

    • links object
      Hide links attributes Show links attributes object
      • first object
        Hide first attribute Show first attribute object
        • href string(uri)

          The URL for the first page of results.

      • self object
        Hide self attribute Show self attribute object
        • href string(uri)

          The URL for the current page of results.

      • next object
        Hide next attribute Show next attribute object
        • href string(uri)

          The URL for the next page of results.

      • last object
        Hide last attribute Show last attribute object
        • href string(uri)

          The URL for the last page of results.

    • page object
      Hide page attributes Show page attributes object
      • 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.
GET /staff/v1/businessLocations/{businessLocationId}/shift 
curl \
 --request GET 'https://api.trial.lsk.lightspeed.app/staff/v1/businessLocations/{businessLocationId}/shift' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "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",
            "eventType": "CLOCK_IN"
          }
        ]
      }
    ]
  },
  "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
  }
}