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-metadata-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:
  title: Toast Metadata API
  contact:
    name: Toast developer support
  version: '1.0'
  description: 'Operations tagged Metadata across 2 of this provider''s published API definitions: toast-menus-v3-openapi.yaml, toast-metadata-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://toast-api-server/menus/v3
- url: https://toast-api-server/authentication/v1
tags:
- name: Metadata
paths:
  /metadata:
    get:
      operationId: metadataGet
      summary: 'Get menu last modified timestamp

        '
      description: 'A lightweight endpoint that allows you to determine if a restaurant''s menu data has been updated. Toast support strongly recommends that you do not make a call to the `/menus` endpoint unless the date and time returned by the `/metadata` endpoint is more recent than the `lastUpdated` date and time. While this recommendation applies to all clients of the menus API, it is particularly important for clients that have limited bandwidth.

        '
      parameters:
      - name: Toast-Restaurant-External-ID
        description: The identifier for the restaurant.
        in: header
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Metadata'
      security:
      - oauth2:
        - menus.channel:read
      tags:
      - Metadata
    servers:
    - url: https://toast-api-server/menus/v3
components:
  schemas:
    Metadata:
      type: object
      description: 'Information about the last date and time that this restaurant''s menu data was updated.

        '
      properties:
        restaurantGuid:
          description: 'A unique identifier for this restaurant, assigned by the Toast POS system.

            '
          type: string
          format: uuid
        lastUpdated:
          description: 'The most recent date and time that this menu''s data was published. Use this value to determine if you need to refresh your menu data. The `lastUpdated` value uses the absolute timestamp format describe in the <a href="https://doc.toasttab.com/doc/devguide/api_dates_and_timestamps.html">Dates and timestamps</a> section of the Toast Developer Guide.

            '
          type: string
  securitySchemes:
    oauth2:
      description: "Access to Toast APIs, specific endpoints, \nand specific API endpoint operations is \ncontrolled by the scopes that are associated \nwith your API account. \n\nA full reference for Toast API scopes and \ntheir capabilities can be found in the\n[_Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiScopes.html).\n"
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://toast-api-server/authentication/v1/authentication/login
          scopes:
            menus.channel:read: 'Allows reading from menus API V3.

              '
externalDocs:
  description: Authentication developer guide
  url: https://doc.toasttab.com/doc/devguide/authentication.html
x-refined-from:
- toast-menus-v3-openapi.yaml
- toast-metadata-api-openapi.yml
x-components: {}