Toast Groups API

swagger: '2.0'
info:
  version: 1.0.0
  title: Toast Authentication Groups API
  description: 'The authentication API returns an authentication token that you can present

    when your integration client software uses other Toast APIs. For more

    information about authentication, see [the Toast Developer

    Guide](https://doc.toasttab.com/doc/devguide/authentication.html).

    '
  termsOfService: https://pos.toasttab.com/api-terms-of-use
  contact:
    name: Toast developer support
host: toast-api-server
basePath: /authentication/v1
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: Groups
paths:
  /groups/{managementGroupGUID}/restaurants:
    get:
      operationId: groupsManagementGroupGuidRestaurantsGet
      summary: Toast Get Restaurants in a Management Group
      description: "Returns an array of `Restaurant` objects that are a part of the \nrestaurant management group you specify in the \n`managementGroupGUID` path parameter. Each `Restaurant` object \ncontains the unique Toast platform identifier for the restaurant in \nits `guid` value.\n"
      parameters:
      - name: managementGroupGUID
        in: path
        type: string
        description: 'The GUID of the restaurant management group.

          '
        required: true
      - name: Toast-Restaurant-External-ID
        description: "The Toast GUID of one restaurant location in the management \ngroup.\n"
        in: header
        type: string
        format: string
        required: true
      responses:
        '200':
          description: 'An array of `Restaurant` objects.

            '
          schema:
            type: array
            items:
              $ref: '#/definitions/Restaurant'
      security:
      - oauth2:
        - restaurants:read
      tags:
      - Groups
definitions:
  Restaurant:
    type: object
    description: 'The Toast POS GUID for a restaurant

      '
    properties:
      guid:
        type: string
        description: 'The unique identifier that the Toast POS assigns to a

          restaurant.

          '
externalDocs:
  description: Authentication developer guide
  url: https://doc.toasttab.com/doc/devguide/authentication.html