Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V2 Employment Contracts API

6 actions 6 updates phrasing extends openapi/deputy-employment-contracts-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 6

$.info
$.paths['/management/v2/employment-contracts'].get
$.paths['/management/v2/employment-contracts'].post
$.paths['/management/v2/employment-contracts/{id}'].get
$.paths['/management/v2/employment-contracts/{id}'].put
$.paths['/management/v2/employment-contracts/{id}'].delete

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 Employment Contracts API
  version: 1.0.0
extends: openapi/deputy-employment-contracts-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: 5
- target: $.paths['/management/v2/employment-contracts'].get
  update:
    x-apievangelist-phrasing:
      intent: List employment contracts
      effect: read
      questions:
      - What employment contracts are set up in my Deputy account?
      - Can I see all employee contracts at once?
      instructions:
      - text: List all employment contracts.
      - text: Show every employee contract on file.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/employment-contracts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an employment contract
      effect: write
      questions:
      - How do I add a new contract for an employee?
      - Can I set a contract's pay cycle type and base pay rule when creating it?
      instructions:
      - text: Create an employment contract named {name}.
        slots:
          name: requestBody.name
      - text: Create a {type} contract with code {code} starting {startAt}.
        slots:
          type: requestBody.type
          code: requestBody.code
          startAt: requestBody.startAt
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/employment-contracts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employment contract
      effect: read
      questions:
      - How do I view one employee contract by its ID?
      - What pay basis and condition does a specific contract have?
      instructions:
      - text: Get employment contract {id}.
        slots:
          id: path.id
      - text: Show the details of contract {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/employment-contracts/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an employment contract
      effect: write
      questions:
      - Can I change an existing contract's end date?
      - How do I switch the base pay rule on a contract?
      instructions:
      - text: Update employment contract {id} to end at {endAt}.
        slots:
          id: path.id
          endAt: requestBody.endAt
      - text: Change the base pay rule on contract {id} to {basePayRuleId}.
        slots:
          id: path.id
          basePayRuleId: requestBody.basePayRuleId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/employment-contracts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an employment contract
      effect: destructive
      questions:
      - How do I remove an obsolete contract?
      - Can I delete a contract that was set up by mistake?
      instructions:
      - text: Delete employment contract {id}.
        slots:
          id: path.id
      - text: Remove the obsolete contract {id}.
        slots:
          id: path.id
      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-employment-contracts-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.