Get connected restaurants

Returns a PaginatedResponse object that contains a paginated array of the restaurants that have connected to your integrated partner service. Information about each restaurant is included in the array as a PartnerAccessExternalRep object.

Use the pageSize query parameter to control the number of restaurants returned in the response. The default pageSize is 100. The maximum pageSize is 200.

Request the next page of restaurant information using the pageToken query parameter. You get the token string for the next page from the nextPageToken value of the PaginatedResponse object for a page of results. You can also get the token strings for the first and next pages from the link response header fields.

Securityoauth2
Request
query Parameters
lastModified
string <date>

Limits the return data to restaurants that changed their access configuration for your partner service after a specific date and time. You can use this parameter to identify new or updated restaurants connected to your partner service.

The restaurants included in the response data either:

  • Gave access to your integrated partner service after a specific date and time.

  • Modified the configuration for your integrated partner service after a specific date and time.

You must specify the date and time as a UTC timestamp in ISO 8601 format, for example: 2020-03-01T00:00:00.000-0000. URL-encode the timestamp. For example, 2020-03-01T00%3A00%3A00.000-0000.

pageSize
integer [ 1 .. 200 ]

Controls the number of PartnerAccessExternalRep objects that the endpoint will return in each page of response data. The default page size is 100. The maximum page size is 200.

pageToken
string

Returns a specific set of restaurants in the response value. You get the token string for the next page of connected restaurants from the nextPageToken value of the PaginatedResponse object for a page of results. You can also get the token strings for the first and next pages from the link response header fields.

Responses
200

Returns a PaginatedResponse object that contains a paginated array of the restaurants that have connected to your integrated partner service.

403

Your Toast API client does not have permission to use the /connectedRestaurants endpoint.

get/connectedRestaurants
Request samples
curl -i -X GET \
  'https://toast-api-server/partners/v1/connectedRestaurants?lastModified=2019-08-24&pageSize=1&pageToken=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
[
  • {
    }
]