Toast
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).
Solid contracts, transparent operations, and an easy start — typically complete on four or five facets with one clear soft spot.
API Evangelist profiles Toast the way a machine reads it — 378 machine-readable artifacts across 26 APIs, pulled from the provider's own public surface and indexed so a developer, an analyst, or an AI agent can evaluate it against every other provider on the network.
Every provider in the network is reduced to the same set of machine-readable artifacts — OpenAPI contracts, event specifications, GraphQL schemas, runnable collections, pricing and rate-limit signals, security posture, OAuth scopes, and the agent surfaces (MCP servers and skills) that let software drive the API on its own. We profile them because the interface is the part of a company you can actually inspect: it is a truer signal of what a provider does than any marketing page. From those artifacts we compute the Kin Score — Toast scores 62.8/100 (strong), with a separate agent-readiness read of 54/100 (agent ready). The full breakdown is below, followed by every artifact we hold — each card links through to its machine-readable definition on apis.io.
Kin Score
This is the API Evangelist rating — a single, repeatable read computed from the artifacts on this page. Green fill is points earned; the red track is points possible, so every bar shows earned-versus-possible at a glance.
Kin Score
How this is scored →scored 2026-07-27 · rubric v0.5
How we profile Toast
Each block below is one kind of artifact we hold for Toast. For each we say what it is and why it earns a place in the profile, then list every one we've indexed — capped at two rows, scroll within the panel for the rest.
APIs 26
Each API is captured as its own OpenAPI definition — every operation, parameter, and response. This is the single most useful machine-readable description of what an API does, and it's what lets us score, lint, mock, and generate against it without asking the provider for anything.
Individual APIs this provider publishes, each with its own machine-readable definition.
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, serv...
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 ser...
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 i...
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...
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 t...
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.
Toast Kitchen API
Surfaces kitchen tickets, prep stations, ticket items, and ticket events to support kitchen-display integrations and out-of-band prep orchestration.
Toast Packaging Configuration API
Read configuration about packaging — containers, lids, utensils, and packaging instructions — that off-premises orders and delivery handoff workflows must respect.
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 w...
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 inlin...
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 ...
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 payme...
Toast Authentication API
The Authentication API from Toast — 1 operation(s) for authentication.
Toast ConnectedRestaurants API
The ConnectedRestaurants API from Toast — 1 operation(s) for connectedrestaurants.
Toast Discounts API
Related to price reduction applied to restaurant orders. For example, a restaurant might apply a discount for a promotion.
Toast Employees API
The Employees API from Toast — 6 operation(s) for employees.
Toast Groups API
The Groups API from Toast — 1 operation(s) for groups.
Toast Jobs API
The Jobs API from Toast — 3 operation(s) for jobs.
Toast Menus API
The Menus API from Toast — 1 operation(s) for menus.
Toast Metadata API
The Metadata API from Toast — 1 operation(s) for metadata.
Toast Orders API
Related to orders made by restaurant guests. For example, a restaurant guest orders items from a menu. Toast platform orders include one or more guest check.
Toast Payments API
Related to guests' payments for restaurant orders. Toast platform payments apply to a check in an order.
Toast Restaurants API
The Restaurants API from Toast — 2 operation(s) for restaurants.
Toast Shifts API
The Shifts API from Toast — 2 operation(s) for shifts.
Toast Stock API
The Stock API from Toast — 3 operation(s) for stock.
Toast Time entries API
The Time entries API from Toast — 2 operation(s) for time entries.
Scroll within the panel for all 26 ·
Open Collections 7
Open, tool-agnostic collections carry the same runnable value as Postman without locking you to one client — the portable, forkable form of the same exercise.
Open, tool-agnostic API collections (OpenAPI-derived and Bruno).
Toast authentication API
OPEN COLLECTIONToast Labor API
OPEN COLLECTIONMenus API
OPEN COLLECTIONToast Orders API
OPEN COLLECTIONPartners API
OPEN COLLECTIONRestaurants API
OPEN COLLECTIONStock API
OPEN COLLECTIONScroll within the panel for all 7 ·
GraphQL 1
Where a provider ships GraphQL, the schema is the contract. We profile it alongside the REST surface so the whole interface is legible in one place.
GraphQL schemas published by this provider.
Toast GraphQL API
Toast is a restaurant technology platform covering POS, ordering, payroll, and delivery. The API covers orders, menus, discounts, labor, payments, and restaurant configuration f...
GRAPHQLPricing Plans 1
Pricing is part of the interface. Machine-readable plans tell you what a tier costs and includes before you commit — one of the six things the Kin Score reads for commercial clarity.
Published pricing tiers and plan structures.
Rate Limits 1
Rate limits are the difference between a demo that works and a production integration that doesn't fall over. Publishing them is an operational-transparency signal — and a hard requirement for any agent that plans its own throughput.
Documented rate limits and quota policies.
Toast Tab Rate Limits
RATE LIMITSFinOps 1
Cost, billing, and metering signals let a buyer model the financial operations of an API before it's live. We profile them for the same reason we profile pricing: the money is part of the contract.
Cost, billing, and metering signals for API financial operations.
Toast Tab Finops
FINOPSFeatures 6
The notable capabilities this provider advertises, captured as structured features so they can be searched and compared instead of read one landing page at a time.
Notable capabilities this provider offers.
OAuth 2.0 Client Credentials
Machine-to-machine authentication issuing bearer tokens for all Toast platform APIs.
Orders & Payments
Create, retrieve, modify, and void orders, checks, selections, payments, and refunds.
Menus
Read published menu, menu group, item, modifier, and pricing data in V2 and V3 shapes.
Labor Management
Manage employees, jobs, shifts, and time entries for scheduling and payroll vendors.
Stock / 86ing
Read and update menu-item stock levels to keep ordering channels in sync.
Partner Integrations
Discover accessible and connected restaurants across the Toast network for a partner client.
Semantic Vocabularies 7
JSON-LD contexts give the data shared meaning across APIs. We profile them because semantics are what let a machine reconcile 'customer' here with 'customer' somewhere else.
JSON-LD contexts and semantic vocabularies used across these APIs.
Toast Tab Labor Context
JSON-LDToast Tab Menus Context
JSON-LDToast Tab Orders Context
JSON-LDToast Tab Partners Context
JSON-LDToast Tab Stock Context
JSON-LDScroll within the panel for all 7 ·
Spectral Rules 2
Governance rulesets we run against this provider's specs — the automated checks behind parts of the score. Profiling them makes the quality bar explicit and re-runnable, not a matter of opinion.
Toast API Rules
SPECTRALToast API Rules
SPECTRALJSON Schema 110
Standalone JSON Schema definitions describe the data models behind the API. We profile them so the shapes are validatable on their own — useful long after a single request is forgotten.
Standalone JSON Schema definitions for this provider's data models.
AuthenticationRequest
JSON SCHEMAAuthenticationResponse
JSON SCHEMAAuthenticationToken
JSON SCHEMAEmployee
JSON SCHEMAExternalReference
JSON SCHEMAJob
JSON SCHEMAJobWageOverride
JSON SCHEMAScheduleConfig
JSON SCHEMAShift
JSON SCHEMATimeEntryBreak
JSON SCHEMATimeEntry
JSON SCHEMAToastReference
JSON SCHEMAAlcohol
JSON SCHEMAAllergenItem
JSON SCHEMAAvailability
JSON SCHEMACatalogProductInfo
JSON SCHEMACatalogProductOption
JSON SCHEMACatalogProductOptionValue
JSON SCHEMACatalogProduct
JSON SCHEMACatalogProductVariantOption
JSON SCHEMACatalogProductVariant
JSON SCHEMAContentAdvisories
JSON SCHEMADimensionUnitOfMeasure
JSON SCHEMAGuestCount
JSON SCHEMAHeight
JSON SCHEMAImage
JSON SCHEMAImages
JSON SCHEMAItemTag
JSON SCHEMALength
JSON SCHEMAMasterId
JSON SCHEMAMenuGroup
JSON SCHEMAMenuItem
JSON SCHEMAMenu
JSON SCHEMAMetadata
JSON SCHEMAModifierGroup
JSON SCHEMAModifierOption
JSON SCHEMAModifierOptionTaxInfo
JSON SCHEMAMultiLocationId
JSON SCHEMAPortion
JSON SCHEMAPosButtonColorDark
JSON SCHEMAPosButtonColorLight
JSON SCHEMAPosName
JSON SCHEMAPreModifierGroup
JSON SCHEMAPreModifier
JSON SCHEMAPricingRules
JSON SCHEMARestaurant
JSON SCHEMASalesCategory
JSON SCHEMASchedule
JSON SCHEMASequencePrice
JSON SCHEMASizeSequencePricingRule
JSON SCHEMATimeRange
JSON SCHEMATimeSpecificPrice
JSON SCHEMAVisibility
JSON SCHEMAWeight
JSON SCHEMAWeightUnitOfMeasure
JSON SCHEMAWidth
JSON SCHEMAApplicableDiscount
JSON SCHEMAApplicableDiscountsRequest
JSON SCHEMAAppliedDiscountReason
JSON SCHEMAAppliedDiscount
JSON SCHEMAAppliedDiscountTrigger
JSON SCHEMAAppliedLoyaltyInfo
JSON SCHEMAAppliedPackagingInfo
JSON SCHEMAAppliedPackagingItem
JSON SCHEMAAppliedServiceCharge
JSON SCHEMAAppliedTaxRate
JSON SCHEMACheck
JSON SCHEMAConfigReference
JSON SCHEMACurbsidePickupInfo
JSON SCHEMACustomer
JSON SCHEMADeliveryInfo
JSON SCHEMADeliveryServiceInfo
JSON SCHEMADevice
JSON SCHEMAExternalReference
JSON SCHEMAFulfillment
JSON SCHEMAGiftCardInfo
JSON SCHEMALoyaltyDetails
JSON SCHEMAMarketplaceFacilitatorTaxInfo
JSON SCHEMAOrderResponse
JSON SCHEMAOrder
JSON SCHEMAPayment
JSON SCHEMARefundDetails
JSON SCHEMARefund
JSON SCHEMARefundTransaction
JSON SCHEMASelection
JSON SCHEMAToastReference
JSON SCHEMAUpdatePaymentRequest
JSON SCHEMAVoidInformation
JSON SCHEMAPaginatedResponse
JSON SCHEMAPartnerAccessExternalRep
JSON SCHEMAPartnerAccessExternalWebhookRep
JSON SCHEMADaySchedule
JSON SCHEMADeliveryPaymentOptions
JSON SCHEMADelivery
JSON SCHEMAGeneral
JSON SCHEMAHours
JSON SCHEMAImage
JSON SCHEMALocation
JSON SCHEMAOnlineOrdering
JSON SCHEMAPaymentOptions
JSON SCHEMAPrepTimes
JSON SCHEMARestaurantInfo
JSON SCHEMARestaurant
JSON SCHEMASchedules
JSON SCHEMAService
JSON SCHEMATakeoutPaymentOptions
JSON SCHEMAURLs
JSON SCHEMAWeekSchedule
JSON SCHEMAInventorySearchRequest
JSON SCHEMAMenuItemInventory
JSON SCHEMAScroll within the panel for all 110 ·
JSON Structure 110
JSON Structure captures the data shapes in a form built for tooling — a complement to JSON Schema that keeps the model machine-legible.
JSON Structure definitions describing this provider's data shapes.
Authentication Authentication Request Structure
JSON STRUCTUREAuthentication Authentication Response Structure
JSON STRUCTUREAuthentication Authentication Token Structure
JSON STRUCTURELabor Employee Structure
JSON STRUCTURELabor External Reference Structure
JSON STRUCTURELabor Job Structure
JSON STRUCTURELabor Job Wage Override Structure
JSON STRUCTURELabor Schedule Config Structure
JSON STRUCTURELabor Shift Structure
JSON STRUCTURELabor Time Entry Break Structure
JSON STRUCTURELabor Time Entry Structure
JSON STRUCTURELabor Toast Reference Structure
JSON STRUCTUREMenus Alcohol Structure
JSON STRUCTUREMenus Allergen Item Structure
JSON STRUCTUREMenus Availability Structure
JSON STRUCTUREMenus Catalog Product Info Structure
JSON STRUCTUREMenus Catalog Product Option Structure
JSON STRUCTUREMenus Catalog Product Option Value Structure
JSON STRUCTUREMenus Catalog Product Structure
JSON STRUCTUREMenus Catalog Product Variant Option Structure
JSON STRUCTUREMenus Catalog Product Variant Structure
JSON STRUCTUREMenus Content Advisories Structure
JSON STRUCTUREMenus Dimension Unit Of Measure Structure
JSON STRUCTUREMenus Guest Count Structure
JSON STRUCTUREMenus Height Structure
JSON STRUCTUREMenus Image Structure
JSON STRUCTUREMenus Images Structure
JSON STRUCTUREMenus Item Tag Structure
JSON STRUCTUREMenus Length Structure
JSON STRUCTUREMenus Master Id Structure
JSON STRUCTUREMenus Menu Group Structure
JSON STRUCTUREMenus Menu Item Structure
JSON STRUCTUREMenus Menu Structure
JSON STRUCTUREMenus Metadata Structure
JSON STRUCTUREMenus Modifier Group Structure
JSON STRUCTUREMenus Modifier Option Structure
JSON STRUCTUREMenus Modifier Option Tax Info Structure
JSON STRUCTUREMenus Multi Location Id Structure
JSON STRUCTUREMenus Portion Structure
JSON STRUCTUREMenus Pos Button Color Dark Structure
JSON STRUCTUREMenus Pos Button Color Light Structure
JSON STRUCTUREMenus Pos Name Structure
JSON STRUCTUREMenus Pre Modifier Group Structure
JSON STRUCTUREMenus Pre Modifier Structure
JSON STRUCTUREMenus Pricing Rules Structure
JSON STRUCTUREMenus Restaurant Structure
JSON STRUCTUREMenus Sales Category Structure
JSON STRUCTUREMenus Schedule Structure
JSON STRUCTUREMenus Sequence Price Structure
JSON STRUCTUREMenus Size Sequence Pricing Rule Structure
JSON STRUCTUREMenus Time Range Structure
JSON STRUCTUREMenus Time Specific Price Structure
JSON STRUCTUREMenus Visibility Structure
JSON STRUCTUREMenus Weight Structure
JSON STRUCTUREMenus Weight Unit Of Measure Structure
JSON STRUCTUREMenus Width Structure
JSON STRUCTUREOrders Applicable Discount Structure
JSON STRUCTUREOrders Applicable Discounts Request Structure
JSON STRUCTUREOrders Applied Discount Reason Structure
JSON STRUCTUREOrders Applied Discount Structure
JSON STRUCTUREOrders Applied Discount Trigger Structure
JSON STRUCTUREOrders Applied Loyalty Info Structure
JSON STRUCTUREOrders Applied Packaging Info Structure
JSON STRUCTUREOrders Applied Packaging Item Structure
JSON STRUCTUREOrders Applied Service Charge Structure
JSON STRUCTUREOrders Applied Tax Rate Structure
JSON STRUCTUREOrders Check Structure
JSON STRUCTUREOrders Config Reference Structure
JSON STRUCTUREOrders Curbside Pickup Info Structure
JSON STRUCTUREOrders Customer Structure
JSON STRUCTUREOrders Delivery Info Structure
JSON STRUCTUREOrders Delivery Service Info Structure
JSON STRUCTUREOrders Device Structure
JSON STRUCTUREOrders External Reference Structure
JSON STRUCTUREOrders Fulfillment Structure
JSON STRUCTUREOrders Gift Card Info Structure
JSON STRUCTUREOrders Loyalty Details Structure
JSON STRUCTUREOrders Marketplace Facilitator Tax Info Structure
JSON STRUCTUREOrders Order Response Structure
JSON STRUCTUREOrders Order Structure
JSON STRUCTUREOrders Payment Structure
JSON STRUCTUREOrders Refund Details Structure
JSON STRUCTUREOrders Refund Structure
JSON STRUCTUREOrders Refund Transaction Structure
JSON STRUCTUREOrders Selection Structure
JSON STRUCTUREOrders Toast Reference Structure
JSON STRUCTUREOrders Update Payment Request Structure
JSON STRUCTUREOrders Void Information Structure
JSON STRUCTUREPartners Paginated Response Structure
JSON STRUCTUREPartners Partner Access External Rep Structure
JSON STRUCTUREPartners Partner Access External Webhook Rep Structure
JSON STRUCTURERestaurants Day Schedule Structure
JSON STRUCTURERestaurants Delivery Payment Options Structure
JSON STRUCTURERestaurants Delivery Structure
JSON STRUCTURERestaurants General Structure
JSON STRUCTURERestaurants Hours Structure
JSON STRUCTURERestaurants Image Structure
JSON STRUCTURERestaurants Location Structure
JSON STRUCTURERestaurants Online Ordering Structure
JSON STRUCTURERestaurants Payment Options Structure
JSON STRUCTURERestaurants Prep Times Structure
JSON STRUCTURERestaurants Restaurant Info Structure
JSON STRUCTURERestaurants Restaurant Structure
JSON STRUCTURERestaurants Schedules Structure
JSON STRUCTURERestaurants Service Structure
JSON STRUCTURERestaurants Takeout Payment Options Structure
JSON STRUCTURERestaurants Urls Structure
JSON STRUCTURERestaurants Week Schedule Structure
JSON STRUCTUREStock Inventory Search Request Structure
JSON STRUCTUREStock Menu Item Inventory Structure
JSON STRUCTUREScroll within the panel for all 110 ·
Examples 94
Real request and response payloads are what turn a spec from abstract into obvious — and they're one of the twelve things an agent needs to call an API correctly on the first try.
Example request and response payloads for these APIs.
Labor Employee Example
EXAMPLELabor Job Example
EXAMPLELabor Shift Example
EXAMPLELabor Time Entry Example
EXAMPLEMenus Alcohol Example
EXAMPLEMenus Allergen Item Example
EXAMPLEMenus Availability Example
EXAMPLEMenus Item Tag Example
EXAMPLEMenus Menu Example
EXAMPLEMenus Menu Group Example
EXAMPLEMenus Menu Item Example
EXAMPLEMenus Metadata Example
EXAMPLEMenus Modifier Group Example
EXAMPLEMenus Portion Example
EXAMPLEMenus Pre Modifier Example
EXAMPLEMenus Pricing Rules Example
EXAMPLEMenus Restaurant Example
EXAMPLEMenus Sales Category Example
EXAMPLEMenus Schedule Example
EXAMPLEMenus Sequence Price Example
EXAMPLEMenus Time Range Example
EXAMPLEOrders Check Example
EXAMPLEOrders Customer Example
EXAMPLEOrders Delivery Info Example
EXAMPLEOrders Device Example
EXAMPLEOrders Fulfillment Example
EXAMPLEOrders Order Example
EXAMPLEOrders Payment Example
EXAMPLEOrders Refund Example
EXAMPLEOrders Selection Example
EXAMPLERestaurants Delivery Example
EXAMPLERestaurants General Example
EXAMPLERestaurants Hours Example
EXAMPLERestaurants Image Example
EXAMPLERestaurants Location Example
EXAMPLERestaurants Service Example
EXAMPLERestaurants Urls Example
EXAMPLEScroll within the panel for all 94 ·
Security Posture 3
Authentication, domain security, vulnerability disclosure, and trust-center signals — the evidence that a provider takes security seriously enough to document it. We profile it because you can't govern what you can't see.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
Scopes 1
OAuth scopes are the vocabulary of least-privilege access. Profiling them shows exactly what an integration — or an agent acting on a user's behalf — is allowed to do.
OAuth scopes governing access to this provider's APIs.
Agentic Access 1
An x-agentic-access contract marks which operations are safe for an agent to run on its own and which need a human in the loop. It is the difference between an API an agent can use and one it can use safely.
Recommended x-agentic-access execution contracts for AI agents.
Use Cases 4
What developers actually build with this provider — captured so the catalogue answers 'what is this for', not just 'what does this expose'.
What developers build with this provider.
Online Ordering Integration
Post orders and read menus/stock to power third-party ordering and delivery channels.
Payroll & Scheduling
Sync employees, jobs, shifts, and time entries into payroll, HR, and scheduling platforms.
BI & Reporting
Pull analytics and operational data into warehouses and BI tooling.
Gift Card & Loyalty Programs
Integrate third-party gift card, loyalty, and alternative tender programs via callback specs.
Integrations 3
Pre-built integrations with other platforms tell you where this provider already fits in a stack.
Pre-built integrations with other platforms and tools.
Delivery Marketplaces
Route demand and availability to delivery and online-ordering partners.
Payroll Providers
Labor API time entries feed payroll and workforce-management systems.
Loyalty & Gift Card Vendors
Inline callbacks let third-party loyalty/gift-card programs participate in checks.
Resources
Every other property we hold for Toast — documentation, portals, status pages, policies, and corporate surface — grouped by the job it does, following the integrator's arc from getting started to running in production.
Get Started 2
Portal, sign-up, and the first successful call
Documentation 5
Reference material describing how the API behaves
Agent Surfaces 1
MCP servers, agent skills, and machine-readable catalogs
Design & Contract 3
Pagination, idempotency, versioning, errors, and events
Build 1
SDKs, sample code, and the tooling you integrate with
Access & Security 5
Authentication, authorization, and security posture
Operate 4
Status, limits, changes, and where to get help
Commercial 3
Pricing, plans, and the legal terms of use
Company 4
The organization behind the API
← All providers · Data indexed from github.com/api-evangelist/toast-tab · machine-readable index on apis.io