Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy Timesheets API

16 actions 16 updates phrasing extends openapi/deputy-timesheets-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 16

$.info
$.paths['/v1/supervise/timesheet/end'].post
$.paths['/v1/supervise/timesheet/pause'].post
$.paths['/v1/supervise/timesheet/start'].post
$.paths['/v1/supervise/timesheet/{timesheetid}/details'].get
$.paths['/management/v2/timesheets'].get
$.paths['/management/v2/timesheets'].post
$.paths['/management/v2/timesheets/{id}'].get
$.paths['/management/v2/timesheets/{id}'].put
$.paths['/management/v2/timesheets/{id}'].delete
$.paths['/management/v2/timesheets/{id}:auto-end'].post
$.paths['/management/v2/timesheets/{id}:end'].post
$.paths['/management/v2/timesheets:pause'].post
$.paths['/management/v2/timesheets:start'].post
$.paths['/timesheet-export/v2/summary-by-rate:get'].post
$.paths['/timesheet-export/v2/summary:get'].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 Timesheets API
  version: 1.0.0
extends: openapi/deputy-timesheets-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: 15
- target: $.paths['/v1/supervise/timesheet/end'].post
  update:
    x-apievangelist-phrasing:
      intent: Clock an employee off their timesheet
      effect: write
      questions:
      - How do I clock an employee off their timesheet and record their meal break?
      - Can I end a timesheet and set the meal break minutes?
      instructions:
      - text: Clock off timesheet {intTimesheetId} with a {intMealbreakMinute}-minute meal break.
        slots:
          intTimesheetId: requestBody.intTimesheetId
          intMealbreakMinute: requestBody.intMealbreakMinute
      - text: End employee {intTimesheetId} and record {intMealbreakMinute} minutes as the meal break.
        slots:
          intTimesheetId: requestBody.intTimesheetId
          intMealbreakMinute: requestBody.intMealbreakMinute
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v1/supervise/timesheet/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause or resume an employee's timesheet break
      effect: write
      questions:
      - Can I pause an employee's timesheet while they take a break?
      - How do I mark a break as finished on a timesheet?
      instructions:
      - text: Pause or resume the break on timesheet {intTimesheetId} with a {intMealbreakMinute}-minute meal break.
        slots:
          intTimesheetId: requestBody.intTimesheetId
          intMealbreakMinute: requestBody.intMealbreakMinute
      - text: Mark break {intTimesheetId} as finished with {intMealbreakMinute} minutes.
        slots:
          intTimesheetId: requestBody.intTimesheetId
          intMealbreakMinute: requestBody.intMealbreakMinute
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v1/supervise/timesheet/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Clock an employee on their timesheet
      effect: write
      questions:
      - How do I clock an employee in for a shift?
      - Can I start a timesheet for an employee at a specific location?
      instructions:
      - text: Clock employee {intEmployeeId} on at location {intOpunitId}.
        slots:
          intEmployeeId: requestBody.intEmployeeId
          intOpunitId: requestBody.intOpunitId
      - text: Start a new timesheet for {intEmployeeId} at {intOpunitId}.
        slots:
          intEmployeeId: requestBody.intEmployeeId
          intOpunitId: requestBody.intOpunitId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/v1/supervise/timesheet/{timesheetid}/details'].get
  update:
    x-apievangelist-phrasing:
      intent: View a timesheet by ID
      effect: read
      questions:
      - What hours and breaks are on a specific timesheet?
      - Can I look up one timesheet by its ID?
      instructions:
      - text: Show timesheet {timesheetid}.
        slots:
          timesheetid: path.timesheetid
      - text: Get the details of timesheet {timesheetid}.
        slots:
          timesheetid: path.timesheetid
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/timesheets'].get
  update:
    x-apievangelist-phrasing:
      intent: List timesheets
      effect: read
      questions:
      - Which timesheets have been clocked in for an employee?
      - Can I list only the timesheets that are still in progress?
      - Is it possible to list timesheets for several locations at once?
      instructions:
      - text: List timesheets for employee {employeeId}.
        slots:
          employeeId: query.employeeId
      - text: List timesheets for locations {locationIds} between {start} and {end}.
        slots:
          locationIds: query.locationIds
          start: query.start
          end: query.end
      - text: Show {limit} timesheets with in progress set to {inProgress}.
        slots:
          limit: query.limit
          inProgress: query.inProgress
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/timesheets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a timesheet
      effect: write
      questions:
      - How do I create a timesheet for an employee?
      - Can I set the start and end time and meal break when creating a timesheet?
      instructions:
      - text: Create a timesheet for employee {employeeId} starting {start} and ending {end}.
        slots:
          employeeId: requestBody.employeeId
          start: requestBody.start
          end: requestBody.end
      - text: Create a timesheet for employee {employeeId} with a {mealBreak} minute meal break.
        slots:
          employeeId: requestBody.employeeId
          mealBreak: requestBody.mealBreak
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/timesheets/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a timesheet
      effect: read
      questions:
      - What are the hours and comments on a specific timesheet?
      - Can I fetch one timesheet by its ID?
      instructions:
      - text: Get timesheet {id}.
        slots:
          id: path.id
      - text: Show the details of timesheet {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/timesheets/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an in-progress timesheet
      effect: write
      questions:
      - Can I edit a timesheet that is still in progress?
      - How do I change the start time on an ongoing timesheet?
      instructions:
      - text: Update in-progress timesheet {id} to start at {start}.
        slots:
          id: path.id
          start: requestBody.start
      - text: Change the meal break on timesheet {id} to {mealBreakMinute} minutes.
        slots:
          id: path.id
          mealBreakMinute: requestBody.mealBreakMinute
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/timesheets/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a timesheet
      effect: destructive
      questions:
      - Can I delete a timesheet I created by mistake?
      - Is deleting a timesheet permanent?
      instructions:
      - text: Delete timesheet {id}.
        slots:
          id: path.id
      - text: Remove the timesheet {id} from the records.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/timesheets/{id}:auto-end'].post
  update:
    x-apievangelist-phrasing:
      intent: Auto-end a timesheet from the roster
      effect: write
      questions:
      - Can I end a timesheet automatically using the roster?
      - What does auto-ending a timesheet calculate?
      instructions:
      - text: Auto-end timesheet {id} from the roster.
        slots:
          id: path.id
      - text: End timesheet {id} automatically, calculating children from roster.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/timesheets/{id}:end'].post
  update:
    x-apievangelist-phrasing:
      intent: End a timesheet
      effect: write
      questions:
      - How do I end a timesheet and record the end time and geo location?
      - Can I add a comment when ending a timesheet?
      instructions:
      - text: End timesheet {id} at {end}.
        slots:
          id: path.id
          end: requestBody.end
      - text: End timesheet {id} with comment {employeeComment}.
        slots:
          id: path.id
          employeeComment: requestBody.employeeComment
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/timesheets:pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause an employee's break
      effect: write
      questions:
      - Can I pause an employee's break?
      - How do I resume a break on a timesheet?
      instructions:
      - text: Pause break {breakId} for employee {employeeId}.
        slots:
          breakId: requestBody.breakId
          employeeId: requestBody.employeeId
      - text: Resume the break on employee {employeeId}'s timesheet.
        slots:
          employeeId: requestBody.employeeId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/management/v2/timesheets:start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a timesheet
      effect: write
      questions:
      - How do I start a timesheet for an employee?
      - Can I start a timesheet at a specific area?
      instructions:
      - text: Start a timesheet for employee {employeeId}.
        slots:
          employeeId: requestBody.employeeId
      - text: Start a timesheet for employee {employeeId} at area {areaId}.
        slots:
          employeeId: requestBody.employeeId
          areaId: requestBody.areaId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/timesheet-export/v2/summary-by-rate:get'].post
  update:
    x-apievangelist-phrasing:
      intent: Summarize timesheets by pay rate
      effect: read
      questions:
      - Can I get a summary of timesheets grouped by pay rate?
      - What does the rate-summary export return?
      instructions:
      - text: Get a timesheet summary grouped by rate.
      - text: Summarize timesheets by pay rate using filters {filters}.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-11-17'
- target: $.paths['/timesheet-export/v2/summary:get'].post
  update:
    x-apievangelist-phrasing:
      intent: Summarize timesheets
      effect: read
      questions:
      - Can I get a summary of timesheets matching certain filters?
      - What does the timesheet summary export return?
      instructions:
      - text: Get a timesheet summary using filters {filters}.
        slots:
          filters: requestBody.filters
      - text: Summarize timesheets for bulk selection {bulkSelection}.
        slots:
          bulkSelection: requestBody.bulkSelection
      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-timesheets-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.