Toast · Capability
Toast Labor API — Employees
Toast Labor API — Employees. 10 operations. Lead operation: Toast Get Employees. Self-contained Naftiko capability covering one Toast business surface.
What You Can Do
GET
Employeesget
— Toast Get Employees
/v1/employees
POST
Employeespost
— Toast Add an Employee
/v1/employees
GET
Employeesemployeeidget
— Toast Get Information About One Employee
/v1/employees/{employeeid}
DELETE
Employeesemployeeiddelete
— Toast Delete an Employee
/v1/employees/{employeeid}
PATCH
Employeesemployeeidpatch
— Toast Update Employee Information
/v1/employees/{employeeid}
POST
Employeesemployeeidexternalidpost
— Toast Add an External Identifier
/v1/employees/{employeeid}/externalid
PUT
Employeesemployeeidexternalidput
— Toast Add or Replace an External Identifier
/v1/employees/{employeeid}/externalid
PUT
Employeesemployeeidjobsput
— Toast Replace a Jobs List
/v1/employees/{employeeid}/jobs
PUT
Employeesemployeeidunarchiveput
— Toast Unarchive an Employee
/v1/employees/{employeeid}/unarchive
PUT
Employeesemployeeidwageoverridesput
— Toast Replace Wage Overrides
/v1/employees/{employeeid}/wageoverrides
MCP Tools
toast-get-employees
Toast Get Employees
read-only
idempotent
toast-add-employee
Toast Add an Employee
toast-get-information-about-one
Toast Get Information About One Employee
read-only
idempotent
toast-delete-employee
Toast Delete an Employee
idempotent
toast-update-employee-information
Toast Update Employee Information
idempotent
toast-add-external-identifier
Toast Add an External Identifier
toast-add-replace-external-identifier
Toast Add or Replace an External Identifier
idempotent
toast-replace-jobs-list
Toast Replace a Jobs List
idempotent
toast-unarchive-employee
Toast Unarchive an Employee
idempotent
toast-replace-wage-overrides
Toast Replace Wage Overrides
idempotent
Capability Spec
naftiko: 1.0.0-alpha2
info:
label: Toast Labor API — Employees
description: 'Toast Labor API — Employees. 10 operations. Lead operation: Toast Get Employees. Self-contained Naftiko capability
covering one Toast business surface.'
tags:
- Toast
- Employees
created: '2026-05-19'
modified: '2026-05-19'
binds:
- namespace: env
keys:
TOAST_API_KEY: TOAST_API_KEY
capability:
consumes:
- type: http
namespace: labor-employees
baseUri: https://toast-api-server/labor/v1
description: Toast Labor API — Employees business capability. Self-contained, no shared references.
resources:
- name: employees
path: /employees
operations:
- name: employeesget
method: GET
description: Toast Get Employees
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Toast-Restaurant-External-ID
in: header
type: string
description: 'The Toast platform GUID of the restaurant that is the '
required: true
- name: employeeIds
in: query
type: string
description: 'An optional identifier that filters return values for a '
- name: employeespost
method: POST
description: Toast Add an Employee
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Toast-Restaurant-External-ID
in: header
type: string
description: 'The Toast platform GUID of the restaurant that is the '
required: true
- name: Content-Type
in: header
type: string
description: 'The Internet Assigned Numbers Authority (IANA) media type '
required: true
- name: body
in: body
type: string
description: 'An `Employee` object containing information about the '
required: true
- name: employees-employeeId
path: /employees/{employeeId}
operations:
- name: employeesemployeeidget
method: GET
description: Toast Get Information About One Employee
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Toast-Restaurant-External-ID
in: header
type: string
description: 'The Toast platform GUID of the restaurant that is the '
required: true
- name: employeeId
in: path
type: string
description: The Toast platform GUID or external identifier for the
required: true
- name: employeesemployeeiddelete
method: DELETE
description: Toast Delete an Employee
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Toast-Restaurant-External-ID
in: header
type: string
description: 'The Toast platform GUID of the restaurant that is the '
required: true
- name: employeeId
in: path
type: string
description: 'The Toast platform GUID or external identifier for the '
required: true
- name: employeesemployeeidpatch
method: PATCH
description: Toast Update Employee Information
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Toast-Restaurant-External-ID
in: header
type: string
description: 'The Toast platform GUID of the restaurant that is the '
required: true
- name: Content-Type
in: header
type: string
description: 'The Internet Assigned Numbers Authority (IANA) media type '
required: true
- name: employeeId
in: path
type: string
description: 'The Toast platform GUID or external identifier for the '
required: true
- name: body
in: body
type: string
description: 'A JSON object containing the employee information that you '
required: true
- name: employees-employeeId-externalId
path: /employees/{employeeId}/externalId
operations:
- name: employeesemployeeidexternalidpost
method: POST
description: Toast Add an External Identifier
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Toast-Restaurant-External-ID
in: header
type: string
description: 'The Toast platform GUID of the restaurant that is the '
required: true
- name: Content-Type
in: header
type: string
description: 'The Internet Assigned Numbers Authority (IANA) media type '
required: true
- name: body
in: body
type: string
description: 'The JSON string value of the `externalId` for the employee '
required: true
- name: employeesemployeeidexternalidput
method: PUT
description: Toast Add or Replace an External Identifier
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Toast-Restaurant-External-ID
in: header
type: string
description: 'The Toast platform GUID of the restaurant that is the '
required: true
- name: Content-Type
in: header
type: string
description: 'The Internet Assigned Numbers Authority (IANA) media type '
required: true
- name: body
in: body
type: string
description: 'The JSON string value of the `externalId` for the employee '
required: true
- name: employees-employeeId-jobs
path: /employees/{employeeId}/jobs
operations:
- name: employeesemployeeidjobsput
method: PUT
description: Toast Replace a Jobs List
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Toast-Restaurant-External-ID
in: header
type: string
description: 'The Toast platform GUID of the restaurant that is the '
required: true
- name: Content-Type
in: header
type: string
description: 'The Internet Assigned Numbers Authority (IANA) media type '
required: true
- name: body
in: body
type: string
description: 'An array of JSON objects containing identifiers for jobs. '
required: true
- name: employees-employeeId-unarchive
path: /employees/{employeeId}/unarchive
operations:
- name: employeesemployeeidunarchiveput
method: PUT
description: Toast Unarchive an Employee
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Toast-Restaurant-External-ID
in: header
type: string
description: 'The Toast platform GUID of the restaurant that is the '
required: true
- name: Content-Type
in: header
type: string
description: 'The Internet Assigned Numbers Authority (IANA) media type '
required: true
- name: employees-employeeId-wageOverrides
path: /employees/{employeeId}/wageOverrides
operations:
- name: employeesemployeeidwageoverridesput
method: PUT
description: Toast Replace Wage Overrides
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: Toast-Restaurant-External-ID
in: header
type: string
description: 'The Toast platform GUID of the restaurant that is the '
required: true
- name: Content-Type
in: header
type: string
description: 'The Internet Assigned Numbers Authority (IANA) media type '
required: true
- name: body
in: body
type: string
description: An array of JSON `JobWageOverride` objects.
required: true
exposes:
- type: rest
namespace: labor-employees-rest
port: 8080
description: REST adapter for Toast Labor API — Employees. One Spectral-compliant resource per consumed operation, prefixed
with /v1.
resources:
- path: /v1/employees
name: employees
description: REST surface for employees.
operations:
- method: GET
name: employeesget
description: Toast Get Employees
call: labor-employees.employeesget
with:
Toast-Restaurant-External-ID: rest.Toast-Restaurant-External-ID
employeeIds: rest.employeeIds
outputParameters:
- type: object
mapping: $.
- method: POST
name: employeespost
description: Toast Add an Employee
call: labor-employees.employeespost
with:
Toast-Restaurant-External-ID: rest.Toast-Restaurant-External-ID
Content-Type: rest.Content-Type
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/employees/{employeeid}
name: employees-employeeid
description: REST surface for employees-employeeId.
operations:
- method: GET
name: employeesemployeeidget
description: Toast Get Information About One Employee
call: labor-employees.employeesemployeeidget
with:
Toast-Restaurant-External-ID: rest.Toast-Restaurant-External-ID
employeeId: rest.employeeId
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: employeesemployeeiddelete
description: Toast Delete an Employee
call: labor-employees.employeesemployeeiddelete
with:
Toast-Restaurant-External-ID: rest.Toast-Restaurant-External-ID
employeeId: rest.employeeId
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: employeesemployeeidpatch
description: Toast Update Employee Information
call: labor-employees.employeesemployeeidpatch
with:
Toast-Restaurant-External-ID: rest.Toast-Restaurant-External-ID
Content-Type: rest.Content-Type
employeeId: rest.employeeId
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/employees/{employeeid}/externalid
name: employees-employeeid-externalid
description: REST surface for employees-employeeId-externalId.
operations:
- method: POST
name: employeesemployeeidexternalidpost
description: Toast Add an External Identifier
call: labor-employees.employeesemployeeidexternalidpost
with:
Toast-Restaurant-External-ID: rest.Toast-Restaurant-External-ID
Content-Type: rest.Content-Type
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: PUT
name: employeesemployeeidexternalidput
description: Toast Add or Replace an External Identifier
call: labor-employees.employeesemployeeidexternalidput
with:
Toast-Restaurant-External-ID: rest.Toast-Restaurant-External-ID
Content-Type: rest.Content-Type
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/employees/{employeeid}/jobs
name: employees-employeeid-jobs
description: REST surface for employees-employeeId-jobs.
operations:
- method: PUT
name: employeesemployeeidjobsput
description: Toast Replace a Jobs List
call: labor-employees.employeesemployeeidjobsput
with:
Toast-Restaurant-External-ID: rest.Toast-Restaurant-External-ID
Content-Type: rest.Content-Type
body: rest.body
outputParameters:
- type: object
mapping: $.
- path: /v1/employees/{employeeid}/unarchive
name: employees-employeeid-unarchive
description: REST surface for employees-employeeId-unarchive.
operations:
- method: PUT
name: employeesemployeeidunarchiveput
description: Toast Unarchive an Employee
call: labor-employees.employeesemployeeidunarchiveput
with:
Toast-Restaurant-External-ID: rest.Toast-Restaurant-External-ID
Content-Type: rest.Content-Type
outputParameters:
- type: object
mapping: $.
- path: /v1/employees/{employeeid}/wageoverrides
name: employees-employeeid-wageoverrides
description: REST surface for employees-employeeId-wageOverrides.
operations:
- method: PUT
name: employeesemployeeidwageoverridesput
description: Toast Replace Wage Overrides
call: labor-employees.employeesemployeeidwageoverridesput
with:
Toast-Restaurant-External-ID: rest.Toast-Restaurant-External-ID
Content-Type: rest.Content-Type
body: rest.body
outputParameters:
- type: object
mapping: $.
- type: mcp
namespace: labor-employees-mcp
port: 9090
transport: http
description: MCP adapter for Toast Labor API — Employees. One tool per consumed operation, routed inline through this
capability's consumes block.
tools:
- name: toast-get-employees
description: Toast Get Employees
hints:
readOnly: true
destructive: false
idempotent: true
call: labor-employees.employeesget
with:
Toast-Restaurant-External-ID: tools.Toast-Restaurant-External-ID
employeeIds: tools.employeeIds
outputParameters:
- type: object
mapping: $.
- name: toast-add-employee
description: Toast Add an Employee
hints:
readOnly: false
destructive: false
idempotent: false
call: labor-employees.employeespost
with:
Toast-Restaurant-External-ID: tools.Toast-Restaurant-External-ID
Content-Type: tools.Content-Type
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: toast-get-information-about-one
description: Toast Get Information About One Employee
hints:
readOnly: true
destructive: false
idempotent: true
call: labor-employees.employeesemployeeidget
with:
Toast-Restaurant-External-ID: tools.Toast-Restaurant-External-ID
employeeId: tools.employeeId
outputParameters:
- type: object
mapping: $.
- name: toast-delete-employee
description: Toast Delete an Employee
hints:
readOnly: false
destructive: true
idempotent: true
call: labor-employees.employeesemployeeiddelete
with:
Toast-Restaurant-External-ID: tools.Toast-Restaurant-External-ID
employeeId: tools.employeeId
outputParameters:
- type: object
mapping: $.
- name: toast-update-employee-information
description: Toast Update Employee Information
hints:
readOnly: false
destructive: false
idempotent: true
call: labor-employees.employeesemployeeidpatch
with:
Toast-Restaurant-External-ID: tools.Toast-Restaurant-External-ID
Content-Type: tools.Content-Type
employeeId: tools.employeeId
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: toast-add-external-identifier
description: Toast Add an External Identifier
hints:
readOnly: false
destructive: false
idempotent: false
call: labor-employees.employeesemployeeidexternalidpost
with:
Toast-Restaurant-External-ID: tools.Toast-Restaurant-External-ID
Content-Type: tools.Content-Type
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: toast-add-replace-external-identifier
description: Toast Add or Replace an External Identifier
hints:
readOnly: false
destructive: false
idempotent: true
call: labor-employees.employeesemployeeidexternalidput
with:
Toast-Restaurant-External-ID: tools.Toast-Restaurant-External-ID
Content-Type: tools.Content-Type
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: toast-replace-jobs-list
description: Toast Replace a Jobs List
hints:
readOnly: false
destructive: false
idempotent: true
call: labor-employees.employeesemployeeidjobsput
with:
Toast-Restaurant-External-ID: tools.Toast-Restaurant-External-ID
Content-Type: tools.Content-Type
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: toast-unarchive-employee
description: Toast Unarchive an Employee
hints:
readOnly: false
destructive: false
idempotent: true
call: labor-employees.employeesemployeeidunarchiveput
with:
Toast-Restaurant-External-ID: tools.Toast-Restaurant-External-ID
Content-Type: tools.Content-Type
outputParameters:
- type: object
mapping: $.
- name: toast-replace-wage-overrides
description: Toast Replace Wage Overrides
hints:
readOnly: false
destructive: false
idempotent: true
call: labor-employees.employeesemployeeidwageoverridesput
with:
Toast-Restaurant-External-ID: tools.Toast-Restaurant-External-ID
Content-Type: tools.Content-Type
body: tools.body
outputParameters:
- type: object
mapping: $.