Get service areas

Returns an array of ServiceArea objects containing information about the physical settings that a restaurant serves customers in. For example, a restaurant might serve customers in dining room and patio service areas. If a lastModified date is specified, returns all objects that were created or modified after that date.

Securityoauth2
Request
query Parameters
lastModified
string <date-time>

Limits the return data to objects created or modified after a specific date and time. For example: 2024-06-20T00:00:00.000%2B0000.

pageToken
string

A string that identifies the set of data objects that the endpoint will return in its response data. You can use this parameter to retrieve one page of response data. You get the value that you supply in the pageToken parameter from the Toast-Next-Page-Token header field value of a previous request to the endpoint. For more information, see Paginating response data.

header Parameters
Toast-Restaurant-External-ID
required
string

The Toast POS GUID of the restaurant that the configuration applies to.

Responses
200

Returns an array of ServiceArea objects.

get/serviceAreas
Request samples
curl -i -X GET \
  'https://toast-api-server/config/v2/serviceAreas?lastModified=2019-08-24T14%3A15%3A22Z&pageToken=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: string'
Response samples
application/json
[
  • {
    }
]