The Shifts object

The Shifts endpoint includes time entries such as clock in and clock out, the type of work, and earnings. Shifts is related to the link_id from Truv’s Income and Employment API.

Attributes

The values in the table below cover attributes of Shifts.

Attribute	Type	Description
count	integer	Total number of results
next	string, null	Link to next page
previous	string, null	Link to previous page
results	array of objects	List of shifts
id	string	Unique ID of shifts
external_id	string	External ID of selected shifts
created_at	string	Shift creation timestamp
updated_at	string	Shift update timestamp
start_date	string	Shift start date
end_date	string	Shift end date
time_entries	array of objects	List of shift-related time entries
time_entries[].id	string	Unique time entry ID
time_entries[].external_id	string	Time entry external ID
time_entries[].created_at	string	Time entry creation timestamp
time_entries[].updated_at	string	Time entry update timestamp
time_entries[].entry_date	string	Entry date of event in time tracking system
time_entries[].start	string	Date and time when work shift started
time_entries[].end	string	Date and time when work shift ended
earnings	array of objects	Aggregated earnings for shift
earnings[].name	string	Name of earnings (required)
earnings[].amount	string (decimal)	Amount of earnings (required)
earnings[].category	string	Category of earnings (required), one of: `regular`, `overtime`, `bonus`, `commission`, `other_pay`
earnings[].rate	string (decimal), null	Rate of earnings
earnings[].units	string (decimal), null	Units of earnings
type	string	Type of shift, four types of shifts available: `other`, `delivery`, `rideshare`, `shift`

Endpoint

The item below is the available endpoint for Shifts.

List all shifts

Example response

The response object below is the returned JSON value.

{
  "count": 0,
  "next": null,
  "previous": null,
  "results": []
}

​Attributes

​Endpoint

​Example response

Attributes

Endpoint

Example response