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.

How to make the request

You send a GET request to the /restaurants endpoint of the Toast partners API.

https://[toast-api-hostname]/partners/v1/restaurants

Note

The /restaurants endpoint uses the same rate limiting functionality as other Toast API endpoints. For more information, see Rate limiting.

To get information about the restaurants you have access to

  1. Authenticate with the Toast user management service using a partner API account. For more information, see Authentication and restaurant access.

  2. Send a GET request to the /restaurants endpoint of the partners API.

    Optionally, include the lastModified parameter to limit the return data to restaurants created or modified after a specific date and time. The date and time must be a UTC timestamp in ISO 8601 format, for example: 2020-03-01T00:00:00.000-0000.

    You must URL encode the timestamp before sending it in a request. For example, 2020-03-01T00%3A00%3A00.000%2B0000.

  3. Review the information about each restaurant that you have access to in the JSON data that the /restaurants endpoint returns.

    The GUID for a restaurant is in the restaurantGuid value of the return data. The GUID is a unique identifier. You use the Toast platform GUID for a restaurant when you make Toast API requests for that restaurant.