Get a service area

Returns a ServiceArea object containing information about a physical setting that a restaurant serves customers in. For example, a restaurant might serve customers in dining room and patio service areas.

Request
path Parameters
guid
required
string

The Toast POS GUID of the service area.

header Parameters
Toast-Restaurant-External-ID
required
string

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

Responses
200

Returns a ServiceArea object.

get/serviceAreas/{guid}
Request samples
curl -i -X GET \
  https://toast-api-server/config/v2/serviceAreas/:guid \
  -H 'Toast-Restaurant-External-ID: string'
Response samples
application/json
{
  • "guid": "string",
  • "entityType": "string",
  • "name": "string",
  • "revenueCenter": {
    }
}