Get a break type

Returns a BreakType object containing information about a break type configured for a restaurant.

Securityoauth2

Request

path Parameters

• guid required:
  string

  The Toast POS GUID of the break config.

header Parameters

• Toast-Restaurant-External-ID required:
  string

  The Toast POS GUID of the restaurant that the break is configured for.

Responses

200

Returns a BreakType object.

get /breakTypes/{guid}

Request samples

curl -i -X GET \
  'https://toast-api-server/config/v2/breakTypes/{guid}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Toast-Restaurant-External-ID: string'

Response samples

application/json

{
  "guid": "string",
  "entityType": "string",
  "name": "string",
  "active": true,
  "paid": true,
  "duration": 0,
  "enforceMinimumTime": true,
  "trackMissedBreaks": true,
  "breakIntervalHrs": 0,
  "breakIntervalMins": 0,
  "trackBreakAcknowledgement": true
}