Toast

aid: toast-tab
name: Toast
description: >-
  Toast (NYSE: TOST) is a cloud-based restaurant technology platform that
  unifies point-of-sale (POS), payments, online ordering, delivery, digital
  marketing, loyalty, gift cards, kitchen display, inventory, and team
  management for restaurants of every size — from independent operators to
  enterprise chains. The Toast platform exposes a substantial REST API
  surface at https://ws-api.toasttab.com/, authenticated via OAuth 2.0
  client credentials, and is used by restaurants, internal IT teams, and
  the Toast Partner Integrations program to read and write menus, orders,
  payments, employees, schedules, time entries, cash entries, kitchen
  tickets, restaurant configuration, gift cards, loyalty balances, and
  partner-restaurant connections. Toast offers three flavors of API access:
  Standard API Access (self-service for restaurant operators), Analytics API
  Access (Restaurant Management Suites Pro), and Partner Integrations
  (technology companies building productized integrations).
type: Index
image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
tags:
  - Restaurants
  - Point Of Sale
  - Payments
  - Online Ordering
  - Delivery
  - Loyalty
  - Gift Cards
  - Menus
  - Orders
  - Kitchen
  - Labor
  - Scheduling
  - Inventory
  - Hospitality
  - Partner Integrations
url: >-
  https://raw.githubusercontent.com/api-evangelist/toast-tab/refs/heads/main/apis.yml
