Skip to content

Repository files navigation

Toast (toast)

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 is a restaurant technology platform providing cloud-based point-of-sale, payment processing, and business management tools for the restaurant industry. The Toast platform exposes REST APIs enabling technology partners to build integrations for orders, menus, labor management, restaurant configuration, inventory/stock management, authentication, and partner ecosystem access. APIs use OAuth 2.0 client credentials authentication with GUIDs for resource identification. Toast serves 120,000+ restaurant locations and offers both partner integrations (requiring formal partnership) and custom integrations via the developer portal.

URL: https://doc.toasttab.com/doc/devguide/index.html

Run: Capabilities Using Naftiko

Tags:

  • Food Service, Point of Sale, Restaurants, Hospitality

Timestamps

  • Created: 2025-02-08
  • Modified: 2026-06-03

APIs

Toast Orders API

The Toast Orders API enables retrieval of restaurant orders, checks, and payment information. Supports bulk order queries by date range and individual order retrieval by GUID. Used for building order management, reporting, and delivery integrations.

Human URL: https://doc.toasttab.com/openapi/orders/overview/

Tags:

  • Orders, Payments, Point of Sale

Properties

Toast Menus API

The Toast Menus API provides complete menu data retrieval including items, modifiers, prices, and availability. Enables POS-synchronized menu display for online ordering and third-party menu management integrations.

Human URL: https://doc.toasttab.com/openapi/menus/overview/

Tags:

  • Menus, Food Service

Properties

Toast Labor API

The Toast Labor API manages employee records, schedules, and shift data for restaurant locations. Supports employee CRUD operations, time entry management, and payroll integration workflows.

Human URL: https://doc.toasttab.com/openapi/labor/overview/

Tags:

  • Labor, Employees, Scheduling

Properties

Toast Restaurants API

The Toast Restaurants API provides location configuration data including restaurant settings, hours, payment options, and management group restaurant discovery for multi-location operations.

Human URL: https://doc.toasttab.com/openapi/restaurants/overview/

Tags:

  • Restaurants, Configuration

Properties

Toast Stock API

The Toast Stock API manages inventory for menu items and modifiers, allowing integration with inventory management systems to track stock levels and trigger restocking alerts for restaurant operations.

Human URL: https://doc.toasttab.com/openapi/stock/overview/

Tags:

  • Stock, Inventory

Properties

Toast Partners API

The Toast Partners API provides partner accounts with access to list connected restaurants, enabling multi-restaurant management and partner-level operations across restaurant locations.

Human URL: https://doc.toasttab.com/openapi/partners/overview/

Tags:

  • Partners, Multi-Location

Properties

Toast Authentication API

The Toast Authentication API implements OAuth 2.0 client credentials flow for obtaining access tokens used across all Toast platform APIs. Tokens are scoped to restaurant GUIDs and expire after a configurable period.

Human URL: https://doc.toasttab.com/openapi/authentication/overview/

Tags:

  • Authentication, OAuth

Properties

Toast Configuration API

The Toast Configuration API returns information about the configuration of a restaurant and its menus, such as menu items and alternate payment types, plus physical configuration including cash drawers, dining options, revenue centers, service areas, tables, and tax rates. Archived or removed entities are excluded from results.

Human URL: https://doc.toasttab.com/openapi/configuration/overview/

Tags:

  • Configuration, Restaurants

Properties

Toast Analytics API

The Toast Analytics API provides an enterprise reporting and analytics service with operations that retrieve data for all or a subset of restaurants in a management group, create requests for reporting data, and retrieve the results. Reporting data includes aggregated sales, check, labor, and guest reporting data.

Human URL: https://doc.toasttab.com/openapi/analytics/overview/

Tags:

  • Analytics, Reporting

Properties

Toast Cash Management API

The Toast Cash Management API provides information about cash operations that add cash to or remove cash from a restaurant cash drawer, separately from cash transaction payments.

Human URL: https://doc.toasttab.com/openapi/cashmanagement/overview/

Tags:

  • Cash Management, Payments

Properties

Toast Kitchen API

The Toast Kitchen API returns information about kitchen operations for a restaurant, supporting kitchen display and fulfillment workflow integrations.

Human URL: https://doc.toasttab.com/openapi/kitchen/overview/

Tags:

  • Kitchen, Food Service

Properties

Toast Credit Cards API

The Toast Credit Cards API is a simple, single-request, synchronous API to authorize credit card transactions associated with a Toast Orders API order.

Human URL: https://doc.toasttab.com/openapi/creditcards/overview/

Tags:

  • Credit Cards, Payments

Properties

Toast Menus V3 API

The Toast Menus V3 API is the next-generation menu retrieval API, returning structured menu, item, modifier, and pricing data for a restaurant in an updated catalog-oriented model alongside the existing Menus V2 surface.

