Partners API includes new scopes value

New scopes field in Partners API responses

The partners API includes a new scopes value in the PartnerAccessExternalRep object. The scopes value indicates the API client scopes that are available to your integration for the connected Toast POS location. For more information about scopes, see the Toast developer guide. For more information about the partners API, see API reference documentation.

The scopes value in the PartnerAccessExternalRep object includes the scopes your integration has for a POS location when you get the list of connected locations using the /partners/v1/connectedRestaurants endpoint of the partners API. The scopes value will always be null when you get the accessible locations for your integration using the /partners/v1/restaurants endpoint of the partners API. For best performance, use the /partners/v1/connectedRestaurants endpoint to get information about the POS locations connected to your integration.

The partners webhook payload also includes the new scopes value in the PartnerAccessExternalWebhookRep object. For more information about the partners webhook, see the partners webhook reference documentation.