Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy V2 Shift Offers API

4 actions 4 updates phrasing extends openapi/deputy-shift-offers-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 4

$.info
$.paths['/management/v2/shifts/offers:cancel'].post
$.paths['/management/v2/shifts/offers:notify'].post
$.paths['/me/v2/shifts/{shiftId}/offer/incoming'].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 Shift Offers API
  version: 1.0.0
extends: openapi/deputy-shift-offers-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: 3
- target: $.paths['/management/v2/shifts/offers:cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a shift offer
      effect: destructive
      questions:
      - How do I cancel a shift offer that hasn't been accepted yet?
      - Can I cancel a shift offer for several employees at once?
      instructions:
      - text: Cancel the shift offer for shift {shiftId}.
        slots:
          shiftId: requestBody.shiftIds
      - text: Cancel shift offers for employees {employeeIds}.
        slots:
          employeeIds: requestBody.employeeIds
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/shifts/offers:notify'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a shift offer to staff
      effect: write
      questions:
      - How do I send a shift offer to a staff member?
      - Can I notify staff about a shift offer at a specific location?
      instructions:
      - text: Notify staff about shift {shiftId}.
        slots:
          shiftId: requestBody.shiftIds
      - text: Send a shift offer to {employeeIds} at location {locationIds}.
        slots:
          employeeIds: requestBody.employeeIds
          locationIds: requestBody.locationIds
      method: generated
      generated: '2026-11-17'
- target: $.paths['/me/v2/shifts/{shiftId}/offer/incoming'].get
  update:
    x-apievangelist-phrasing:
      intent: View an incoming shift offer
      effect: read
      questions:
      - What does the incoming shift offer look like for a shift I've been offered?
      - Can I see the details of a shift offer I've received?
      instructions:
      - text: Show my incoming shift offer for shift {shiftId}.
        slots:
          shiftId: path.shiftId
      - text: Get the offer details on shift {shiftId}.
        slots:
          shiftId: path.shiftId
      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-shift-offers-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.