v1

latestOpenAPI 3.1.02026-08-06911,228852.2 KB

Staff

Get Shifts

get/staff/v1/businessLocations/{businessLocationId}/shift

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