Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V2 Pay Calendars API

10 actions 10 updates phrasing extends openapi/deputy-pay-calendars-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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/management/v2/pay-calendars'].get
$.paths['/management/v2/pay-calendars'].post
$.paths['/management/v2/pay-calendars/{id}'].get
$.paths['/management/v2/pay-calendars/{id}'].put
$.paths['/management/v2/pay-calendars/{id}/employees'].get
$.paths['/management/v2/pay-calendars/{id}/pay-periods'].get
$.paths['/management/v2/pay-calendars/{id}:assign'].post
$.paths['/management/v2/pay-calendars/{id}:deactivate'].post
$.paths['/management/v2/pay-calendars:searchEmployees'].get

OpenAPI Overlay

Raw ↑
# 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 Calendars API
  version: 1.0.0
extends: openapi/deputy-pay-calendars-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: 9
- target: $.paths['/management/v2/pay-calendars'].get
  update:
    x-apievangelist-phrasing:
      intent: List pay calendars
      effect: read
      questions:
      - Which pay calendars exist in my business?
      - Can I filter the list of pay calendars?
      instructions:
      - text: List all pay calendars.
      - text: Show pay calendars matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/pay-calendars'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a pay calendar
      effect: write
      questions:
      - How do I set up a new pay calendar?
      - Can I set the pay frequency and payment date when creating a calendar?
      instructions:
      - text: Create a pay calendar named {name} on {startDate} paid {paymentDate}.
        slots:
          name: requestBody.name
          startDate: requestBody.startDate
          paymentDate: requestBody.paymentDate
      - text: Create a {frequency} pay calendar {name} starting {startDate}.
        slots:
          frequency: requestBody.frequency
          name: requestBody.name
          startDate: requestBody.startDate
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/pay-calendars/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pay calendar
      effect: read
      questions:
      - What are the settings of one pay calendar?
      - Can I look up a pay calendar by id?
      instructions:
      - text: Get pay calendar {id}.
        slots:
          id: path.id
      - text: Show the details of pay calendar {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/pay-calendars/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a pay calendar
      effect: write
      questions:
      - Can I change the pay frequency of an existing calendar?
      - Is it possible to rename a pay calendar?
      instructions:
      - text: Change the frequency of pay calendar {id} to {frequency}.
        slots:
          id: path.id
          frequency: requestBody.frequency
      - text: Rename pay calendar {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/pay-calendars/{id}/employees'].get
  update:
    x-apievangelist-phrasing:
      intent: List employees on a pay calendar
      effect: read
      questions:
      - Which employees are assigned to a pay calendar?
      - Can I see who is on a calendar?
      instructions:
      - text: List employees assigned to pay calendar {id}.
        slots:
          id: path.id
      - text: Show employees on calendar {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/pay-calendars/{id}/pay-periods'].get
  update:
    x-apievangelist-phrasing:
      intent: List pay periods of a calendar
      effect: read
      questions:
      - What pay periods are in a pay calendar?
      - Can I list only the periods starting after a certain date?
      instructions:
      - text: List pay periods of calendar {id}.
        slots:
          id: path.id
      - text: Show pay periods in calendar {id} from {minStartDate} to {maxStartDate}.
        slots:
          id: path.id
          minStartDate: query.minStartDate
          maxStartDate: query.maxStartDate
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/pay-calendars/{id}:assign'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign employees to a pay calendar
      effect: write
      questions:
      - How do I assign employees to a pay calendar?
      - Can I assign employees matching a filter to a calendar?
      instructions:
      - text: Assign employees to pay calendar {id}.
        slots:
          id: path.id
      - text: Assign employees matching {filter} to calendar {id}.
        slots:
          filter: requestBody.filter
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/pay-calendars/{id}:deactivate'].post
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a pay calendar
      effect: destructive
      questions:
      - How do I stop a pay calendar from being used?
      - Can I deactivate a calendar without deleting it?
      instructions:
      - text: Deactivate pay calendar {id}.
        slots:
          id: path.id
      - text: Stop using calendar {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/pay-calendars:searchEmployees'].get
  update:
    x-apievangelist-phrasing:
      intent: Find employees on a pay calendar
      effect: read
      questions:
      - Which employees are on a pay calendar?
      - Can I search employees assigned to calendars by filter?
      instructions:
      - text: Search employees assigned to pay calendars.
      - text: Find employees on calendars matching {filters}.
        slots:
          filters: query.filters
      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.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/deputy-pay-calendars-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.