find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/toast-connectedrestaurants-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: 1.0.0
  title: Toast Authentication Connected Restaurants 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
servers:
- url: https://toast-api-server/authentication/v1
tags:
- name: ConnectedRestaurants
paths:
  /connectedRestaurants:
    get:
      operationId: connectedRestaurantsGet
      summary: Toast Get Connected Restaurants
      description: 'Returns a `PaginatedResponse` object that contains a paginated array of

        the restaurants that have connected to your integrated partner service.

        Information about each restaurant is included in the array as a

        `PartnerAccessExternalRep` object.


        Use the `pageSize` query parameter to control the number of restaurants

        returned in the response. The default `pageSize` is 100. The maximum

        `pageSize` is 200.


        Request the next page of restaurant information using the `pageToken`

        query parameter. You get the token string for the next page from the

        `nextPageToken` value of the `PaginatedResponse` object for a page of

        results. You can also get the token strings for the first and next pages

        from [the `link` response header

        fields](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Link).

        '
      parameters:
      - name: lastModified
        description: "Limits the return data to restaurants that changed their access\nconfiguration for your partner service after a specific date and\ntime. You can use this parameter to identify new or updated\nrestaurants connected to your partner service.\n\nThe restaurants included in the response data either:\n\n* Gave access to your integrated partner service after a specific\n  date and time.\n\n* Modified the configuration for your integrated partner service after\n  a specific date and time. \n\nYou must [specify the date and\ntime](https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html)\nas a UTC timestamp in ISO 8601 format, for example:\n`2020-03-01T00:00:00.000-0000`. URL-encode the timestamp. For\nexample, `2020-03-01T00%3A00%3A00.000-0000`.\n"
        in: query
        required: false
        schema:
          type: string
          format: date
      - name: pageSize
        description: 'Controls the number of `PartnerAccessExternalRep` objects that the

          endpoint will return in each page of response data. The default page

          size is `100`. The maximum page size is `200`.

          '
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
      - name: pageToken
        description: 'Returns a specific set of restaurants in the response value. You get

          the token string for the next page of connected restaurants from the

          `nextPageToken` value of the `PaginatedResponse` object for a page

          of results. You can also get the token strings for the first and

          next pages from [the `link` response header

          fields](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Link).

          '
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: 'Returns a `PaginatedResponse` object that contains a paginated array of

            the restaurants that have connected to your integrated partner service.

            '
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PaginatedResponse'
        '403':
          description: "Your Toast API client does not have permission to use the \n`/connectedRestaurants` endpoint.\n"
      security:
      - oauth2: []
      tags:
      - ConnectedRestaurants