Human URL: https://doc.toasttab.com/openapi/menusv3/overview/

Tags:

  • Menus, Food Service

Properties

Toast Gift Cards Integration API

The Toast Gift Cards integration specification is an outbound API. The partner hosts an HTTPS endpoint that accepts POST requests from the Toast platform to process gift card transactions (balance inquiry, activation, redemption, reload) for restaurants using a third-party gift card provider.

Human URL: https://doc.toasttab.com/openapi/giftcards/overview/

Tags:

  • Gift Cards, Webhooks

Properties

Toast Loyalty Integration API

The Toast Loyalty integration specification is an outbound API. The partner hosts an HTTPS endpoint that accepts POST requests from the Toast platform to handle loyalty program transactions (accrual, redemption, inquiry) for restaurants using a third-party loyalty provider.

Human URL: https://doc.toasttab.com/openapi/loyalty/overview/

Tags:

  • Loyalty, Webhooks

Properties

Toast Tender Integration API

The Toast Tender integration specification is an outbound API. The partner hosts an HTTPS endpoint that accepts POST requests from the Toast platform to receive tender transaction data for alternate or third-party payment tender types processed at the restaurant.

Human URL: https://doc.toasttab.com/openapi/tender/overview/

Tags:

  • Tender, Payments, Webhooks

Properties

Common Properties

Features

Name Description
Orders API Retrieve restaurant orders, checks, and payment data by GUID or bulk date queries.
Menus API Full menu data retrieval including items, modifiers, prices, and availability.
Labor Management API Employee CRUD operations, shift management, and payroll integration support.
Restaurant Configuration API Location settings, payment options, and management group restaurant discovery.
Stock and Inventory API Inventory management for menu items and modifiers with stock level tracking.
OAuth 2.0 Authentication Client credentials OAuth flow with GUID-scoped tokens for secure API access.
Partner Integration Program Formal partner program enabling multi-restaurant access and ecosystem integrations.
Webhook Support Outbound integration webhooks for real-time event delivery (gift cards, loyalty, tender).

Use Cases

Name Description
Online Ordering Integration Connect third-party online ordering platforms to Toast POS for order injection and menu sync.
Payroll and Labor Integration Sync Toast employee and shift data with payroll systems using the Labor API.
Reporting and Analytics Pull order and payment data via bulk orders API for custom reporting and business intelligence.
Inventory Management Integrate restaurant inventory systems with Toast Stock API for real-time stock tracking.
Loyalty and Gift Cards Build loyalty program and gift card integrations using Toast outbound webhook APIs.
Multi-Location Management Partner integrations managing hundreds of restaurant locations via Partners API.

Integrations

Name Description
DoorDash Third-party delivery platform integrated with Toast for order injection.
UberEats Delivery platform integration for menu sync and order management.
QuickBooks Accounting integration for restaurant financial data via Toast reporting APIs.
ADP Payroll platform integration using Toast Labor API data.
OpenTable Reservation system integration with Toast for guest management.

Artifacts

Machine-readable API specifications organized by format.

OpenAPI

JSON Schema

112 JSON Schema files defining Toast request, response, and entity structures across all seven specified APIs. See json-schema/.

JSON Structure

110 JSON Structure files documenting the shape of Toast entities. See json-structure/.

JSON-LD

Linked-data context files mapping each API's vocabulary.

Examples

91 example request/response payloads covering Toast entities and operations. See examples/.

Capabilities

Self-contained Naftiko capabilities, one per business surface (OpenAPI tag), each inlining its consumes block plus REST and MCP exposers. Grouped below under their owning API.

Toast Orders API

Toast Labor API

Toast Menus API

Toast Restaurants API

Toast Stock API

Toast Partners API

Toast Authentication API

Vocabulary

  • Toast Vocabulary — Unified taxonomy mapping 7 resources, 5 actions, 1 workflow, and 3 personas across operational (OpenAPI) and capability (Naftiko) dimensions

Plans & Pricing

Rate Limits

  • Toast Rate Limits — Request-rate, concurrency, and quota policies described with API Commons Rate Limits 0.1

FinOps

  • Toast FinOps — Billing surface aligned to the FinOps Framework / FOCUS data spec

Rules

Maintainers

FN: Kin Lane

Email: kin@apievangelist.com

About

Toast is a restaurant technology platform providing cloud-based point-of-sale, payment processing, and business management tools for the restaurant industry. The Toast platform exposes REST APIs enabling technology partners to build integrations for orders, menus, labor management, restaurant configuration, inventory/stock management…

Topics

Resources

Stars

0 stars

Watchers

2 watching

Forks

Releases

Packages

Contributors