Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V2 Agreed Hour API
19 actions
19 updates
phrasing
extends
openapi/deputy-agreed-hour-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 19 · first 16 shown; the file carries all of them
$.info
$.paths['/management/v2/agreed_hour/employee/{employeeId}'].post
$.paths['/management/v2/agreed_hour/{employeeId}'].get
$.paths['/management/v2/agreed_hour/{employeeId}'].post
$.paths['/management/v2/agreed_hour/{employeeId}/{version}'].get
$.paths['/management/v2/agreed_hour:batchUpdate'].post
$.paths['/management/v2/agreed_hour:listCommonAreas'].post
$.paths['/management/v2/agreed_hours'].post
$.paths['/management/v2/agreed_hours/archive/{employeeId}/{version}'].post
$.paths['/management/v2/agreed_hours/audit/{employeeId}'].post
$.paths['/management/v2/agreed_hours/configuration/employee_approval/{employeeId}'].post
$.paths['/management/v2/agreed_hours/configuration/general/{employeeId}'].get
$.paths['/management/v2/agreed_hours/consent-records/{recordId}'].get
$.paths['/management/v2/agreed_hours/consent/{employeeId}/{version}'].post
$.paths['/management/v2/agreed_hours/diff/{employeeId}/{baseVersion}/{targetVersion}'].get
$.paths['/management/v2/agreed_hours/migrate/step-two/{locationId}'].post
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 V2 Agreed Hour API
version: 1.0.0
extends: openapi/deputy-agreed-hour-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: 18
- target: $.paths['/management/v2/agreed_hour/employee/{employeeId}'].post
update:
x-apievangelist-phrasing:
intent: Get an employee's agreed hours for a date
effect: read
questions:
- What are an employee's agreed hours for today?
- Can I fetch the agreed hours version that is in effect on a specific date?
instructions:
- text: Get agreed hours for employee {employeeId}.
slots:
employeeId: path.employeeId
- text: Get employee {employeeId}'s agreed hours as of {date}.
slots:
employeeId: path.employeeId
date: requestBody.date
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/agreed_hour/{employeeId}'].get
update:
x-apievangelist-phrasing:
intent: Get an employee's current agreed hours
effect: read
questions:
- What are the agreed hours an employee currently has on file?
- Can I see the latest agreed hours for one employee?
instructions:
- text: Get the current agreed hours for employee {employeeId}.
slots:
employeeId: path.employeeId
- text: Show employee {employeeId}'s agreed hours.
slots:
employeeId: path.employeeId
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/agreed_hour/{employeeId}'].post
update:
x-apievangelist-phrasing:
intent: Set an agreed hours schedule for an employee
effect: write
questions:
- How do I set an employee's agreed hours?
- Does the agreed hours schedule need specific weeks?
instructions:
- text: Set agreed hours {agreed} for employee {employeeId}.
slots:
agreed: requestBody.agreedHour
employeeId: path.employeeId
- text: Record {employeeId}'s agreed hours.
slots:
employeeId: path.employeeId
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/agreed_hour/{employeeId}/{version}'].get
update:
x-apievangelist-phrasing:
intent: Get an employee's agreed hours by version
effect: read
questions:
- What did an employee's agreed hours look like in a past version?
- Can I fetch a specific version of an employee's agreed hours?
instructions:
- text: Get version {version} of agreed hours for employee {employeeId}.
slots:
version: path.version
employeeId: path.employeeId
- text: Show employee {employeeId}'s agreed hours version {version}.
slots:
employeeId: path.employeeId
version: path.version
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/agreed_hour:batchUpdate'].post
update:
x-apievangelist-phrasing:
intent: Set agreed hours for many employees
effect: write
questions:
- Can I set the same agreed hours for a whole team at once?
- How do I update several employees' agreed hours in one request?
instructions:
- text: Set agreed hours {agreedHour} for employees {employeeIds}.
slots:
agreedHour: requestBody.agreedHour
employeeIds: requestBody.employeeIds
- text: Update agreed hours for team {employeeIds} to {agreedHour}.
slots:
employeeIds: requestBody.employeeIds
agreedHour: requestBody.agreedHour
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/agreed_hour:listCommonAreas'].post
update:
x-apievangelist-phrasing:
intent: Find common agreed hours areas for employees
effect: read
questions:
- Which agreed hours areas are shared by a group of employees?
- What common agreed hours areas exist across several employees?
instructions:
- text: Find common agreed hours areas for employees {employeeIds}.
slots:
employeeIds: requestBody.employeeIds
- text: List shared agreed hours areas of {employeeIds}.
slots:
employeeIds: requestBody.employeeIds
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/agreed_hours'].post
update:
x-apievangelist-phrasing:
intent: Search employees' agreed hours by status
effect: read
questions:
- Which employees have agreed hours that are still waiting for approval?
- Can I search across all employees for agreed hours in a given status?
- What agreed hours records exist for employees in a particular status?
instructions:
- text: Search all employees' agreed hours by status.
- text: List every employee whose agreed hours are pending approval.
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/agreed_hours/archive/{employeeId}/{version}'].post
update:
x-apievangelist-phrasing:
intent: Archive an agreed hours version with a reason
effect: destructive
questions:
- How do I archive an old agreed hours version with a reason?
- Can I record why an agreed hours version was archived?
instructions:
- text: Archive version {version} of agreed hours for employee {employeeId}.
slots:
version: path.version
employeeId: path.employeeId
- text: Archive employee {employeeId}'s agreed hours version {version} because {changesReason}.
slots:
employeeId: path.employeeId
version: path.version
changesReason: requestBody.changesReason
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/agreed_hours/audit/{employeeId}'].post
update:
x-apievangelist-phrasing:
intent: Audit an employee's agreed hours for a period
effect: read
questions:
- Can I audit an employee's agreed hours against their actual hours worked?
- What does an agreed hours audit for an employee look like?
instructions:
- text: Audit agreed hours for employee {employeeId}.
slots:
employeeId: path.employeeId
- text: Run an agreed hours audit for employee {employeeId}.
slots:
employeeId: path.employeeId
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/agreed_hours/configuration/employee_approval/{employeeId}'].post
update:
x-apievangelist-phrasing:
intent: Check if an employee's agreed hours need approval
effect: read
questions:
- Does an employee's agreed hours need approval before they take effect?
- How do I check the approval setting for an employee's agreed hours?
instructions:
- text: Check whether employee {employeeId}'s agreed hours need approval.
slots:
employeeId: path.employeeId
- text: Show the employee approval setting for agreed hours of {employeeId}.
slots:
employeeId: path.employeeId
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/agreed_hours/configuration/general/{employeeId}'].get
update:
x-apievangelist-phrasing:
intent: Get an employee's agreed hours settings
effect: read
questions:
- What are the general agreed hours settings for an employee?
- Can I read an employee's agreed hours configuration?
instructions:
- text: Get the agreed hours configuration for employee {employeeId}.
slots:
employeeId: path.employeeId
- text: Show general agreed hours settings of employee {employeeId}.
slots:
employeeId: path.employeeId
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/agreed_hours/consent-records/{recordId}'].get
update:
x-apievangelist-phrasing:
intent: Get an employee's agreed hours consent record
effect: read
questions:
- Did an employee consent to a particular agreed hours version?
- Can I fetch one agreed hours consent record by its record ID?
instructions:
- text: Get agreed hours consent record {recordId}.
slots:
recordId: path.recordId
- text: Show the consent record {recordId} for agreed hours.
slots:
recordId: path.recordId
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/agreed_hours/consent/{employeeId}/{version}'].post
update:
x-apievangelist-phrasing:
intent: Consent to an employee's agreed hours
effect: write
questions:
- How do I consent to an employee's agreed hours version?
- Can I record a comment when consenting to agreed hours?
instructions:
- text: Consent to agreed hours version {version} for employee {employeeId}.
slots:
version: path.version
employeeId: path.employeeId
- text: Consent to employee {employeeId}'s agreed hours version {version} with status {status}.
slots:
employeeId: path.employeeId
version: path.version
status: requestBody.status
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/agreed_hours/diff/{employeeId}/{baseVersion}/{targetVersion}'].get
update:
x-apievangelist-phrasing:
intent: Compare two agreed hours versions
effect: read
questions:
- What changed between two versions of an employee's agreed hours?
- Can I diff an employee's agreed hours from an older version to a newer one?
instructions:
- text: Diff agreed hours for employee {employeeId} from version {baseVersion} to {targetVersion}.
slots:
employeeId: path.employeeId
baseVersion: path.baseVersion
targetVersion: path.targetVersion
- text: Show the difference between agreed hours versions {baseVersion} and {targetVersion} for {employeeId}.
slots:
baseVersion: path.baseVersion
targetVersion: path.targetVersion
employeeId: path.employeeId
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/agreed_hours/migrate/step-two/{locationId}'].post
update:
x-apievangelist-phrasing:
intent: Complete the agreed hours migration for a location
effect: write
questions:
- How do I finish migrating agreed hours for a location?
- What happens in the second step of the agreed hours migration?
instructions:
- text: Run the second agreed hours migration step for location {locationId}.
slots:
locationId: path.locationId
- text: Complete agreed hours migration in location {locationId}.
slots:
locationId: path.locationId
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/agreed_hours/notify/{employeeId}/{version}'].post
update:
x-apievangelist-phrasing:
intent: Notify an employee of their agreed hours
effect: write
questions:
- How do I notify an employee that their agreed hours have been set?
- Can I send an agreed hours notification to an employee?
instructions:
- text: Notify employee {employeeId} of agreed hours version {version}.
slots:
employeeId: path.employeeId
version: path.version
- text: Send an agreed hours notification to employee {employeeId} for version {version}.
slots:
employeeId: path.employeeId
version: path.version
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/agreed_hours/{employeeId}'].post
update:
x-apievangelist-phrasing:
intent: Search an employee's agreed hours for a period
effect: read
questions:
- Can I search an employee's agreed hours for a specific pay period?
- What agreed hours were recorded for an employee during a date range?
instructions:
- text: Search agreed hours for employee {employeeId}.
slots:
employeeId: path.employeeId
- text: Find agreed hours for {employeeId} over a time period.
slots:
employeeId: path.employeeId
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/agreed_hours/{employeeId}/{version}'].delete
update:
x-apievangelist-phrasing:
intent: Archive an employee's agreed hours
effect: destructive
questions:
- How do I archive an employee's agreed hours?
- Can I remove an old agreed hours version?
instructions:
- text: Delete agreed hours version {version} for employee {employeeId}.
slots:
version: path.version
employeeId: path.employeeId
- text: Archive employee {employeeId}'s agreed hours.
slots:
employeeId: path.employeeId
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-agreed-hour-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.