Getting a list of restaurants in a management group

You can use the /era/v1/restaurants-information endpoint of the analytics API to retrieve a list of the restaurants and their statuses in the management group associated with your account. This list includes the restaurantGuid and the restaurantName, and the restaurant statuses for active, testMode, and archived.

• The restaurantGuid is the unique GUID assigned to the restaurant by the Toast platform.

• The restaurantName is the restaurant’s name.

• The active value indicates whether the restaurant is activated or not. A true value indicates the restaurant is activated, while a false value indicates the restaurant is deactivated.

• The testMode value indicates whether the restaurant is in test mode or not. A true value indicates the restaurant is in test mode, while a false value indicates the restaurant is not in test mode.

• The archived value indicates whether the restaurant is archived or not. A true value indicates the restaurant is archived, while a false value indicates the restaurant is not archived. A common reason for archiving a restaurant is if the restaurant was created in error.

The restaurantGuid is the unique GUID assigned to the restaurant by the Toast platform. The restaurantName is the restaurant’s name.

The rate limit for this endpoint and method type is five requests per second and 30 requests per minute. For more information about API rate limits for the analytics API, see Analytics API rate limits.

Request for restaurant information

The following example shows a curl command that sends a GET request to the /era/v1/restaurants-information endpoint.

curl -X GET 'https://[toast-api-hostname]/era/v1/restaurants-information' \(1)
-H 'Authorization: Bearer [token]'(2)

• (1):

  Send a GET request to the /era/v1/restaurants-information endpoint of the analytics API.

• (2):

  Include an authentication token. For more information, see Authentication and restaurant access.

Response to the request for restaurant information

The following example shows the response from the /era/v1/restaurants-information endpoint.

[
    {
        "restaurantGuid": "95a96d7b-dbf5-46d3-98c5-c65c8ad18021",(1)
        "restaurantName": "Grove Place Cafe"(2)
        "active": true,(3)
        "testMode": false,(4)
        "archived": false(5)
    },
    {
        "restaurantGuid": "b6bae410-1316-4d3b-b01f-47a758811db2",
        "restaurantName": "Summer Street Cafe"
        "active": true,
        "testMode": false,
        "archived": false
    },
    {
        "restaurantGuid": "b6108638-ed33-4a26-b78d-37a9ae68f71f",
        "restaurantName": "Third Street Cafe"
        "active": false,
        "testMode": true,
        "archived": false
    },
    {
        "restaurantGuid": "43211888-2860-46c7-a8c8-32ba462e1280",
        "restaurantName": "West End Cafe"
        "active": true,
        "testMode": false,
        "archived": false
    }
]

• (1):

  The unique GUID assigned to the restaurant by the Toast platform.

• (2):

  The restaurant’s name.

• (3):

  Indicates whether or not the restaurant is activated. For this example, the restaurant is activated.

• (4):

  Indicates whether or not the restaurant is in test mode. For this example, the restaurant is not in test mode.

• (5):

  Indicates whether or not the restaurant is archived. For this example, the restaurant is not archived.