Toast
App · 24 actions
Read restaurant configuration, menus, orders, employees, jobs, shifts and time entries.
Actions
| Action | What it does |
|---|---|
| Get discounts | Get discounts. |
| Get employee | Get employee. |
| Get employees | Get employees. |
| Get job | Get job. |
| Get jobs | Get jobs. |
| Get menu metadata | Get menu metadata. |
| Get menus | Get menus. |
| Get order | Get order. |
| Get order identifiers (deprecated) | Get order identifiers (deprecated). |
| Get pre-modifiers | Get pre-modifiers. |
| Get restaurant | Get restaurant. |
| Get shifts | Get shifts. |
| Get time entry | Get time entry. |
| List alternate payment types | List alternate payment types. |
| List break types | List break types. |
| List cash drawers | List cash drawers. |
| List complete orders | List complete orders. |
| List dining options | List dining options. |
| List menu groups | List menu groups. |
| List menu items | List menu items. |
| List menu option groups | List menu option groups. |
| List no-sale reasons | List no-sale reasons. |
| List premodifier groups | List premodifier groups. |
| List time entries | List time entries. |
Get discounts
Get discounts.
Inputs
- PageToken
pageTokentext - A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the `pageToken` parameter from the `Toast-Next-Page-Token` header field value of a previous request to the endpoint. For more information, see <a href="https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html">Paginating response data</a>.
- LastModified
lastModifieddate and time - Limits the return data to objects created or modified after a specific date and time. For example: `2024-06-20T00:00:00.000%2B0000`.
Outputs
datalist- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}Get employee
Get employee.
Inputs
- EmployeeId
employeeIdtextRequired - The Toast platform GUID or external identifier for the employee to be returned.
Outputs
dataobject- A restaurant employee
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": {
"chosenName": "example",
"createdDate": "2026-01-01T00:00:00Z",
"deleted": false,
"deletedDate": "2026-01-01T00:00:00Z",
"email": "example",
"entityType": "example",
"externalEmployeeId": "example",
"externalId": "example",
"firstName": "example",
"guid": "example",
"jobReferences": [],
"lastName": "example",
"modifiedDate": "2026-01-01T00:00:00Z",
"passcode": "example",
"phoneNumber": "example",
"phoneNumberCountryCode": "example",
"v2EmployeeGuid": "example",
"wageOverrides": []
},
"has_more": false,
"next_cursor": "example"
}Get employees
Get employees.
Inputs
- EmployeeIds
employeeIdslist - An optional identifier that filters return values for a specific employee. The identifier can be a Toast platform GUID or an external identifier. If present, the `employees` resource will only return the employees you specify. You can include multiple `employeeIds` query parameters (maximum 100). If not present, the resource returns each employee for the restaurant.
Outputs
datalist- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}Get job
Get job.
Inputs
- JobId
jobIdtextRequired - The Toast platform GUID or an external identifier for the job.
Outputs
dataobject- A restaurant job.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": {
"code": "example",
"createdDate": "2026-01-01T00:00:00Z",
"defaultWage": 0,
"deleted": false,
"deletedDate": "2026-01-01T00:00:00Z",
"entityType": "example",
"excludeFromReporting": false,
"externalId": "example",
"guid": "example",
"modifiedDate": "2026-01-01T00:00:00Z",
"tipped": false,
"title": "example",
"wageFrequency": "HOURLY"
},
"has_more": false,
"next_cursor": "example"
}Get jobs
Get jobs.
Inputs
- JobIds
jobIdslist - An optional array of one or more job identifiers, either the Toast platform GUID or an external identifier assigned by the client. 100 max. If not provided, all jobs known to the Toast platform for this restaurant will be returned.
Outputs
datalist- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}Get menu metadata
Get menu metadata.
Inputs
None.
Outputs
dataobject- Information about the last date and time that this restaurant's menu data was updated.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": {
"lastUpdated": "example",
"restaurantGuid": "11111111-1111-4111-8111-111111111111"
},
"has_more": false,
"next_cursor": "example"
}Get menus
Get menus.
Inputs
None.
Outputs
dataobject- Information about the restaurant whose menu data has been retrieved.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": {
"lastUpdated": "example",
"menus": [],
"modifierGroupReferences": {
"identifier": 0
},
"modifierOptionReferences": {
"identifier": 0
},
"preModifierGroupReferences": {
"identifier": 0
},
"restaurantGuid": "11111111-1111-4111-8111-111111111111",
"restaurantTimeZone": "example"
},
"has_more": false,
"next_cursor": "example"
}Get order
Get order.
Inputs
- Guid
guidtextRequired - The GUID for the order to be returned.
Outputs
dataobject- A Toast platform order is composed of one or more checks. Each check has one or more menu item selections. The `externalId` value for an order must be unique. If you submit an order with an `externalId` that already exists for another order, the request will fail. You can use this behavior to implement idempotent order submission by always providing a consistent `externalId` for each unique order attempt.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": {
"appliedPackagingInfo": {
"appliedPackagingItems": [],
"entityType": "example",
"guid": "example"
},
"approvalStatus": "NEEDS_APPROVAL",
"businessDate": 0,
"calculatedGuestCount": 0,
"channelGuid": "11111111-1111-4111-8111-111111111111",
"checks": [],
"closedDate": "2026-01-01T00:00:00Z",
"createdByClientName": "example",
"createdDate": "2026-01-01T00:00:00Z",
"createdDevice": {
"id": "example"
},
"createdInTestMode": false,
"curbsidePickupInfo": {
"entityType": "example",
"guid": "example",
"notes": "example",
"transportColor": "example",
"transportDescription": "example"
},
"deleted": false,
"deletedDate": "2026-01-01T00:00:00Z",
"deliveryInfo": {
"address1": "example",
"address2": "example",
"administrativeArea": "example",
"city": "example",
"country": "example",
"deliveredDate": "2026-01-01T00:00:00Z",
"deliveryEmployee": {
"entityType": "example",
"externalId": "example",
"guid": "example"
},
"deliveryState": "PENDING",
"dispatchedDate": "2026-01-01T00:00:00Z",
"latitude": 0,
"longitude": 0,
"notes": "example",
"state": "example",
"zipCode": "example"
},
"diningOption": {
"entityType": "example",
"externalId": "example",
"guid": "example"
},
"displayNumber": "example",
"duration": 0,
"entityType": "example",
"estimatedFulfillmentDate": "2026-01-01T00:00:00Z",
"excessFood": false,
"externalId": "example",
"guid": "example",
"lastModifiedDevice": {
"id": "example"
},
"marketplaceFacilitatorTaxInfo": {
"facilitatorCollectAndRemitTaxOrder": false,
"taxes": []
},
"modifiedDate": "2026-01-01T00:00:00Z",
"numberOfGuests": 0,
"openedDate": "2026-01-01T00:00:00Z",
"paidDate": "2026-01-01T00:00:00Z",
"pricingFeatures": [],
"promisedDate": "2026-01-01T00:00:00Z",
"requiredPrepTime": "example",
"restaurantService": {
"entityType": "example",
"externalId": "example",
"guid": "example"
},
"revenueCenter": {
"entityType": "example",
"externalId": "example",
"guid": "example"
},
"server": {
"entityType": "example",
"externalId": "example",
"guid": "example"
},
"serviceArea": {
"entityType": "example",
"externalId": "example",
"guid": "example"
},
"source": "example",
"table": {
"entityType": "example",
"externalId": "example",
"guid": "example"
},
"thirdPartyProviderInfo": {
"entityType": "example",
"externalVoidReason": "example",
"guid": "example"
},
"voidBusinessDate": 0,
"voidDate": "2026-01-01T00:00:00Z",
"voided": false
},
"has_more": false,
"next_cursor": "example"
}Get order identifiers (deprecated)
Get order identifiers (deprecated).
Inputs
- StartDate
startDatedate and time - \ The inclusive start date and time. The results exclude orders with an earlier modified date and time. Use ISO-8601 format for the date and time, including a decimal fraction of a second. For example, `2016-01-01T14:13:12.000+0400`. URL encode the date and time value. The date must be after 2015-12-01T00:00:00.000+0000.
- EndDate
endDatedate and time - The exclusive end date and time. The results exclude orders with an equal or later modified date and time. Use ISO-8601 format for the date and time, including a decimal fraction of a second. For example, `2016-01-01T14:13:12.000+0400`. URL encode the date and time value. The `endDate` date and time must be later than the `startDate` parameter value.
- BusinessDate
businessDatedate - The business date that same-day orders opened or that scheduled orders are promised, in the format `yyyyMMdd`. The business day of an order is determined by the time the order is opened or promised in the local time zone, and by the restaurant's business day cutoff time, which is available from the `General` object of the restaurants API in the `closeoutHour` property.
Outputs
datalist- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}Get pre-modifiers
Get pre-modifiers.
Inputs
- PageToken
pageTokentext - A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the `pageToken` parameter from the `Toast-Next-Page-Token` header field value of a previous request to the endpoint. For more information, see <a href="https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html">Paginating response data</a>.
- LastModified
lastModifieddate and time - Limits the return data to objects created or modified after a specific date and time. For example: `2024-06-20T00:00:00.000%2B0000`.
Outputs
datalist- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}Get restaurant
Get restaurant.
Inputs
- IncludeArchived
includeArchivedtrue/false - Set `includeArchived` to `true` if the API should return information about the restaurant even if it is archived. The `General` object in the response includes an `archived` value that your integration can use to determine whether a restaurant is archived or not. A common reason for a restaurant being archived is if it was created in error. Set `includeArchived` to `false` if the API should _not_ return information about the restaurant if it is archived. Defaults to `false` if omitted.
Outputs
dataobject- Information about the configuration of a restaurant in the Toast POS.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": {
"delivery": {
"area": "example",
"enabled": false,
"minimum": 0
},
"general": {
"archived": false,
"closeoutHour": 0,
"currencyCode": "example",
"description": "example",
"firstBusinessDate": 0,
"locationCode": "example",
"locationName": "example",
"managementGroupGuid": "example",
"name": "example",
"timeZone": "example"
},
"guid": "example",
"location": {
"address1": "example",
"address2": "example",
"administrativeArea": "example",
"city": "example",
"country": "example",
"latitude": 0,
"longitude": 0,
"phone": "example",
"phoneCountryCode": "example",
"stateCode": "example",
"zipCode": "example"
},
"onlineOrdering": {
"enabled": false,
"paymentOptions": {
"ccTip": false,
"delivery": {
"cash": false,
"ccFuture": false,
"ccSameDay": false
},
"takeout": {
"cash": false,
"ccFuture": false,
"ccInStore": false,
"ccSameDay": false
}
},
"scheduling": false,
"specialRequests": false,
"specialRequestsMessage": "example"
},
"prepTimes": {
"deliveryPrepTime": 0,
"deliveryThrottlingTime": 0,
"deliveryTimeAfterOpen": 0,
"deliveryTimeBeforeClose": 0,
"takeoutPrepTime": 0,
"takeoutThrottlingTime": 0,
"takeoutTimeAfterOpen": 0,
"takeoutTimeBeforeClose": 0
},
"schedules": {
"daySchedules": {
"identifier": "example"
},
"weekSchedule": {
"friday": "example",
"monday": "example",
"saturday": "example",
"sunday": "example",
"thursday": "example",
"tuesday": "example",
"wednesday": "example"
}
},
"urls": {
"checkGiftCard": "example",
"facebook": "example",
"orderOnline": "example",
"purchaseGiftCard": "example",
"twitter": "example",
"website": "example"
}
},
"has_more": false,
"next_cursor": "example"
}Get shifts
Get shifts.
Inputs
- ShiftIds
shiftIdslist - An optional identifier that filters return values for a specific shift. The identifier can be a Toast platform GUID or an external identifier. If present, the shifts resource will only return the shifts you specify. You can include multiple `shiftIds` query parameters (maximum 100).
- StartDate
startDatedate and time - Optional start date and time of time period to match shifts. A shift matches the time period if the shift `inDate` is after (inclusive) the specified `startDate` and the shift `outDate` is before the `endDate` (exclusive). These parameters are required if the `shiftIds` parameter is not defined. The specified period cannot be longer than one month.
- EndDate
endDatedate and time - Optional end date and time of time period to match shifts. A shift matches the time period if the shift `inDate` is after (inclusive) the specified `startDate` and the shift `outDate` is before the `endDate` (exclusive). These parameters are required if the `shiftIds` parameter is not defined. The specified period cannot be longer than one month.
Outputs
datalist- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}Get time entry
Get time entry.
Inputs
- TimeEntryId
timeEntryIdtextRequired - The Toast platform GUID or an external identifier for the time entry.
- IncludeMissedBreaks
includeMissedBreakstrue/false - Optional flag to indicate whether missed breaks should be returned in the breaks array for the time entries.
- IncludeArchived
includeArchivedtrue/false - Controls whether the response includes an archived time entry. Optional.
Outputs
dataobject- A `TimeEntry` captures the actual time an employee worked or took a break. Typically, a time entry is one-to-one with a scheduled shift, but it is possible in the Toast platform for an employee to clock-in and clock-out without a shift.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": {
"autoClockedOut": false,
"breaks": [],
"businessDate": "example",
"cashGratuityServiceCharges": 0,
"cashSales": 0,
"createdDate": "2026-01-01T00:00:00Z",
"declaredCashTips": 0,
"deleted": false,
"deletedDate": "2026-01-01T00:00:00Z",
"employeeReference": {
"entityType": "example",
"externalId": "example",
"guid": "example"
},
"entityType": "example",
"externalId": "example",
"guid": "example",
"hourlyWage": 0,
"inDate": "2026-01-01T00:00:00Z",
"jobReference": {
"entityType": "example",
"externalId": "example",
"guid": "example"
},
"modifiedDate": "2026-01-01T00:00:00Z",
"nonCashGratuityServiceCharges": 0,
"nonCashSales": 0,
"nonCashTips": 0,
"nonCashTipsRoundingLoss": 0,
"outDate": "2026-01-01T00:00:00Z",
"overtimeHours": 0,
"regularHours": 0,
"shiftReference": {
"entityType": "example",
"externalId": "example",
"guid": "example"
},
"tipsWithheld": 0
},
"has_more": false,
"next_cursor": "example"
}List alternate payment types
List alternate payment types.
Inputs
- PageToken
pageTokentext - A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the `pageToken` parameter from the `Toast-Next-Page-Token` header field value of a previous request to the endpoint. For more information, see <a href="https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html">Paginating response data</a>.
- LastModified
lastModifieddate and time - Limits the return data to objects created or modified after a specific date and time. For example: `2024-06-20T00:00:00.000%2B0000`.
Outputs
datalist- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List break types
List break types.
Inputs
- PageToken
pageTokentext - A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the `pageToken` parameter from the `Toast-Next-Page-Token` header field value of a previous request to the endpoint. For more information, see <a href="https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html">Paginating response data</a>.
- LastModified
lastModifieddate and time - Limits the return data to objects created or modified after a specific date and time. For example: `2024-06-20T00:00:00.000%2B0000`.
Outputs
datalist- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List cash drawers
List cash drawers.
Inputs
- PageToken
pageTokentext - A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the `pageToken` parameter from the `Toast-Next-Page-Token` header field value of a previous request to the endpoint. For more information, see <a href="https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html">Paginating response data</a>.
- LastModified
lastModifieddate and time - Limits the return data to objects created or modified after a specific date and time. For example: `2024-06-20T00:00:00.000%2B0000`.
Outputs
datalist- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List complete orders
List complete orders.
Inputs
- StartDate
startDatedate and time - The inclusive start date and time. The results include orders with a modified date and time that occur at or after the `startDate`, but before the `endDate`. Use ISO-8601 format for the date and time, including a decimal fraction of a second. For example, `2016-01-01T14:13:12.000+0400`. URL encode the date and time value. The date must be after 2015-12-01T00:00:00.000+0000.
- EndDate
endDatedate and time - The exclusive end date and time. The results exclude any orders that have a modified date and time that occurs at or after `endDate`. Use ISO-8601 format for the date and time, including a decimal fraction of a second. For example, `2016-01-01T14:13:12.000+0400`. URL encode the date and time value. The `endDate` date and time must be later than the `startDate` parameter value.
- BusinessDate
businessDatedate - The business date that same-day orders opened or that scheduled orders are promised, in the format `yyyymmdd`. The business day of an order is determined by the time the order is opened or promised in the local time zone, and the restaurant's business day cutoff time, which is available from the `General` object of the restaurants API in the `closeoutHour` property.
- PageSize
pageSizenumber - The maximum number of objects to return in the array. If the number of objects selected by your request is greater than the `pageSize`, the API uses response pagination for the remaining objects. The maximum `pageSize` is `100`. For more information, see [the _Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html).
- Page
pagenumber - The sequence number of the set of objects to return in paginated response data. For example, if you set the `pageSize` parameter to `10`, and you set `page` to `2`, the API returns a set of objects that starts with the eleventh object. For more information, see [the _Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html).
Outputs
datalist- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List dining options
List dining options.
Inputs
- PageToken
pageTokentext - A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the `pageToken` parameter from the `Toast-Next-Page-Token` header field value of a previous request to the endpoint. For more information, see <a href="https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html">Paginating response data</a>.
- LastModified
lastModifieddate and time - Limits the return data to objects created or modified after a specific date and time. For example: `2024-06-20T00:00:00.000%2B0000`.
Outputs
datalist- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List menu groups
List menu groups.
Inputs
- PageToken
pageTokentext - A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the `pageToken` parameter from the `Toast-Next-Page-Token` header field value of a previous request to the endpoint. For more information, see <a href="https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html">Paginating response data</a>.
- LastModified
lastModifieddate and time - Limits the return data to objects created or modified after a specific date and time. For example: `2024-06-20T00:00:00.000%2B0000`.
Outputs
datalist- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List menu items
List menu items.
Inputs
- PageToken
pageTokentext - A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the `pageToken` parameter from the `Toast-Next-Page-Token` header field value of a previous request to the endpoint. For more information, see <a href="https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html">Paginating response data</a>.
- LastModified
lastModifieddate and time - Limits the return data to objects created or modified after a specific date and time. For example: `2024-06-20T00:00:00.000%2B0000`.
Outputs
datalist- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List menu option groups
List menu option groups.
Inputs
- PageToken
pageTokentext - A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the `pageToken` parameter from the `Toast-Next-Page-Token` header field value of a previous request to the endpoint. For more information, see <a href="https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html">Paginating response data</a>.
- LastModified
lastModifieddate and time - Limits the return data to objects created or modified after a specific date and time. For example: `2024-06-20T00:00:00.000%2B0000`.
Outputs
datalist- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List no-sale reasons
List no-sale reasons.
Inputs
- PageToken
pageTokentext - A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the `pageToken` parameter from the `Toast-Next-Page-Token` header field value of a previous request to the endpoint. For more information, see <a href="https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html">Paginating response data</a>.
- LastModified
lastModifieddate and time - Limits the return data to objects created or modified after a specific date and time. For example: `2024-06-20T00:00:00.000%2B0000`.
Outputs
datalist- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List premodifier groups
List premodifier groups.
Inputs
- PageToken
pageTokentext - A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the `pageToken` parameter from the `Toast-Next-Page-Token` header field value of a previous request to the endpoint. For more information, see <a href="https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html">Paginating response data</a>.
- LastModified
lastModifieddate and time - Limits the return data to objects created or modified after a specific date and time. For example: `2024-06-20T00:00:00.000%2B0000`.
Outputs
datalist- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}List time entries
List time entries.
Inputs
- TimeEntryIds
timeEntryIdslist - Optional array of one or more time entry identifiers, either the Toast platform GUID or an external identifier. 100 max.
- StartDate
startDatedate and time - Optional start date and time of time period to match time entries. A time entry matches the time period if its clock-in `inDate` is after (inclusive) the specified `startDate` and before (exclusive) the `endDate`. The specified period cannot be longer than one month.
- EndDate
endDatedate and time - Optional end date and time of time period to match time entries. A time entry matches the time period if its clock-in `inDate` is after (inclusive) the specified `startDate` and before (exclusive) the `endDate`. The specified period cannot be longer than one month.
- ModifiedStartDate
modifiedStartDatedate and time - Start date and time of the time period to match modified time entries. A time entry matches the time period if that entry was modified after (inclusive) the `modifiedStartDate`. If you include this parameter, you must also include the `modifiedEndDate` parameter. The specified period cannot be longer than one month.
- ModifiedEndDate
modifiedEndDatedate and time - End date and time of the time period to match modified time entries. A time entry matches the time period if that entry was modified before (exclusive) the `modifiedEndDate`. If you include this parameter, you must also include the `modifiedStartDate` parameter. The specified period cannot be longer than one month.
- BusinessDate
businessDatedate - Optional date to match time entries. A time entry matches the business date if its clock-in `inDate` is during the business date. The cutoff from one `businessDate` to the next is the `closeoutHour` for the restaurant.
- IncludeMissedBreaks
includeMissedBreakstrue/false - Optional flag to indicate whether missed breaks should be returned in the breaks array for the time entries.
- IncludeArchived
includeArchivedtrue/false - Controls whether the response includes archived time entries, when using the `startDate` and `endDate` parameters. **Important**: this parameter _has no effect_ if you use the `modifiedStartDate` and `modifiedEndDate` parameters or the `businessDate` parameter to select time entries. * Querying by modified date range _always_ returns archived time entries. * Querying by businessDate _never_ returns archived time entries. This parameter is optional and the default value is `false`.
Outputs
datalist- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Continuation token for the next page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": "example"
}