Get restaurant configuration information

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

Securityoauth2
Request
path Parameters
restaurantGUID
required
string

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

query Parameters
includeArchived
boolean
Default: 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.

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.

404

If the restaurant GUID you provided is invalid, the API will return an HTTP 404 response. The API will also return an HTTP 404 response if you provided the GUID of an archived restaurant and you have not set the includeArchived query parameter to true.

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