Generated by API Evangelist
Written by API Evangelist tooling for Toast's API. It is a proposal applied on top of the contract, not a document Toast publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Configuration Sales Categories API
version: 1.0.0
extends: openapi/toast-sales-categories-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 2
- target: $.paths['/salesCategories/{guid}'].get
update:
x-apievangelist-phrasing:
intent: Look up one sales category
effect: read
questions:
- How do I see one sales category, like alcohol, used to analyze purchases?
- What details are stored on a single sales category?
instructions:
- text: Get sales category {guid} for restaurant {restaurant}.
slots:
guid: path.guid
restaurant: header.Toast-Restaurant-External-ID
- text: Show me sales category {guid}.
slots:
guid: path.guid
method: generated
generated: '2026-10-01'
- target: $.paths['/salesCategories'].get
update:
x-apievangelist-phrasing:
intent: List a restaurant's sales categories
effect: read
questions:
- Which sales categories, such as food and alcohol, does a restaurant use?
- Can I list only sales categories changed since a date?
instructions:
- text: List sales categories for restaurant {restaurant}.
slots:
restaurant: header.Toast-Restaurant-External-ID
- text: List sales categories at {restaurant} modified since {since}.
slots:
restaurant: header.Toast-Restaurant-External-ID
since: query.lastModified
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.