Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Employee Workplace API
17 actions
17 updates
phrasing
extends
openapi/deputy-employeeworkplace-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Deputy's API. It is a proposal applied on top of the contract, not a document Deputy publishes.
What the actions change
x-apievangelist-phrasing
Targets 17 · first 16 shown; the file carries all of them
$.info
$.paths['/resource/EmployeeWorkplace'].get
$.paths['/resource/EmployeeWorkplace'].put
$.paths['/resource/EmployeeWorkplace'].post
$.paths['/resource/EmployeeWorkplace/BULK'].post
$.paths['/resource/EmployeeWorkplace/INFO'].get
$.paths['/resource/EmployeeWorkplace/PREDICT'].post
$.paths['/resource/EmployeeWorkplace/QUERY'].post
$.paths['/resource/EmployeeWorkplace/{id}'].get
$.paths['/resource/EmployeeWorkplace/{id}'].put
$.paths['/resource/EmployeeWorkplace/{id}'].post
$.paths['/resource/EmployeeWorkplace/{id}'].delete
$.paths['/resource/EmployeeWorkplace/{id}/COMMENTS'].get
$.paths['/resource/EmployeeWorkplace/{id}/COMMENTS'].post
$.paths['/resource/EmployeeWorkplace/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/EmployeeWorkplace/{id}/HISTORY'].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 Deputy V1 Resource Employee Workplace API
version: 1.0.0
extends: openapi/deputy-employeeworkplace-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-11-17'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 16
- target: $.paths['/resource/EmployeeWorkplace'].get
update:
x-apievangelist-phrasing:
intent: List employee workplace records
effect: read
questions:
- Which workplaces are assigned to my employees?
- Can I page through employee workplace records?
instructions:
- text: List all employee workplace records.
- text: Show every employee workplace assignment.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeWorkplace'].put
update:
x-apievangelist-phrasing:
intent: Create or replace an employee workplace record
effect: write
questions:
- How do I create a workplace assignment for an employee?
- Can I overwrite an existing employee workplace record in one call?
instructions:
- text: Create employee workplace {employeeId} at {company} with sort order {sortOrder}.
slots:
employeeId: requestBody.EmployeeId
company: requestBody.Company
sortOrder: requestBody.SortOrder
- text: Replace the employee workplace record {id} for {employeeId} at {company} sorted {sortOrder}.
slots:
id: requestBody.Id
employeeId: requestBody.EmployeeId
company: requestBody.Company
sortOrder: requestBody.SortOrder
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeWorkplace'].post
update:
x-apievangelist-phrasing:
intent: Create an employee workplace record
effect: write
questions:
- Can I create a new employee workplace assignment?
- What fields are required to add a workplace record?
instructions:
- text: Add a workplace assignment for employee {employeeId} at {company} at sort order {sortOrder}.
slots:
employeeId: requestBody.EmployeeId
company: requestBody.Company
sortOrder: requestBody.SortOrder
- text: Create a new employee workplace record with id {id}, employee {employeeId}, company {company}, sort {sortOrder}.
slots:
id: requestBody.Id
employeeId: requestBody.EmployeeId
company: requestBody.Company
sortOrder: requestBody.SortOrder
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeWorkplace/BULK'].post
update:
x-apievangelist-phrasing:
intent: Bulk create or update employee workplaces
effect: write
questions:
- Can I create many employee workplace records in one request?
- How are each record in a bulk workplace create processed?
instructions:
- text: Bulk create or update these employee workplace records.
- text: Process each workplace record in this bulk request independently.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeWorkplace/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get field metadata for employee workplaces
effect: read
questions:
- Which fields can I query on employee workplace records?
- What types and associations does the employee workplace resource have?
instructions:
- text: Show the field metadata for employee workplace records.
- text: List the queryable fields and associations of employee workplaces.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeWorkplace/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing employee workplace
effect: read
questions:
- Can I find an existing workplace assignment before creating one?
- Which fields does the predict-match use to find an employee workplace?
instructions:
- text: Predict-match an employee workplace for {employeeId} at {company} with sort order {sortOrder}.
slots:
employeeId: requestBody.EmployeeId
company: requestBody.Company
sortOrder: requestBody.SortOrder
- text: Find the closest existing workplace assignment for {employeeId} at {company}, sorted {sortOrder}.
slots:
employeeId: requestBody.EmployeeId
company: requestBody.Company
sortOrder: requestBody.SortOrder
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeWorkplace/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search employee workplace records
effect: read
questions:
- How do I find employee workplaces by company or sort order?
- Can I sort and page through employee workplace search results?
instructions:
- text: Search employee workplaces matching {search}.
slots:
search: requestBody.search
- text: Find employee workplaces sorted by {sort}, {max} at a time.
slots:
sort: requestBody.sort
max: requestBody.max
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeWorkplace/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get an employee workplace record
effect: read
questions:
- What company and sort order does a specific employee workplace have?
- Can I fetch one employee workplace record by id?
instructions:
- text: Get employee workplace {id}.
slots:
id: path.id
- text: Show the company and sort order of employee workplace {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeWorkplace/{id}'].put
update:
x-apievangelist-phrasing:
intent: Replace an employee workplace record
effect: write
questions:
- How do I overwrite an entire employee workplace record?
- Can I set all fields of an employee workplace in one update?
instructions:
- text: Replace employee workplace {id} with employee {employeeId}, company {company}, sort {sortOrder}.
slots:
id: path.id
employeeId: requestBody.EmployeeId
company: requestBody.Company
sortOrder: requestBody.SortOrder
- text: Overwrite the whole employee workplace record {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeWorkplace/{id}'].post
update:
x-apievangelist-phrasing:
intent: Update an employee workplace record
effect: write
questions:
- Can I change just the company on an employee workplace assignment?
- How do I edit an existing employee workplace record?
instructions:
- text: Update employee workplace {id} to company {company}.
slots:
id: path.id
company: requestBody.Company
- text: Set the sort order of employee workplace {id} to {sortOrder}.
slots:
id: path.id
sortOrder: requestBody.SortOrder
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeWorkplace/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an employee workplace record
effect: destructive
questions:
- How do I remove an employee workplace assignment?
- Can I delete an employee workplace record by id?
instructions:
- text: Delete employee workplace {id}.
slots:
id: path.id
- text: Remove the employee workplace assignment {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeWorkplace/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on an employee workplace
effect: read
questions:
- What comments have been left on an employee workplace?
- Can I read the comment history of a workplace assignment?
instructions:
- text: List comments on employee workplace {id}.
slots:
id: path.id
- text: Show the comment history for employee workplace {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeWorkplace/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Add a comment to an employee workplace
effect: write
questions:
- How do I annotate an employee workplace assignment?
- Can I add a comment to a workplace record?
instructions:
- text: Add comment {comment} to employee workplace {id}.
slots:
comment: requestBody.Comment
id: path.id
- text: Comment {comment} on workplace assignment {id}.
slots:
comment: requestBody.Comment
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeWorkplace/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on an employee workplace
effect: destructive
questions:
- How do I remove a comment from an employee workplace?
- Can I delete a single comment on a workplace record?
instructions:
- text: Delete comment {commentId} from employee workplace {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove the comment {commentId} on workplace assignment {id}.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeWorkplace/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get change history of an employee workplace
effect: read
questions:
- Who changed an employee workplace and when?
- Can I see the full edit history of a workplace record?
instructions:
- text: Show the change history of employee workplace {id}.
slots:
id: path.id
- text: List every edit made to workplace assignment {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/EmployeeWorkplace/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: Get an employee workplace as it was at a past time
effect: read
questions:
- Can I see an employee workplace assignment as it existed at a past moment?
- What did a workplace record look like at a given timestamp?
instructions:
- text: Show employee workplace {id} as it was at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel back to workplace assignment {id} at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
method: generated
generated: '2026-11-17'
Work with this as data
Every overlay here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for openapi overlays
4 MCP tools reach this
find_overlaysBrowse and filter every overlay in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/deputy-employeeworkplace-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"
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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.