created: '2026-05-25'
modified: '2026-05-25'
specificationVersion: '0.19'
apis:
  - aid: toast-tab:toast-authentication-api
    name: Toast Authentication API
    description: >-
      OAuth 2.0 client-credentials authentication for Toast APIs. Exchanges
      a clientId and clientSecret (with userAccessType
      TOAST_MACHINE_CLIENT) for a bearer access token at
      /authentication/v1/authentication/login. Token lifetime is returned
      in the response and varies by environment.
    humanURL: https://doc.toasttab.com/openapi/authentication/overview/
    baseURL: https://ws-api.toasttab.com/authentication/v1
    tags:
      - Authentication
      - OAuth
      - Tokens
    properties:
      - type: Documentation
        url: https://doc.toasttab.com/openapi/authentication/overview/
      - type: AuthenticationGuide
        url: https://doc.toasttab.com/doc/devguide/authentication.html
  - aid: toast-tab:toast-restaurants-api
    name: Toast Restaurants API
    description: >-
      Returns restaurant-level information including locations, addresses,
      hours, schedules, urls, closeout hour, and reference identifiers that
      anchor every other Toast API call (restaurantGuid).
    humanURL: https://doc.toasttab.com/openapi/restaurants/overview/
    baseURL: https://ws-api.toasttab.com/restaurants/v1
    tags:
      - Restaurants
      - Locations
      - Configuration
    properties:
      - type: Documentation
        url: https://doc.toasttab.com/openapi/restaurants/overview/
  - aid: toast-tab:toast-configuration-api
    name: Toast Configuration API
    description: >-
      Read-access to a restaurant's configuration entities — menus,
      modifier groups, employees, jobs, dining options, service areas,
      revenue centers, sales categories, discounts, service charges, and
      table topology — that drive POS behavior.
    humanURL: https://doc.toasttab.com/openapi/configuration/overview/
    baseURL: https://ws-api.toasttab.com/config/v2
    tags:
      - Configuration
      - Employees
      - Discounts
      - Service Charges
    properties:
      - type: Documentation
        url: https://doc.toasttab.com/openapi/configuration/overview/
  - aid: toast-tab:toast-menus-v2-api
    name: Toast Menus API (V2)
    description: >-
      Returns published menu data for a restaurant — menus, menu groups,
      menu items, modifier groups, options, prices, and tax info — in the
      legacy V2 shape used by ordering and POS integrations.
    humanURL: https://doc.toasttab.com/openapi/menus/overview/
    baseURL: https://ws-api.toasttab.com/menus/v2
    tags:
      - Menus
      - Pricing
      - Modifiers
    properties:
      - type: Documentation
        url: https://doc.toasttab.com/openapi/menus/overview/
  - aid: toast-tab:toast-menus-v3-api
    name: Toast Menus API (V3)
    description: >-
      Next-generation read API for Toast menus, exposing the same menu /
      menu group / item / modifier / option model as V2 in a refreshed
      shape aligned with Toast's newer platform services.
    humanURL: https://doc.toasttab.com/openapi/menusv3/overview/
    baseURL: https://ws-api.toasttab.com/menus/v3
    tags:
      - Menus
      - Pricing
      - Modifiers
    properties:
      - type: Documentation
        url: https://doc.toasttab.com/openapi/menusv3/overview/
  - aid: toast-tab:toast-orders-api
    name: Toast Orders API
    description: >-
      Create, retrieve, modify, and void orders, checks, and selections;
      attach payments and refunds; manage dining options and service
      charges. The Orders API is the workhorse of Toast integrations —
      online-ordering channels, delivery providers, kiosks, and POS-aware
      tools all post orders here.
    humanURL: https://doc.toasttab.com/openapi/orders/overview/
    baseURL: https://ws-api.toasttab.com/orders/v2
    tags:
      - Orders
      - Checks
      - Payments
      - Online Ordering
      - Delivery
    properties:
      - type: Documentation
        url: https://doc.toasttab.com/openapi/orders/overview/
  - aid: toast-tab:toast-order-management-config-api
    name: Toast Order Management Configuration API
    description: >-
      Read configuration that governs how orders flow through Toast —
      throttling, prep-time rules, surge controls, and order-management
      settings used by online-ordering and delivery integrations.
    humanURL: https://doc.toasttab.com/openapi/ordermgmt.configuration/overview/
    baseURL: https://ws-api.toasttab.com/ordermgmt-config/v1
    tags:
      - Orders
      - Throttling
      - Configuration
    properties:
      - type: Documentation
        url: https://doc.toasttab.com/openapi/ordermgmt.configuration/overview/
  - aid: toast-tab:toast-restaurant-availability-api
    name: Toast Restaurant Availability API
    description: >-
      Returns whether a restaurant is currently accepting online orders,
      its expected prep times, and per-channel availability so ordering
      partners and delivery marketplaces can route demand appropriately.
    humanURL: https://doc.toasttab.com/openapi/rx.availability.service/overview/
    baseURL: https://ws-api.toasttab.com/restaurants/v1/availability
    tags:
      - Availability
      - Online Ordering
      - Delivery
    properties:
      - type: Documentation
        url: https://doc.toasttab.com/openapi/rx.availability.service/overview/
  - aid: toast-tab:toast-credit-cards-api
    name: Toast Credit Cards API
    description: >-
      Read tokenized credit-card information attached to orders for
      receipts, returns, and reconciliation. Toast Payments handles
      acceptance natively; this API exposes the resulting tokenized card
      records.
    humanURL: https://doc.toasttab.com/openapi/creditcards/overview/
    baseURL: https://ws-api.toasttab.com/creditcards/v1
    tags:
      - Payments
      - Credit Cards
      - Tokens
    properties:
      - type: Documentation
        url: https://doc.toasttab.com/openapi/creditcards/overview/
  - aid: toast-tab:toast-cash-management-api
    name: Toast Cash Management API
    description: >-
      Records and retrieves cash entries — paid in, paid out, deposits,
      drawer counts — that flow into a restaurant's cash-management ledger
      and reconciliation reports.
    humanURL: https://doc.toasttab.com/openapi/cashmanagement/overview/
    baseURL: https://ws-api.toasttab.com/cashmgmt/v1
    tags:
      - Cash Management
      - Reconciliation
      - Payments
    properties:
      - type: Documentation
        url: https://doc.toasttab.com/openapi/cashmanagement/overview/
  - aid: toast-tab:toast-labor-api
    name: Toast Labor API
    description: >-
      Manages employees, jobs, time entries, breaks, and shifts for
      Toast's labor-management surface — the integration point used by
      scheduling, payroll, and HR vendors.
    humanURL: https://doc.toasttab.com/openapi/labor/overview/
    baseURL: https://ws-api.toasttab.com/labor/v1
    tags:
      - Labor
      - Employees
      - Time Tracking
      - Scheduling
      - Payroll
    properties:
      - type: Documentation
        url: https://doc.toasttab.com/openapi/labor/overview/
  - aid: toast-tab:toast-kitchen-api
    name: Toast Kitchen API
    description: >-
      Surfaces kitchen tickets, prep stations, ticket items, and ticket
      events to support kitchen-display integrations and out-of-band prep
      orchestration.
    humanURL: https://doc.toasttab.com/openapi/kitchen/overview/
    baseURL: https://ws-api.toasttab.com/kitchen/v1
    tags:
      - Kitchen
      - Tickets
      - Prep
    properties:
      - type: Documentation
        url: https://doc.toasttab.com/openapi/kitchen/overview/
  - aid: toast-tab:toast-packaging-configuration-api
    name: Toast Packaging Configuration API
    description: >-
      Read configuration about packaging — containers, lids, utensils, and
      packaging instructions — that off-premises orders and delivery
      handoff workflows must respect.
    humanURL: https://doc.toasttab.com/openapi/packaging/overview/
    baseURL: https://ws-api.toasttab.com/packaging/v1
    tags:
      - Packaging
      - Delivery
      - Off Premises
    properties:
      - type: Documentation
        url: https://doc.toasttab.com/openapi/packaging/overview/
  - aid: toast-tab:toast-stock-api
    name: Toast Stock API
    description: >-
      Read and update menu-item stock levels — what is in stock, what is
      sold out, what is limited — so online-ordering, delivery, and
      inventory tools stay in sync with the restaurant's true sellable
      catalog.
    humanURL: https://doc.toasttab.com/openapi/stock/overview/
    baseURL: https://ws-api.toasttab.com/stock/v1
    tags:
      - Stock
      - Inventory
      - 86ing
      - Online Ordering
    properties:
      - type: Documentation
        url: https://doc.toasttab.com/openapi/stock/overview/
  - aid: toast-tab:toast-analytics-api
    name: Toast Analytics API
    description: >-
      Analytics and reporting endpoints for Restaurant Management Suites
      Pro customers — sales, labor, productivity, and operational
      performance data exposed for BI integrations and warehouse
      pipelines.
    humanURL: https://doc.toasttab.com/openapi/analytics/overview/
    baseURL: https://ws-api.toasttab.com/analytics/v1
    tags:
      - Analytics
      - Reporting
      - BI
    properties:
      - type: Documentation
        url: https://doc.toasttab.com/openapi/analytics/overview/
  - aid: toast-tab:toast-partners-api
    name: Toast Partners API
    description: >-
      Enables Toast Partner Integration clients to enumerate the
      restaurants that have authorized them. Exposes "accessible
      restaurants" and "connected restaurants" so a partner can discover
      and provision its tenant base across the Toast network.
    humanURL: https://doc.toasttab.com/openapi/partners/overview/
    baseURL: https://ws-api.toasttab.com/partners/v1
    tags:
      - Partners
      - Tenancy
      - Onboarding
    properties:
      - type: Documentation
        url: https://doc.toasttab.com/openapi/partners/overview/
  - aid: toast-tab:toast-gift-cards-integration
    name: Toast Gift Cards Integration
    description: >-
      Specification for integrating third-party gift-card programs with
      Toast — Toast calls the partner's endpoints to look up balances,
      authorize, redeem, and reload gift cards inline with a check.
    humanURL: https://doc.toasttab.com/openapi/giftcards/overview/
    baseURL: https://doc.toasttab.com/openapi/giftcards
    tags:
      - Gift Cards
      - Integrations
      - Partners
    properties:
      - type: Documentation
        url: https://doc.toasttab.com/openapi/giftcards/overview/
  - aid: toast-tab:toast-loyalty-integration
    name: Toast Loyalty Integration
    description: >-
      Specification for integrating third-party loyalty programs with
      Toast — discovery, lookup, accrual, and redemption callbacks that
      Toast invokes against partner endpoints during a transaction.
    humanURL: https://doc.toasttab.com/openapi/loyalty/overview/
    baseURL: https://doc.toasttab.com/openapi/loyalty
    tags:
      - Loyalty
      - Integrations
      - Partners
    properties:
      - type: Documentation
        url: https://doc.toasttab.com/openapi/loyalty/overview/
  - aid: toast-tab:toast-tender-integration
    name: Toast Tender Integration
    description: >-
      Specification for integrating alternative tender types into Toast —
      callback endpoints partners implement so Toast can validate,
      authorize, and reconcile non-card forms of payment at checkout.
    humanURL: https://doc.toasttab.com/openapi/tender/overview/
    baseURL: https://doc.toasttab.com/openapi/tender
    tags:
      - Tender
      - Payments
      - Integrations
      - Partners
    properties:
      - type: Documentation
        url: https://doc.toasttab.com/openapi/tender/overview/
