Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Operational Unit API
17 actions
17 updates
phrasing
extends
openapi/deputy-operationalunit-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/OperationalUnit'].get
$.paths['/resource/OperationalUnit'].put
$.paths['/resource/OperationalUnit'].post
$.paths['/resource/OperationalUnit/BULK'].post
$.paths['/resource/OperationalUnit/INFO'].get
$.paths['/resource/OperationalUnit/PREDICT'].post
$.paths['/resource/OperationalUnit/QUERY'].post
$.paths['/resource/OperationalUnit/{id}'].get
$.paths['/resource/OperationalUnit/{id}'].put
$.paths['/resource/OperationalUnit/{id}'].post
$.paths['/resource/OperationalUnit/{id}'].delete
$.paths['/resource/OperationalUnit/{id}/COMMENTS'].get
$.paths['/resource/OperationalUnit/{id}/COMMENTS'].post
$.paths['/resource/OperationalUnit/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/OperationalUnit/{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 Operational Unit API
version: 1.0.0
extends: openapi/deputy-operationalunit-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/OperationalUnit'].get
update:
x-apievangelist-phrasing:
intent: List operational units
effect: read
questions:
- Which operational units exist in my company?
- Can I see every operational unit I have permission to see?
instructions:
- text: List all operational units.
- text: Show every operational unit record.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/OperationalUnit'].put
update:
x-apievangelist-phrasing:
intent: Create an operational unit (legacy PUT)
effect: write
questions:
- How do I create an operational unit with the older PUT endpoint?
- Can I replace an operational unit record by its id with a full PUT?
instructions:
- text: Create operational unit {name} in company {company} with PUT.
slots:
name: requestBody.OperationalUnitName
company: requestBody.Company
- text: Replace operational unit {name} in company {company} using the legacy PUT.
slots:
name: requestBody.OperationalUnitName
company: requestBody.Company
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/OperationalUnit'].post
update:
x-apievangelist-phrasing:
intent: Create an operational unit
effect: write
questions:
- How do I create a new operational unit?
- Can I set an operational unit's roster sort order and payroll export name?
instructions:
- text: Create operational unit {name} in company {company}.
slots:
name: requestBody.OperationalUnitName
company: requestBody.Company
- text: Create operational unit {name} in company {company} with roster sort order {order}.
slots:
name: requestBody.OperationalUnitName
company: requestBody.Company
order: requestBody.RosterSortOrder
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/OperationalUnit/BULK'].post
update:
x-apievangelist-phrasing:
intent: Create or update operational units in bulk
effect: write
questions:
- Can I create many operational units in one request?
- How do I update operational units in bulk?
instructions:
- text: Create or update these operational units in bulk.
- text: Bulk upsert operational units with this list.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/OperationalUnit/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get operational unit field metadata
effect: read
questions:
- Which fields can I query on operational units?
- What field types and associations does the operational unit resource have?
instructions:
- text: Get the operational unit field metadata.
- text: Show the operational unit resource schema.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/OperationalUnit/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing operational unit by name
effect: read
questions:
- How do I find an operational unit that already exists before creating one?
- Can I predict-match an operational unit by name?
instructions:
- text: Predict-match operational unit {name} in company {company}.
slots:
name: requestBody.OperationalUnitName
company: requestBody.Company
- text: Find the existing operational unit matching {name} in {company}.
slots:
name: requestBody.OperationalUnitName
company: requestBody.Company
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/OperationalUnit/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search operational units
effect: read
questions:
- Can I search operational units by name?
- How do I sort operational units by roster sort order?
instructions:
- text: Search operational units where {field} is {value}.
slots:
field: requestBody.search
value: requestBody.search
- text: Find operational units sorted by {sort}.
slots:
sort: requestBody.sort
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/OperationalUnit/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get an operational unit
effect: read
questions:
- What are the details of one operational unit?
- Can I fetch an operational unit by its id?
instructions:
- text: Get operational unit {id}.
slots:
id: path.id
- text: Show operational unit {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/OperationalUnit/{id}'].put
update:
x-apievangelist-phrasing:
intent: Replace an operational unit (legacy PUT)
effect: write
questions:
- How do I replace an operational unit record by its id with a full PUT?
- Can I overwrite an operational unit's roster active hours schedule?
instructions:
- text: Replace operational unit {id} with name {name} and roster sort order {order}.
slots:
id: path.id
name: requestBody.OperationalUnitName
order: requestBody.RosterSortOrder
- text: Overwrite operational unit {id} in full.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/OperationalUnit/{id}'].post
update:
x-apievangelist-phrasing:
intent: Update an operational unit
effect: write
questions:
- How do I change an operational unit's name?
- Can I deactivate an operational unit?
instructions:
- text: Update operational unit {id} to name {name}.
slots:
id: path.id
name: requestBody.OperationalUnitName
- text: Deactivate operational unit {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/OperationalUnit/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an operational unit
effect: destructive
questions:
- How do I delete an operational unit?
- Can I remove an operational unit from my company?
instructions:
- text: Delete operational unit {id}.
slots:
id: path.id
- text: Remove operational unit {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/OperationalUnit/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on an operational unit
effect: read
questions:
- What comments have been left on an operational unit?
- Can I see the comment history for an operational unit?
instructions:
- text: List comments on operational unit {id}.
slots:
id: path.id
- text: Show the comment history for operational unit {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/OperationalUnit/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Comment on an operational unit
effect: write
questions:
- How do I add a comment to an operational unit?
- Can I annotate an operational unit with a note?
instructions:
- text: Comment {comment} on operational unit {id}.
slots:
comment: requestBody.Comment
id: path.id
- text: Annotate operational unit {id} with {comment}.
slots:
id: path.id
comment: requestBody.Comment
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/OperationalUnit/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on an operational unit
effect: destructive
questions:
- How do I delete a comment from an operational unit?
- Can I remove a single comment on an operational unit?
instructions:
- text: Delete comment {commentId} from operational unit {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove comment {commentId} on operational unit {id}.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/OperationalUnit/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get an operational unit's change history
effect: read
questions:
- What changes have been made to an operational unit over time?
- Can I see the edit history of an operational unit?
instructions:
- text: Show the change history of operational unit {id}.
slots:
id: path.id
- text: List edits made to operational unit {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/OperationalUnit/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: View an operational unit as it was at a past time
effect: read
questions:
- How do I see what an operational unit looked like before a change?
- Can I travel back to an operational unit's state at a specific timestamp?
instructions:
- text: Show operational unit {id} as it was at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel back to operational unit {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-operationalunit-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.