This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

Information in the return data

For each restaurant, the /restaurants return JSON data contains the following values:

Value Description

restaurantGuid

The unique Toast platform identifier for the restaurant.

managementGroupGuid

The unique Toast platform identifier for a group of restaurants. The management group GUID is the same for all restaurants in the same group.

If a restaurant location does not belong to a restaurant management group, then the management group GUID is null.

restaurantName

The human-readable name of the restaurant location.

locationName

The identifier of a specific restaurant location, set on the Restaurant Info screen of the Toast administration back-end.

For example, a restaurant group might assign a location code such as #1234 to a specific location.

createdByEmailAddress

The email address of the restaurant employee who connected the restaurant to the partner or who edited the connection details.

externalGroupRef

An identifier for the restaurant group that is recognized by the partner that made the request to the /restaurants endpoint.

This information is entered by the restaurant administrator. If you need information about the restaurant group in this data string, you instruct the restaurant administrator to enter it in the Toast platform configuration for the integration partner connection.

For more information, see Using location and group identifiers.

externalRestaurantRef

An identifier for the restaurant location that is recognized by the partner that made the request to the /restaurants endpoint.

This information is entered by the restaurant administrator. If you need information about the restaurant location in this data string, you instruct the restaurant administrator to enter it in the Toast platform configuration for the integration partner connection.

For more information, see Using location and group identifiers.

isoCreatedDate

The date and time that the partner connection was created, expressed in ISO 8601 format.

isoModifiedDate

The most recent date and time that the partner connection was edited, expressed in ISO 8601 format.

createdDate

The date and time that the partner connection was created, expressed in milliseconds from the UNIX epoch, January 1, 1970 00:00:00 UTC.

modifiedDate

The most recent date and time that the partner connection was edited, expressed in milliseconds from the UNIX epoch, January 1, 1970 00:00:00 UTC.