Deputy · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Deputy V1 Resource Company Period API
11 actions
11 updates
phrasing
extends
openapi/deputy-companyperiod-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 11
$.info
$.paths['/resource/CompanyPeriod'].get
$.paths['/resource/CompanyPeriod/INFO'].get
$.paths['/resource/CompanyPeriod/PREDICT'].post
$.paths['/resource/CompanyPeriod/QUERY'].post
$.paths['/resource/CompanyPeriod/{id}'].get
$.paths['/resource/CompanyPeriod/{id}/COMMENTS'].get
$.paths['/resource/CompanyPeriod/{id}/COMMENTS'].post
$.paths['/resource/CompanyPeriod/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/CompanyPeriod/{id}/HISTORY'].get
$.paths['/resource/CompanyPeriod/{id}/HISTORY/travel/{timestamp}'].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 Company Period API
version: 1.0.0
extends: openapi/deputy-companyperiod-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: 10
- target: $.paths['/resource/CompanyPeriod'].get
update:
x-apievangelist-phrasing:
intent: List company pay periods
effect: read
questions:
- Which company pay periods exist in Deputy?
- Can I page through all company periods?
instructions:
- text: List all company periods.
- text: Show every company pay period record.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CompanyPeriod/INFO'].get
update:
x-apievangelist-phrasing:
intent: Get the fields of company periods
effect: read
questions:
- What fields and types does a company period record have?
- Which company period fields can I query?
instructions:
- text: Show the field metadata for company periods.
- text: List the fields and types of company pay periods.
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CompanyPeriod/PREDICT'].post
update:
x-apievangelist-phrasing:
intent: Find an existing company period
effect: read
questions:
- Can I find the existing company period that matches a pay period start and end?
- What does predict return if no company period matches?
instructions:
- text: Predict the company period matching company {Company}, pay period {PayPeriod}, start {Start} and end {End}.
slots:
Company: requestBody.Company
PayPeriod: requestBody.PayPeriod
Start: requestBody.Start
End: requestBody.End
- text: Find the existing company period for {Company} with pay period {PayPeriod} covering {Start} to {End}.
slots:
Company: requestBody.Company
PayPeriod: requestBody.PayPeriod
Start: requestBody.Start
End: requestBody.End
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CompanyPeriod/QUERY'].post
update:
x-apievangelist-phrasing:
intent: Search company periods
effect: read
questions:
- Can I search company periods by pay period?
- How do I sort company periods by date?
instructions:
- text: Search company periods where {search}.
slots:
search: requestBody.search
- text: Find company periods matching {search} sorted by {sort}.
slots:
search: requestBody.search
sort: requestBody.sort
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CompanyPeriod/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a company period
effect: read
questions:
- How do I fetch one company period by id?
- What does a single company period record contain?
instructions:
- text: Get company period {id}.
slots:
id: path.id
- text: Show the company period with id {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CompanyPeriod/{id}/COMMENTS'].get
update:
x-apievangelist-phrasing:
intent: List comments on a company period
effect: read
questions:
- What comments have been left on a company period?
- Can I see the comment history of a pay period?
instructions:
- text: List comments on company period {id}.
slots:
id: path.id
- text: Show the comments left on company period {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CompanyPeriod/{id}/COMMENTS'].post
update:
x-apievangelist-phrasing:
intent: Comment on a company period
effect: write
questions:
- How do I leave a comment on a company period?
- Can I annotate a pay period record?
instructions:
- text: Comment {Comment} on company period {id}.
slots:
Comment: requestBody.Comment
id: path.id
- text: Add a comment to company period {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CompanyPeriod/{id}/COMMENTS/{commentId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a comment on a company period
effect: destructive
questions:
- How do I remove a comment from a company period?
- Can I delete a comment on a pay period?
instructions:
- text: Delete comment {commentId} from company period {id}.
slots:
commentId: path.commentId
id: path.id
- text: Remove comment {commentId} on company period {id}.
slots:
commentId: path.commentId
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CompanyPeriod/{id}/HISTORY'].get
update:
x-apievangelist-phrasing:
intent: Get change history of a company period
effect: read
questions:
- Who changed a company period and when?
- Can I see the change history of a pay period?
instructions:
- text: Show the change history of company period {id}.
slots:
id: path.id
- text: List the edits made to company period {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/resource/CompanyPeriod/{id}/HISTORY/travel/{timestamp}'].get
update:
x-apievangelist-phrasing:
intent: See a company period as it was at a past time
effect: read
questions:
- What did a company period look like at a specific point in the past?
- Can I travel back to a company period's state at a timestamp?
instructions:
- text: Show company period {id} as it existed at {timestamp}.
slots:
id: path.id
timestamp: path.timestamp
- text: Travel back to company period {id} at {timestamp} and show it.
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-companyperiod-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.