How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Toast Employees API

The Employees API from Toast — 6 operation(s) for employees.

Toast Employees API is one of 80 APIs that Toast publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Employees. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 6 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://toast-api-server/authentication/v1.

10 operations 6 paths 4 schemas 1 DELETE2 GET1 PATCH2 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Server
https://toast-api-server/authentication/v1
Contact
Toast developer support
Terms of Service
Resource Areas
1

Paths & Operations 10

Across 6 paths, the API surfaces 10 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Employees 10
GET
/employees
Toast Get Employees
employeesGet 2 params → 200500
POST
/employees
Toast Add an Employee
employeesPost 2 params body → 200400415500
GET
/employees/{employeeId}
Toast Get Information About One Employee
employeesEmployeeIdGet 2 params → 200400401403404500
DELETE
/employees/{employeeId}
Toast Delete an Employee
employeesEmployeeIdDelete 2 params → 200400404500
PATCH
/employees/{employeeId}
Toast Update Employee Information
employeesEmployeeIdPatch 3 params body → 200400404500
POST
/employees/{employeeId}/externalId
Toast Add an External Identifier
employeesEmployeeIdExternalIdPost 3 params body → 200
PUT
/employees/{employeeId}/externalId
Toast Add or Replace an External Identifier
employeesEmployeeIdExternalIdPut 3 params body → 200
PUT
/employees/{employeeId}/unarchive
Toast Unarchive an Employee
employeesEmployeeIdUnarchivePut 3 params → 200400
PUT
/employees/{employeeId}/jobs
Toast Replace a Jobs List
employeesEmployeeIdJobsPut 3 params body → 200
PUT
/employees/{employeeId}/wageOverrides
Toast Replace Wage Overrides
employeesEmployeeIdWageOverridesPut 3 params body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ToastReference (2 properties), JobWageOverride (2 properties). Each schema is shown below with its type and property counts.

JobWageOverride
object
The overriding job wage, for an employee that has a wage that differs from the job's default wage.
2 properties 2 required
ToastReference
object
A wrapper object with fields that allow reference to a Toast platform entity by Toast GUID.
2 properties 2 required
Employee
object
A restaurant employee
ExternalReference
object
A wrapper object with fields that allow reference to a Toast platform entity by Toast GUID or an external identifier.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

toast-employees-api-openapi.yml Raw ↑

Other APIs Toast publishes across the network.

Toast Authentication API
Toast ConnectedRestaurants API
Toast Discounts API
Toast Groups API
Toast Jobs API
Toast Menus API
Toast Metadata API
Toast Orders API
Toast Payments API
Toast Restaurants API
Toast Shifts API
Toast Stock API
Where this information came from

This is an independent, third-party profile of Toast Employees API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put 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.