Skip to content

Repository files navigation

Toast (toast-tab)

About this repository

This is not our API. This repository is an independent, third-party profile of a company's publicly available API surface, maintained by API Evangelist. API Evangelist does not operate, host, resell, or support this company's APIs, and is not affiliated with or endorsed by the company unless stated on the profile.

Where the information came from. Everything here is assembled from material a member of the public can reach with a browser and no credentials — the company's own website, developer portal and documentation, the specifications it publishes for public use (OpenAPI, AsyncAPI, JSON Schema, apis.json, llms.txt and similar), its public repositories, and its public status, pricing and changelog pages. Nothing here is obtained by breaching a system, defeating an access control, or using credentials of any kind.

The rating is an independent assessment. The Kin Score and Agent Readiness rating are independently calculated scores of a company's public API artifacts, produced by API Evangelist against a published rubric. They are not certifications, endorsements, security assessments, or audits, and they score published artifacts — not the quality, safety, or security of the software.

Corrections, re-scores, and removal are free. No partnership, contract, or purchase is required, and you do not need to justify the request.

  • Something wrong? Open an issue on this repository, or email info@apievangelist.com.
  • Published something new? Ask for a re-score and we will re-run the rating.
  • Want the listing taken down? Say so and we will honor it. The profile is reduced to your company name, a factual description, and a link to your own site, and the company is recorded as unrated — never scored zero for having asked.

Response times. Acknowledgement within one business day; removal or restriction within two business days; corrections and re-scores within five business days.

Not from the company, and here with a question? You are welcome here — we would rather be the front line and point you the right way than have a good report go nowhere. What this repository can answer is narrow, though, so it is worth knowing who you are actually looking for:

  • A question about how the API works, an account, billing, or a bug in the service — that is the company's own support, not us. We profile this API; we do not operate it and cannot see your account.
  • A bug in an open-source project we only catalog — file it on that project's own repository. This has happened with a real and correct bug report that reached us instead of the people who could fix it, which helped nobody.
  • Anything about this listing itself — the description, the tags, the rating, a missing or wrong artifact — is ours. Open an issue here.
  • Not sure, or something general about API Evangelist or APIs.io — open an issue on the APIs.io Inbox and we will route it.

This repository contains no software, and we will never ask you to download anything. There is no build, release, installer, or binary here — only text and machine-readable API descriptions, so there is nothing here that can be "corrupt" or need "repairing". Any issue, comment, or email claiming otherwise and offering a download link is not from us and is hostile. Do not follow the link; it is a lure. Report it to GitHub and, if you like, tell us at info@apievangelist.com so we can take it down.

On a security or compliance team? Email info@apievangelist.com with security in the subject line and you will get a person, not a form. We will tell you exactly which public URLs this profile was built from so your team can see the same surface we did, and we will take the listing down on request while you work through it.

Full detail: Where this data comes from

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).

APIs.json: https://raw.githubusercontent.com/api-evangelist/toast-tab/refs/heads/main/apis.yml

Scope

  • Type: Index

Tags

  • Restaurants
  • Point Of Sale
  • Payments
  • Online Ordering
  • Delivery
  • Loyalty
  • Gift Cards
  • Menus
  • Orders
  • Kitchen
  • Labor
  • Scheduling
  • Inventory
  • Hospitality
  • Partner Integrations

Timestamps

  • Created: 2026-05-25
  • Modified: 2026-06-03

APIs

Toast Authentication API

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.

Tags

  • Authentication
  • OAuth
  • Tokens

Properties

Toast Restaurants API

Returns restaurant-level information including locations, addresses, hours, schedules, urls, closeout hour, and reference identifiers that anchor every other Toast API call (restaurantGuid).

Tags

  • Restaurants
  • Locations
  • Configuration

Properties

Toast Configuration API

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.

Tags

  • Configuration
  • Employees
  • Discounts
  • Service Charges

Properties

Toast Menus API (V2)

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.

Tags

  • Menus
  • Pricing
  • Modifiers

Properties

Toast Menus API (V3)

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.

Tags

  • Menus
  • Pricing
  • Modifiers

Properties

Toast Orders API

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.

Tags

  • Orders
  • Checks
  • Payments
  • Online Ordering
  • Delivery

Properties

Toast Order Management Configuration API

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.

Tags

  • Orders
  • Throttling
  • Configuration

Properties

Toast Restaurant Availability API

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.

Tags

  • Availability
  • Online Ordering
  • Delivery

Properties

Toast Credit Cards API

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.

Tags

  • Payments
  • Credit Cards
  • Tokens

Properties

Toast Cash Management API

Records and retrieves cash entries — paid in, paid out, deposits, drawer counts — that flow into a restaurant's cash-management ledger and reconciliation reports.

Tags

  • Cash Management
  • Reconciliation
  • Payments

Properties

Toast Labor API

Manages employees, jobs, time entries, breaks, and shifts for Toast's labor-management surface — the integration point used by scheduling, payroll, and HR vendors.

Tags

  • Labor
  • Employees
  • Time Tracking
  • Scheduling
  • Payroll

Properties

Toast Kitchen API

Surfaces kitchen tickets, prep stations, ticket items, and ticket events to support kitchen-display integrations and out-of-band prep orchestration.

Tags

  • Kitchen
  • Tickets
  • Prep

Properties

Toast Packaging Configuration API

Read configuration about packaging — containers, lids, utensils, and packaging instructions — that off-premises orders and delivery handoff workflows must respect.

Tags

  • Packaging
  • Delivery
  • Off Premises

Properties

Toast Stock API

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.

Tags

  • Stock
  • Inventory
  • 86ing
  • Online Ordering

Properties

Toast Analytics API

Analytics and reporting endpoints for Restaurant Management Suites Pro customers — sales, labor, productivity, and operational performance data exposed for BI integrations and warehouse pipelines.

Tags

  • Analytics
  • Reporting
  • BI

Properties

Toast Partners API

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.

Tags

  • Partners
  • Tenancy
  • Onboarding

Properties

Toast Gift Cards Integration

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.

Tags

  • Gift Cards
  • Integrations
  • Partners

Properties

Toast Loyalty Integration

Specification for integrating third-party loyalty programs with Toast — discovery, lookup, accrual, and redemption callbacks that Toast invokes against partner endpoints during a transaction.

Tags

  • Loyalty
  • Integrations
  • Partners

Properties

Toast Tender Integration

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.

Tags

  • Tender
  • Payments
  • Integrations
  • Partners

Properties

Common Properties

Maintainers

FN: Kin Lane Email: kin@apievangelist.com

About

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.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors