Toast
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.
Real signal across most facets with visible, nameable gaps — the contract exists but is thin, or the portal is good while governance and commercial terms are absent.
API Evangelist profiles Toast the way a machine reads it — 373 machine-readable artifacts across 23 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 47.4/100 (developing), with a separate agent-readiness read of 48/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.
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 23
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
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 configuratio...
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, creat...
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.
Toast Kitchen API
The Toast Kitchen API returns information about kitchen operations for a restaurant, supporting kitchen display and fulfillment workflow integrations.
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.
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 mod...
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 tr...
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 ...
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 transacti...
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 23 ·
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 Schema
This conceptual GraphQL schema represents the Toast restaurant technology platform API surface. Toast provides cloud-based point-of-sale, payment processing, and business manage...
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.
Toast Plans Pricing
PLANSRate 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 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 Finops
FINOPSFeatures 8
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.
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).
Scroll within the panel for all 8 ·
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 Authentication Context
JSON-LDToast Labor Context
JSON-LDToast Menus Context
JSON-LDToast Orders Context
JSON-LDToast Partners Context
JSON-LDToast Restaurants Context
JSON-LDToast 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 112
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 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 SCHEMAErrorMessage
JSON SCHEMAInventorySearchRequest
JSON SCHEMAMenuItemInventory
JSON SCHEMAScroll within the panel for all 112 ·
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 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 Ur Ls Structure
JSON STRUCTURERestaurants Week Schedule Structure
JSON STRUCTUREStock Inventory Search Request Structure
JSON STRUCTUREStock Menu Item Inventory Structure
JSON STRUCTUREToast Structure
JSON STRUCTUREScroll within the panel for all 110 ·
Examples 91
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 Ur Ls Example
EXAMPLEScroll within the panel for all 91 ·
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 6
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
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 5
Pre-built integrations with other platforms tell you where this provider already fits in a stack.
Pre-built integrations with other platforms and tools.
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.
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 1
Reference material describing how the API behaves
Agent Surfaces 1
MCP servers, agent skills, and machine-readable catalogs
Design & Contract 2
Pagination, idempotency, versioning, errors, and events
Build 1
SDKs, sample code, and the tooling you integrate with
Access & Security 4
Authentication, authorization, and security posture
Company 2
The organization behind the API
← All providers · Data indexed from github.com/api-evangelist/toast · machine-readable index on apis.io