The Shifts endpoint contains information related to the ongoing and completed work shifts. It includes time entries (clock in/clock out), the type of work, and earnings. The Shifts is related to the link_id from Truv's Income and Employment API.
Attributes
The attributes of the Shifts:
Attribute | Type | Description |
---|---|---|
count | integer | The number of results in total |
next | string | Link to the next page |
previous | string | Link to the previous page |
results | array of objects | The result of the list of the shifts |
id | string | The unique ID of the shifts |
external_id | string | The external ID of the selected shifts |
created_at | string | The shift creation timestamp |
updated_at | string | The shift update timestamp |
start_date | string | The start date of the shift |
end_date | string | The end date of the shift |
time_entries | array of objects | The list of time entries related to the shift |
id | string | The unique time entry ID |
external_id | string | The time entry external ID |
created_at | string | The time entry creation timestamp |
updated_at | string | The time entry update timestamp |
entry_date | string | The entry date of the vent in the time tracking system |
start | string | The date and time when the work shift started |
end | string | The date and time when the work shift ended |
earnings | array of objects | The aggregated earnings for the shift |
type | string | The type of the shift. There are four types of shifts: - Other - Delivery - Rideshare - Shift |
Endpoints
The available endpoint list of Shifts:
Endpoint |
---|
List Shifts - GET/link/{link_id}/shifts |
Sample Object
The example object returned by the List Shifts Endpoint:
{
"count": 0,
"next": null,
"previous": null,
"results": []
}