Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Toast Labor Time entries API

3 actions 3 updates phrasing extends openapi/toast-time-entries-api-openapi.yml

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.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/timeEntries'].get

$.paths['/timeEntries/{timeEntryId}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Toast Labor Time entries API
  version: 1.0.0
extends: openapi/toast-time-entries-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['/timeEntries'].get
  update:
    x-apievangelist-phrasing:
      intent: List employee clock-in time entries
      effect: read
      questions:
      - When did employees clock in and out, including breaks, on a given business day?
      - Can I include missed breaks and archived entries when listing time entries?
      - Can I find time entries that were edited within a date range?
      instructions:
      - text: List time entries at {restaurant} for business date {date}.
        slots:
          restaurant: header.Toast-Restaurant-External-ID
          date: query.businessDate
      - text: List time entries between {start} and {end}, including missed breaks.
        slots:
          start: query.startDate
          end: query.endDate
      - text: List time entries modified between {mod_start} and {mod_end}.
        slots:
          mod_start: query.modifiedStartDate
          mod_end: query.modifiedEndDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/timeEntries/{timeEntryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one time entry
      effect: read
      questions:
      - What were the start, end and break times for one employee time entry?
      - Can I get a single time entry even if it is archived?
      instructions:
      - text: Get time entry {entry} at restaurant {restaurant}.
        slots:
          entry: path.timeEntryId
          restaurant: header.Toast-Restaurant-External-ID
      - text: Show time entry {entry} including missed breaks.
        slots:
          entry: path.timeEntryId
      method: generated
      generated: '2026-10-01'