Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy Hr API

5 actions 5 updates phrasing extends openapi/deputy-hr-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 5

$.info
$.paths['/hr/v2/employees/{employeeId}/onboarding/{actionName}'].put
$.paths['/hr/v2/employees/{employeeId}/onboarding/export'].get
$.paths['/hr/v2/employees/{employeeId}/pay-details/export'].get
$.paths['/hr/v2/onboarding/bulk-export'].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 Hr API
  version: 1.0.0
extends: openapi/deputy-hr-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: 4
- target: $.paths['/hr/v2/employees/{employeeId}/onboarding/{actionName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Perform an HR onboarding action
      effect: write
      questions:
      - How do I complete an onboarding task for an employee?
      - Can I trigger a specific HR onboarding action by name?
      instructions:
      - text: Perform onboarding action {action} on employee {employee}.
        slots:
          action: path.actionName
          employee: path.employeeId
      - text: Complete the {action} step for employee {employee}.
        slots:
          action: path.actionName
          employee: path.employeeId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/hr/v2/employees/{employeeId}/onboarding/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export an employee's HR onboarding data
      effect: read
      questions:
      - Can I download the HR onboarding data for an employee?
      - What does the onboarding export contain for a staff member?
      instructions:
      - text: Export HR onboarding data for employee {employee}.
        slots:
          employee: path.employeeId
      - text: Download the onboarding file for employee {employee}.
        slots:
          employee: path.employeeId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/hr/v2/employees/{employeeId}/pay-details/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export an employee's pay details
      effect: read
      questions:
      - Can I export an employee's pay details for payroll?
      - Where do I get the pay details for a staff member?
      instructions:
      - text: Export pay details for employee {employee}.
        slots:
          employee: path.employeeId
      - text: Download the pay details file for employee {employee}.
        slots:
          employee: path.employeeId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/hr/v2/onboarding/bulk-export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export HR onboarding data in bulk
      effect: read
      questions:
      - Can I export HR onboarding data for many employees at once?
      - Is there a cursor-based bulk export of onboarding data?
      instructions:
      - text: Export HR onboarding data in bulk.
      - text: Export up to {limit} HR onboarding records.
        slots:
          limit: query.limit
      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-hr-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.