Get restaurants in a management group

Returns an array of Restaurant objects that are a part of the restaurant management group you specify in the managementGroupGUID path parameter. Each Restaurant object contains the unique Toast platform identifier for the restaurant in its guid value.

Securityoauth2

Request

path Parameters

• managementGroupGUID required:
  string

  The GUID of the restaurant management group.

header Parameters

• Toast-Restaurant-External-ID required:
  string <string>

  The Toast GUID of one restaurant location in the management group.

Responses

200

An array of Restaurant objects.

get /groups/{managementGroupGUID}/restaurants

Request samples

curl -i -X GET \
  'https://toast-api-server/restaurants/v1/groups/{managementGroupGUID}/restaurants' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: string'

Response samples

application/json

[
  {
    "guid": "string"
  }
]