Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V2 Employee Onboarding API

5 actions 5 updates phrasing extends openapi/deputy-employee-onboarding-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['/employee/v2/hr/onboarding/export'].post
$.paths['/employee/v2/hr/onboarding/list-updated-by-date-range'].post
$.paths['/employee/v2/hr/onboarding/status'].get
$.paths['/management/v2/employees/{employeeId}/hr/onboarding/callback/store-onboarding-id'].post

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 Employee Onboarding API
  version: 1.0.0
extends: openapi/deputy-employee-onboarding-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['/employee/v2/hr/onboarding/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export employee onboarding data
      effect: read
      questions:
      - Can I export all employee onboarding records at once?
      - What does the onboarding export return?
      instructions:
      - text: Export the employee onboarding data.
      - text: Run the onboarding export for all employees.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/employee/v2/hr/onboarding/list-updated-by-date-range'].post
  update:
    x-apievangelist-phrasing:
      intent: List employees with onboarding updated in a date range
      effect: read
      questions:
      - Which employees had onboarding updated between two dates?
      - Can I list onboarding changes for specific locations in a date range?
      instructions:
      - text: List employees whose onboarding was updated between {startDate} and {endDate}.
        slots:
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      - text: Show onboarding changes for locations {locationIds} from {startDate} to {endDate}.
        slots:
          locationIds: requestBody.locationIds
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-11-17'
- target: $.paths['/employee/v2/hr/onboarding/status'].get
  update:
    x-apievangelist-phrasing:
      intent: List onboarding status for all employees
      effect: read
      questions:
      - What is the onboarding status of every employee?
      - Is onboarding complete for each employee?
      instructions:
      - text: List the onboarding status for all employees.
      - text: Show which employees have finished onboarding.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/employees/{employeeId}/hr/onboarding/callback/store-onboarding-id'].post
  update:
    x-apievangelist-phrasing:
      intent: Store an onboarding ID for an employee
      effect: write
      questions:
      - How do I record an onboarding ID for an employee?
      - Can I save an onboarding ID from an external system?
      instructions:
      - text: Store onboarding ID {onboardingId} for employee {employeeId}.
        slots:
          onboardingId: requestBody.onboardingId
          employeeId: path.employeeId
      - text: Record external onboarding ID {onboardingId} for employee {employeeId}.
        slots:
          onboardingId: requestBody.onboardingId
          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.
All 92 tools →

Call it yourself

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