Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V2 Pay Comparison API
8 actions
8 updates
phrasing
extends
openapi/deputy-pay-comparison-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 8
$.info
$.paths['/v2/pay-comparison/cancel-reports'].post
$.paths['/v2/pay-comparison/delete-reports'].post
$.paths['/v2/pay-comparison/download-reports'].post
$.paths['/v2/pay-comparison/get-employees'].post
$.paths['/v2/pay-comparison/get-reports'].post
$.paths['/v2/pay-comparison/resubmit-reports'].post
$.paths['/v2/pay-comparison/submit-report'].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 Pay Comparison API
version: 1.0.0
extends: openapi/deputy-pay-comparison-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: 7
- target: $.paths['/v2/pay-comparison/cancel-reports'].post
update:
x-apievangelist-phrasing:
intent: Cancel pending pay comparison reports
effect: destructive
questions:
- How do I stop pay comparison reports that are still pending?
- Can I cancel pay comparison reports before they finish?
instructions:
- text: Cancel pay comparison reports {reportIds}.
slots:
reportIds: requestBody.reportIds
- text: Stop pending pay comparison reports {reportIds} from running.
slots:
reportIds: requestBody.reportIds
method: generated
generated: '2026-11-17'
- target: $.paths['/v2/pay-comparison/delete-reports'].post
update:
x-apievangelist-phrasing:
intent: Delete pay comparison reports
effect: destructive
questions:
- How do I permanently delete pay comparison reports?
- Can I remove pay comparison reports I no longer need?
instructions:
- text: Delete pay comparison reports {reportIds}.
slots:
reportIds: requestBody.reportIds
- text: Permanently remove pay comparison reports {reportIds}.
slots:
reportIds: requestBody.reportIds
method: generated
generated: '2026-11-17'
- target: $.paths['/v2/pay-comparison/download-reports'].post
update:
x-apievangelist-phrasing:
intent: Download pay comparison reports
effect: read
questions:
- How do I download the Excel spreadsheet for a pay comparison report?
- Can I get the results of a completed pay comparison report as a file?
instructions:
- text: Download pay comparison reports {reportIds}.
slots:
reportIds: requestBody.reportIds
- text: Get the Excel file for pay comparison reports {reportIds}.
slots:
reportIds: requestBody.reportIds
method: generated
generated: '2026-11-17'
- target: $.paths['/v2/pay-comparison/get-employees'].post
update:
x-apievangelist-phrasing:
intent: Find employees for pay comparison
effect: read
questions:
- Which employees can I include in a pay comparison report?
- Can I look up employees by contract ID for pay comparison?
instructions:
- text: Find employees matching {employeeQuery}.
slots:
employeeQuery: requestBody.employeeQuery
- text: List employees for pay comparison using contract IDs {contractIds}.
slots:
contractIds: requestBody.contractIds
method: generated
generated: '2026-11-17'
- target: $.paths['/v2/pay-comparison/get-reports'].post
update:
x-apievangelist-phrasing:
intent: Find pay comparison reports
effect: read
questions:
- What pay comparison reports have been run?
- Can I find pay comparison reports created within a date range?
instructions:
- text: Find pay comparison reports named {nameContains}.
slots:
nameContains: requestBody.nameContains
- text: List pay comparison reports created after {createdAfter}.
slots:
createdAfter: requestBody.createdAfter
method: generated
generated: '2026-11-17'
- target: $.paths['/v2/pay-comparison/resubmit-reports'].post
update:
x-apievangelist-phrasing:
intent: Resubmit pay comparison reports
effect: write
questions:
- How do I re-run a pay comparison report with a different date range?
- Can I resubmit pay comparison reports for a new period?
instructions:
- text: Resubmit pay comparison reports {reportIds} from {startDate} to {endDate}.
slots:
reportIds: requestBody.reportIds
startDate: requestBody.startDate
endDate: requestBody.endDate
- text: Re-run pay comparison reports {reportIds} for {startDate} through {endDate}.
slots:
reportIds: requestBody.reportIds
startDate: requestBody.startDate
endDate: requestBody.endDate
method: generated
generated: '2026-11-17'
- target: $.paths['/v2/pay-comparison/submit-report'].post
update:
x-apievangelist-phrasing:
intent: Submit a pay comparison report
effect: write
questions:
- How do I compare pay rates against an award for a group of employees?
- Can I override the base rate used in a pay comparison report?
instructions:
- text: Submit a pay comparison report named {name} from {start} to {end}.
slots:
name: requestBody.name
start: requestBody.start
end: requestBody.end
- text: Compare pay against award {awardOverride} for employees {employeeQuery}.
slots:
awardOverride: requestBody.awardOverride
employeeQuery: requestBody.employeeQuery
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-pay-comparison-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.