Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy Employees API

19 actions 19 updates phrasing extends openapi/deputy-employees-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 19 · first 16 shown; the file carries all of them

$.info
$.paths['/v1/supervise/employee'].get
$.paths['/v1/supervise/employee'].post
$.paths['/v1/supervise/employee/{employeeid}'].get
$.paths['/v1/supervise/employee/{employeeid}/activate'].post
$.paths['/v1/supervise/employee/{employeeid}/assoc/{locationid}'].post
$.paths['/v1/supervise/employee/{employeeid}/delete'].post
$.paths['/v1/supervise/employee/{employeeid}/invite'].post
$.paths['/v1/supervise/employee/{employeeid}/setAwardFromLibrary'].post
$.paths['/v1/supervise/employee/{employeeid}/terminate'].post
$.paths['/v1/supervise/employee/{employeeid}/unassoc/{locationid}'].post
$.paths['/v1/supervise/employee/{id}'].post
$.paths['/management/v2/employees'].get
$.paths['/management/v2/employees'].post
$.paths['/management/v2/employees/{id}'].get
$.paths['/management/v2/employees/{id}'].patch

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 Employees API
  version: 1.0.0
extends: openapi/deputy-employees-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: 18
- target: $.paths['/v1/supervise/employee'].get
  update:
    x-apievangelist-phrasing:
      intent: List all employees
      effect: read
      questions:
      - How do I get a list of every employee in Deputy?
      - Can I include archived employees when listing everyone?
      instructions:
      - text: List all employees.
      - text: Show every employee record in the company.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v1/supervise/employee'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an employee
      effect: write
      questions:
      - How do I add a new employee to a company?
      - Can I set an employee's start date and gender when adding them?
      instructions:
      - text: Add employee {strFirstName} {strLastName} to company {intCompanyId}.
        slots:
          strFirstName: requestBody.strFirstName
          strLastName: requestBody.strLastName
          intCompanyId: requestBody.intCompanyId
      - text: Enrol {strFirstName} {strLastName} at company {intCompanyId} starting {strStartDate}.
        slots:
          strFirstName: requestBody.strFirstName
          strLastName: requestBody.strLastName
          intCompanyId: requestBody.intCompanyId
          strStartDate: requestBody.strStartDate
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v1/supervise/employee/{employeeid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee's details
      effect: read
      questions:
      - What are the details of a specific employee?
      - Can I look up one employee by their id?
      instructions:
      - text: Get employee {employeeid}.
        slots:
          employeeid: path.employeeid
      - text: Show the record for employee {employeeid}.
        slots:
          employeeid: path.employeeid
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v1/supervise/employee/{employeeid}/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Reactivate a terminated employee
      effect: write
      questions:
      - How do I bring back an employee who was terminated?
      - Can I reactivate a terminated employee by id?
      instructions:
      - text: Reactivate terminated employee {employeeid}.
        slots:
          employeeid: path.employeeid
      - text: Re-activate employee {employeeid} so they can be rehired.
        slots:
          employeeid: path.employeeid
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v1/supervise/employee/{employeeid}/assoc/{locationid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a location to an employee
      effect: write
      questions:
      - How do I assign a location to an employee?
      - Can I set an employee's primary location when adding a location?
      instructions:
      - text: Add location {locationid} to employee {employeeid}.
        slots:
          locationid: path.locationid
          employeeid: path.employeeid
      - text: Assign employee {employeeid} to location {locationid} and set it as their primary location.
        slots:
          employeeid: path.employeeid
          locationid: path.locationid
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v1/supervise/employee/{employeeid}/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an employee's account
      effect: destructive
      questions:
      - How do I permanently delete an employee's account?
      - Can I remove an employee from Deputy entirely?
      instructions:
      - text: Delete employee {employeeid}'s account.
        slots:
          employeeid: path.employeeid
      - text: Permanently remove employee {employeeid} from the company.
        slots:
          employeeid: path.employeeid
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v1/supervise/employee/{employeeid}/invite'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite an employee to join
      effect: write
      questions:
      - How do I invite an employee to join Deputy?
      - Can I send an invite to a new employee by id?
      instructions:
      - text: Invite employee {employeeid} to join Deputy.
        slots:
          employeeid: path.employeeid
      - text: Send an onboarding invite to employee {employeeid}.
        slots:
          employeeid: path.employeeid
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v1/supervise/employee/{employeeid}/setAwardFromLibrary'].post
  update:
    x-apievangelist-phrasing:
      intent: Set an award for an employee
      effect: write
      questions:
      - How do I award an employee a prize from the awards library?
      - Can I set an award for an employee by country code and award code?
      instructions:
      - text: Set award {strAwardCode} for employee {employeeid} in {strCountryCode}.
        slots:
          strAwardCode: requestBody.strAwardCode
          employeeid: path.employeeid
          strCountryCode: requestBody.strCountryCode
      - text: Award employee {employeeid} the {strAwardCode} prize in {strCountryCode}.
        slots:
          employeeid: path.employeeid
          strAwardCode: requestBody.strAwardCode
          strCountryCode: requestBody.strCountryCode
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v1/supervise/employee/{employeeid}/terminate'].post
  update:
    x-apievangelist-phrasing:
      intent: Terminate an employee
      effect: destructive
      questions:
      - How do I terminate an employee?
      - Can I end an employee's contract by id?
      instructions:
      - text: Terminate employee {employeeid}.
        slots:
          employeeid: path.employeeid
      - text: End the employment of employee {employeeid}.
        slots:
          employeeid: path.employeeid
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v1/supervise/employee/{employeeid}/unassoc/{locationid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a location from an employee
      effect: destructive
      questions:
      - How do I take a location away from an employee?
      - Can I unassign a location from an employee by id?
      instructions:
      - text: Remove location {locationid} from employee {employeeid}.
        slots:
          locationid: path.locationid
          employeeid: path.employeeid
      - text: Unassign employee {employeeid} from location {locationid}.
        slots:
          employeeid: path.employeeid
          locationid: path.locationid
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v1/supervise/employee/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an employee's phone number
      effect: write
      questions:
      - How do I update an employee's phone number?
      - Can I change an existing employee's contact number?
      instructions:
      - text: Update employee {id} to phone {Phone}.
        slots:
          id: path.id
          Phone: requestBody.Phone
      - text: Set the phone number of employee {id} to {Phone}.
        slots:
          id: path.id
          Phone: requestBody.Phone
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/employees'].get
  update:
    x-apievangelist-phrasing:
      intent: List employees (v2)
      effect: read
      questions:
      - How do I list employees using the v2 management API?
      - Can I filter the v2 employee list by archived status?
      instructions:
      - text: List employees using the v2 API.
      - text: Show v2 employees matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/employees'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an employee setup (v2)
      effect: write
      questions:
      - How do I create an employee setup through the v2 API?
      - Can I force activate an employee when creating them with v2?
      instructions:
      - text: Create an employee setup with v2 data {data}.
        slots:
          data: requestBody.data
      - text: 'Create employee setup {data} and activate it: {forceActivate}.'
        slots:
          data: requestBody.data
          forceActivate: requestBody.forceActivate
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/employees/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee (v2)
      effect: read
      questions:
      - How do I fetch one employee by id with the v2 API?
      - Can I read a single employee's record using v2?
      instructions:
      - text: Get employee {id} via the v2 API.
        slots:
          id: path.id
      - text: Show v2 employee {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/employees/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch an employee setup (v2)
      effect: write
      questions:
      - How do I partially update an employee setup with the v2 API?
      - Can I patch an employee's fields using v2?
      instructions:
      - text: Patch v2 employee {id} with {data}.
        slots:
          id: path.id
          data: requestBody.data
      - text: Update v2 employee {id} using patch mask {patchMask}.
        slots:
          id: path.id
          patchMask: requestBody.patchMask
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/employees:bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Create many employee setups (v2)
      effect: write
      questions:
      - How do I create several employee setups at once with v2?
      - Can I bulk add employees through the v2 API?
      instructions:
      - text: 'Create these employee setups in bulk with v2: {data}.'
        slots:
          data: requestBody.data
      - text: Bulk add employees {data} using the v2 API.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/employees:bulk'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch many employee setups (v2)
      effect: write
      questions:
      - How do I update several employee setups at once with v2?
      - Can I bulk patch employee fields using v2?
      instructions:
      - text: 'Patch these employee setups in bulk with v2: {data}.'
        slots:
          data: requestBody.data
      - text: Bulk update employee setups {data} using the v2 API.
        slots:
          data: requestBody.data
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/employees:validate-emails'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate email addresses against employees
      effect: read
      questions:
      - How do I check whether a list of email addresses belong to employees?
      - Can I validate emails against the v2 employee list?
      instructions:
      - text: 'Validate these email addresses against the v2 employee list: {emails}.'
        slots:
          emails: requestBody.emails
      - text: Check which of {emails} are employee email addresses.
        slots:
          emails: requestBody.emails
      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-employees-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.