Retrieve staff member shift state
GET
/api/organizations/{organization_id}/staffmembers/{id}/locations/{location_id}/shift-state
staffmembers
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/organizations//staffmembers//locations//shift-state'Response Response Example
200 - Success
{
"totalShiftTimeToday": 120,
"openShift": {
"id": "shift_001",
"employeeId": "emp_001",
"locationId": "loc_001",
"roleId": "role_001",
"startTime": "2023-10-27T09:00:00Z",
"endTime": null,
"breaks": [],
"hourlyWage": 20,
"totalPaidBreaks": 0,
"totalUnpaidBreaks": 0,
"duration": 0,
"payableDuration": 0,
"utcOffset": -240,
"utcStartTime": "2023-10-27T13:00:00Z",
"utcEndTime": null,
"locked": false,
"active": true,
"createdAt": "2023-10-27T09:00:00Z",
"updatedAt": "2023-10-27T09:00:00Z",
"deletedAt": null
},
"availableBreaks": [
"break_type_001"
]
}Request
Path Params
organization_id
string
required
Example:
org_12345
id
string
required
Example:
emp_001
location_id
string
required
Example:
loc_001