Get one time entry

Returns a TimeEntry object containing information about one employee shift. The information includes the shift start time, end time, and the start and end times of break periods.

Securityoauth2
Request
path Parameters
timeEntryId
required
string <string>

The Toast platform GUID or an external identifier for the time entry.

query Parameters
includeArchived
boolean

Controls whether the response includes an archived time entry. Optional.

includeMissedBreaks
boolean

Optional flag to indicate whether missed breaks should be returned in the breaks array for the time entries.

header Parameters
Toast-Restaurant-External-ID
required
string <string>

The Toast platform GUID of the restaurant that is the context for this operation.

Responses
200

Returns the specified time entry.

400

The GUID or external identifier was malformed.

500

An unexpected internal error occurred. There is a requestId attached to this error that can be referenced by Toast support.

get/timeEntries/{timeEntryId}
Request samples
curl -i -X GET \
  'https://toast-api-server/labor/v1/timeEntries/{timeEntryId}?includeArchived=true&includeMissedBreaks=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: string'
Response samples
application/json
{
  • "guid": "string",
  • "entityType": "string",
  • "externalId": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "deletedDate": "2019-08-24T14:15:22Z",
  • "deleted": true,
  • "jobReference": {
    },
  • "employeeReference": {
    },
  • "shiftReference": {
    },
  • "inDate": "2019-08-24T14:15:22Z",
  • "outDate": "2019-08-24T14:15:22Z",
  • "autoClockedOut": true,
  • "businessDate": "string",
  • "regularHours": 0,
  • "overtimeHours": 0,
  • "hourlyWage": 0,
  • "breaks": [
    ],
  • "declaredCashTips": 0,
  • "nonCashTips": 0,
  • "cashGratuityServiceCharges": 0,
  • "nonCashGratuityServiceCharges": 0,
  • "tipsWithheld": 0,
  • "nonCashSales": 0,
  • "cashSales": 0
}