Partners API (1.0.0)

Returns information about the Toast restaurants that a partner API client can access.

Get accessible restaurants

Returns an array of PartnerAccessExternalRep objects that contain information about the Toast restaurants that a partner API client can access. If a lastModified date is specified, the API returns all objects that were created or modified after that date.

Request
query Parameters
lastModified
string <date>

Limits the return data to restaurants that changed their access configuration for a partner API client after a specific date and time.

Restaurants returned either:

  • Gave access to a partner API client for a partner integration service after a specific date and time.

  • Modified the configuration for a partner integration 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.

Responses
200

Returns the list of external partner accesses

403

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

get/restaurants
Request samples
curl -i -X GET \
  'https://toast-api-server/partners/v1/restaurants?lastModified=2019-08-24'
Response samples
application/json
[
  • {
    }
]