common:
  - type: Website
    url: https://pos.toasttab.com/
  - type: DeveloperPortal
    url: https://dev.toasttab.com/
  - type: Documentation
    url: https://doc.toasttab.com/
  - type: APIReference
    url: https://doc.toasttab.com/openapi/
  - type: DeveloperGuide
    url: https://doc.toasttab.com/doc/devguide/index.html
  - type: HowToGuides
    url: https://doc.toasttab.com/doc/cookbook/index.html
  - type: PlatformGuide
    url: https://doc.toasttab.com/doc/platformguide/index.html
  - type: ReleaseNotes
    url: https://doc.toasttab.com/doc/relnotes/index.html
  - type: Authentication
    url: https://doc.toasttab.com/doc/devguide/authentication.html
  - type: Webhooks
    url: https://doc.toasttab.com/doc/devguide/webhooks.html
  - type: PartnerProgram
    url: https://pos.toasttab.com/integrations
  - type: GitHubOrganization
    url: https://github.com/toasttab
  - type: LinkedIn
    url: https://www.linkedin.com/company/toast-inc
  - type: Investors
    url: https://investors.toasttab.com/
  - type: Status
    url: https://status.toasttab.com/
  - type: Support
    url: https://central.toasttab.com/
  - type: Pricing
    url: https://pos.toasttab.com/pricing
  - type: SignUp
    url: https://pos.toasttab.com/get-a-demo
maintainers:
  - FN: Kin Lane
    email: [email protected]