components:
  schemas:
    PaginatedResponse:
      type: object
      description: 'A wrapper object containing paginated sets of response data. The `results`

        value is an array of `PartnerAccessExternalRep` objects, which hold

        information about Toast platform restaurants. Also includes pagination

        details such as how many pages are included in the response, or the total

        number of objects in the `results` array.

        '
      example:
        currentPageNum: 1
        results:
        - restaurantGuid: 7ab295f6-8dc8-4cb6-8cdb-072b83e84184
          managementGroupGuid: 75063706-dd6e-4da6-8bb6-3a99e218e686
          restaurantName: Main Street Cafe
          locationName: 123 Main Street
          createdByEmailAddress: clefebvre@mainstreetcafe.com
          externalGroupRef: ''
          externalRestaurantRef: ''
          modifiedDate: 1678823073353
          createdDate: 1678823073353
          isoModifiedDate: '2023-03-14T19:44:33.353Z'
          isoCreatedDate: '2023-03-14T19:44:33.353Z'
        totalResultCount: 3222
        pageSize: 1
        currentPageToken: cDoxLHM6MQ==
        nextPageToken: cDoyLHM6MQ==
        totalCount: 3222
        nextPageNum: 2
        lastPageNum: 3222
      properties:
        currentPageNum:
          type: integer
          description: 'The active page within all repsonse pages. You can see the total amount of pages at the end of the response in the `lastPageNum` field.

            '
          example: 12
        results:
          type: array
          description: 'An array of `PartnerAccessExternalRep` objects that include

            information about Toast platform restaurants.

            '
          items:
            $ref: '#/components/schemas/PartnerAccessExternalRep'
        totalResultCount:
          type: integer
          description: 'The total number of records returned.

            '
          example: 1234
        pageSize:
          type: integer
          description: 'The number of restaurants returned in each page of response data.

            '
          example: 100
        currentPageToken:
          type: string
          description: 'A string that identifies the current page of response data.

            '
          example: cDoxLHM6MQ==
        nextPageToken:
          type: string
          description: 'A string that identifies the following page of response data.

            '
          example: cDoyLHM6MQ==
        totalCount:
          type: integer
          description: 'The total number of results within the response record.

            '
          example: 1234
        nextPageNum:
          type: integer
          description: 'The next available page in the data. `Null` if the current page of

            results is the last available page.

            '
          example: 14
        lastPageNum:
          type: integer
          description: 'The last page number in the response data.

            '
          example: 13
        previousPageNum:
          type: integer
          description: 'The page number for the page previous to your current page in

            sequential order. `Null` if there are no pages previous to your

            current page.

            '
          example: 12
    PartnerAccessExternalRep:
      type: object
      description: 'Information about a Toast platform restaurant.

        '
      properties:
        restaurantGuid:
          type: string
          format: uuid
          description: 'The unique Toast POS identifier for the restaurant.

            '
          example: e728cd53-2fa7-4e63-8f8f-93e78ea66b03
        managementGroupGuid:
          type: string
          format: uuid
          description: 'The guid of the management group containing the restaurant.

            '
          example: bdfda703-2a83-4e0f-9b8a-8ea0ee6cab79
        deleted:
          type: boolean
          description: "Indicates whether the restaurant is actively using the Toast \nplatform. For example, if a restaurant is no longer operating, \nor is no longer using the Toast platform, this value is `true`.\n"
        restaurantName:
          type: string
          description: 'The human-readable name of the restaurant location.

            '
          example: Main Street Cafe
        locationName:
          type: string
          description: "The identifier of a specific restaurant location, set on the \n*Restaurant Info* page of Toast Web. \nFor example, a restaurant group might assign a location code \nsuch as #1234 to a specific location.\n"
          example: 123 Main Street
        createdByEmailAddress:
          type: string
          description: 'The email address of the restaurant employee who connected the

            restaurant to your integrated partner service, or who edited the

            connection details.

            '
          example: clefebvre@mainstreetcafe.com
        externalGroupRef:
          type: string
          description: 'An identifier for the restaurant group that is recognized by your

            integrated partner service. This information is entered by the

            restaurant administrator. If you need information about the restaurant

            group in this data string, you instruct the restaurant administrator

            to enter it in the Toast platform configuration for the integration

            partner connection.

            '
        externalRestaurantRef:
          type: string
          description: 'An identifier for the restaurant location that is recognized by your

            integrated partner service. This information is entered by the

            restaurant administrator. If you need information about the restaurant

            location in this data string, you instruct the restaurant

            administrator to enter it in the Toast platform configuration for the

            integration partner connection.

            '
        modifiedDate:
          type: integer
          format: int64
          description: 'The most recent date and time that the partner connection

            was edited in epoch time (milliseconds since 1970-01-01 00:00:00).

            '
          example: 1678846869551
        createdDate:
          type: integer
          format: int64
          description: 'The date and time that the partner connection was created in epoch

            time (milliseconds since 1970-01-01 00:00:00).

            '
          example: 1643858534451
        isoModifiedDate:
          type: string
          description: 'The most recent date and time that the partner connection

            was edited in ISO8601 format.

            '
          example: 2023-03-12 08:32:34.008000+00:00
        isoCreatedDate:
          type: string
          description: 'The date and time that the partner connection was created in ISO8601

            format.

            '
          example: 2022-05-17 10:21:38.008000+00:00
externalDocs:
  description: Authentication developer guide
  url: https://doc.toasttab.com/doc/devguide/authentication.html