Get restaurant configuration information

Returns a RestaurantInfo object that contains detailed information about the configuration of a restaurant.

Request
path Parameters
restaurantGUID
required
string

The Toast GUID of the restaurant that you want to get information about.

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

The Toast GUID of the restaurant that you want to get information about.

Responses
200

A RestaurantInfo object that contains detailed information about the configuration of a restaurant.

get/restaurants/{restaurantGUID}
Request samples
curl -i -X GET \
  'https://toast-api-server/restaurants/v1/restaurants/{restaurantGUID}' \
  -H 'Toast-Restaurant-External-ID: string'
Response samples
application/json
{
  • "guid": "string",
  • "general": {
    },
  • "urls": {
    },
  • "location": {
    },
  • "schedules": {
    },
  • "delivery": {
    },
  • "onlineOrdering": {
    },
  • "prepTimes": {
    }
}