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.

This section provides reference information about the endpoints and data types of the Toast partners API. For more information about using the partners API and code examples, see Partner API accounts and Restaurant connections. For general information about working with Toast APIs, see API overview.

Partners API

Base URL: /partners/v1, Version: 1.0.0

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

Default request content-types: application/json
Default response content-types: application/json
Schemes: https

Summary

Path Operation Description
/connectedRestaurants GET

Get connected restaurants

/restaurants GET

Get accessible restaurants

Paths

Get connected restaurants

GET /connectedRestaurants

Returns an array as a PaginatedResponse and allows for further pagination of results. Use the page and pageSize queries to modify the amount of data shown, or the active page. For example: ?page=6 displays the sixth page of the response results. ?pageSize=50 displays 50 lines of information. The default and max pageSize is 100.

lastModified

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.

query string (date)

application/json

200 OK

Returns the list of external partner accesses

403 Forbidden

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

Get accessible restaurants

GET /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.

lastModified

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.

query string (date)

application/json

200 OK

Returns the list of external partner accesses

403 Forbidden

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

Schema definitions

PaginatedResponse: object

Returns responses with pagination. For this endpoint, includes the results object which houses an array of restaurant objects. The end of this response includes paginated details such as how many pages are included in the response, or the total amount of objects in the results arary.

currentPageNum: integer

The active page within all repsonse pages. You can see the total amount of pages at the end of the response in the lastPageNum field.

results: object[]

An array that includes Toast restaurant data.

totalResultCount: integer

The total number of records returned.

pageSize: integer

The active page size used to display results. For example, if the pageSize query was added, the added number will match this value.

currentPageToken: string (uuid)

Token used to define the current page.

nextPageToken: string (uuid)

Token used to define the next page.

totalCount: integer

The total number of results within the response record.

nextPageNum: integer

The next available page in the data. Null if you've come to the last available page.

lastPageNum: integer

The last page number in the response data.

previousPageNum: integer

The page number for the page previous to your current page in sequential order. Null if there are no pages previous to your current page.

PartnerAccessExternalRep: object

Information about a Toast platform restaurant.

restaurantGuid: string (uuid)

The unique Toast POS identifier for the restaurant.

managementGroupGuid: string (uuid)

The guid of the management group containing the restaurant.

restaurantName: string

The human-readable name of the restaurant location.

locationName: string

The identifier of a specific restaurant location, set on the Restaurant Info page of the Toast administration back-end. For example, a restaurant group might assign a location code such as #1234 to a specific location.

createdByEmailAddress: string

The email address of the restaurant employee who connected the restaurant to the partner that made the request to the /restaurants endpoint, or who edited the connection details.

externalGroupRef: string

An identifier for the restaurant group that is recognized by the partner that made the request to the /restaurants endpoint. This information is entered by the restaurant administrator. If you need information about the restaurant group in this data string, you instruct the restaurant administrator to enter it in the Toast platform configuration for the integration partner connection.

externalRestaurantRef: string

An identifier for the restaurant location that is recognized by the partner that made the request to the /restaurants endpoint. This information is entered by the restaurant administrator. If you need information about the restaurant location in this data string, you instruct the restaurant administrator to enter it in the Toast platform configuration for the integration partner connection.

modifiedDate: string (date-time)

The most recent date and time that the partner connection was edited in epoch time (milliseconds since 1970-01-01 00:00:00).

createdDate: string (date-time)

The date and time that the partner connection was created in epoch time (milliseconds since 1970-01-01 00:00:00).

isoModifiedDate: string

The most recent date and time that the partner connection was edited in ISO8601 format.

isoCreatedDate: string

The date and time that the partner connection was created in ISO8601 format.

PartnerAccessExternalWebhookRep: object

Information about a Toast platform restaurant.

restaurantGuid: string (uuid)

The unique Toast POS identifier for the restaurant.

managementGroupGuid: string (uuid)

The guid of the management group containing the restaurant.

restaurantName: string

The human-readable name of the restaurant location.

locationName: string

The identifier of a specific restaurant location, set on the Restaurant Info page of the Toast administration back-end. For example, a restaurant group might assign a location code such as #1234 to a specific location.

externalGroupRef: string

An identifier for the restaurant group that is recognized by the partner that made the request to the /restaurants endpoint. This information is entered by the restaurant administrator. If you need information about the restaurant group in this data string, you instruct the restaurant administrator to enter it in the Toast platform configuration for the integration partner connection.

externalRestaurantRef: string

An identifier for the restaurant location that is recognized by the partner that made the request to the /restaurants endpoint. This information is entered by the restaurant administrator. If you need information about the restaurant location in this data string, you instruct the restaurant administrator to enter it in the Toast platform configuration for the integration partner connection.

modifiedDate: string (date-time)

The most recent date and time that the partner connection was edited in epoch time (milliseconds since 1970-01-01 00:00:00).

createdDate: string (date-time)

The date and time that the partner connection was created in epoch time (milliseconds since 1970-01-01 00:00:00).

isoModifiedDate: string

The most recent date and time that the partner connection was edited in ISO8601 format.

isoCreatedDate: string

The date and time that the partner connection was created in ISO8601 format.

createdByFirstName: string

The first name of the user who initiated the event.

createdByLastName: string

The last name of the user who initiated the event.

createdByEmailAddress: string

The email address of the restaurant employee who connected the restaurant to the partner that made the request to the /restaurants endpoint, or who edited the connection details.

createdByPhoneNumber: string

The phone number of the user who initiated the event.

restaurantPhoneNumber: string

The phone number of the restaurant.

restaurantAddressLine1: string

The physical address of the restaurant location.

restaurantAddressLine2: string

Optional additional physical address of the restaurant location.

restaurantCity: string

The city in which the restaurant is located.

restaurantState: string

The state in which the restaurant is located.

restaurantZipCode: string

The zip code of the restaurant location.

restaurantLatitude: string

The latitude of the restaurant location.

restaurantLongitude: string

The longitude of the restaurant location.