Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy Company API

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

$.info
$.paths['/resource/Company'].get
$.paths['/resource/Company/INFO'].get
$.paths['/resource/Company/PREDICT'].post
$.paths['/resource/Company/QUERY'].post
$.paths['/resource/Company/{id}'].get
$.paths['/resource/Company/{id}/COMMENTS'].get
$.paths['/resource/Company/{id}/COMMENTS'].post
$.paths['/resource/Company/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/Company/{id}/HISTORY'].get
$.paths['/resource/Company/{id}/HISTORY/travel/{timestamp}'].get
$.paths['/supervise/company'].put
$.paths['/supervise/company/all/settings'].post
$.paths['/supervise/company/bulk/settings'].post
$.paths['/supervise/company/bulk/settings/check/{jobId}'].get
$.paths['/supervise/company/simple'].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 Company API
  version: 1.0.0
extends: openapi/deputy-company-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: 23
- target: $.paths['/resource/Company'].get
  update:
    x-apievangelist-phrasing:
      intent: List companies
      effect: read
      questions:
      - Which companies exist in our Deputy account?
      - Can I page through all company records?
      instructions:
      - text: List all companies.
      - text: Show every company record I have access to.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Company/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get company field metadata
      effect: read
      questions:
      - What fields and types does the company record have?
      - Which company fields can I query on?
      instructions:
      - text: Show the field metadata for the company record.
      - text: List the company fields, their types and associations.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Company/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find an existing company by name
      effect: read
      questions:
      - How do I find the existing company record for a new company name?
      - Can I match a company by name and payroll settings before creating it?
      instructions:
      - text: Predict the company record matching name {CompanyName} with payroll entity {IsPayrollEntity} and active {Active}.
        slots:
          CompanyName: requestBody.CompanyName
          IsPayrollEntity: requestBody.IsPayrollEntity
          Active: requestBody.Active
      - text: Find the existing company for {CompanyName} with code {Code}.
        slots:
          CompanyName: requestBody.CompanyName
          Code: requestBody.Code
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Company/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search companies
      effect: read
      questions:
      - Can I search companies by name or code?
      - How do I sort and page company search results?
      instructions:
      - text: Search companies matching {search}.
        slots:
          search: requestBody.search
      - text: Find companies sorted by {sort}, {max} at a time.
        slots:
          sort: requestBody.sort
          max: requestBody.max
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Company/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company
      effect: read
      questions:
      - What details are stored for one company?
      - Can I look up a company by its id?
      instructions:
      - text: Get company {id}.
        slots:
          id: path.id
      - text: Show the record for company {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Company/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a company
      effect: read
      questions:
      - What comments have been left on a company?
      - Can I see the comment history for a company?
      instructions:
      - text: List comments on company {id}.
        slots:
          id: path.id
      - text: Show the comment history for company {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Company/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a company
      effect: write
      questions:
      - How do I leave a comment on a company?
      - Can I annotate a company record with a note?
      instructions:
      - text: Add comment {Comment} to company {id}.
        slots:
          Comment: requestBody.Comment
          id: path.id
      - text: Comment {Comment} on company {id}.
        slots:
          Comment: requestBody.Comment
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Company/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment on a company
      effect: destructive
      questions:
      - How do I remove a comment from a company?
      - Can I delete a comment on a company record?
      instructions:
      - text: Delete comment {commentId} from company {id}.
        slots:
          commentId: path.commentId
          id: path.id
      - text: Remove comment {commentId} on company {id}.
        slots:
          commentId: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Company/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's change history
      effect: read
      questions:
      - What changes have been made to a company over time?
      - Can I see the edit history of a company?
      instructions:
      - text: Show the change history of company {id}.
        slots:
          id: path.id
      - text: List all edits made to company {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Company/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a company as it was at a past time
      effect: read
      questions:
      - How do I see a company's record as it existed at a past moment?
      - Can I travel back to a company's state at a given timestamp?
      instructions:
      - text: Show company {id} as it was at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Travel back to company {id} at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/company'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a company
      effect: write
      questions:
      - How do I create a new company record?
      - Can I add a company through the supervise endpoint?
      instructions:
      - text: Create a company.
      - text: Add a new company record.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/company/all/settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Set all company settings
      effect: write
      questions:
      - How do I set every company setting at once?
      - Can I bulk-update all company settings?
      instructions:
      - text: Set all company settings.
      - text: Apply every company setting in one call.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/company/bulk/settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk update company settings
      effect: write
      questions:
      - Can I update company settings for many companies in one request?
      - How do I bulk-set company settings?
      instructions:
      - text: Bulk update company settings.
      - text: Apply company settings to multiple companies at once.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/company/bulk/settings/check/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a bulk company settings job
      effect: read
      questions:
      - Has my bulk company settings job finished?
      - How do I check the status of a bulk company settings job?
      instructions:
      - text: Check bulk company settings job {jobId}.
        slots:
          jobId: path.jobId
      - text: Show the status of company settings job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/company/simple'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a simple company record
      effect: read
      questions:
      - Can I get a lightweight company record without full details?
      - What does the simple company endpoint return?
      instructions:
      - text: Get the simple company record.
      - text: Fetch a minimal company record.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/company/timezone'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the company timezone
      effect: read
      questions:
      - What timezone is set on the company?
      - Can I read the company's timezone?
      instructions:
      - text: Get the company timezone.
      - text: Show the timezone configured for the company.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/company/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a company
      effect: write
      questions:
      - How do I update an existing company record?
      - Can I edit a company through the supervise endpoint?
      instructions:
      - text: Update company {id}.
        slots:
          id: path.id
      - text: Edit the existing company {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/company/{id}/archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive a company
      effect: destructive
      questions:
      - How do I archive a company?
      - Can I archive a company without deleting it?
      instructions:
      - text: Archive company {id}.
        slots:
          id: path.id
      - text: Archive company {id} so it is no longer active.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/company/{id}/cascade/settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Cascade settings to a company
      effect: write
      questions:
      - How do I cascade settings down to a company?
      - Can I push settings to a company and its children?
      instructions:
      - text: Cascade settings to company {id}.
        slots:
          id: path.id
      - text: Push settings down to company {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/company/{id}/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a company
      effect: destructive
      questions:
      - How do I delete a company?
      - Can I permanently remove a company record?
      instructions:
      - text: Delete company {id}.
        slots:
          id: path.id
      - text: Permanently remove company {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/company/{id}/googlePlaceId/{googlePlaceId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a company to a Google Place ID
      effect: write
      questions:
      - How do I attach a Google Place ID to a company for location supervision?
      - Can I link a company's location to a place in Google Maps?
      instructions:
      - text: Link company {id} to Google Place {googlePlaceId}.
        slots:
          id: path.id
          googlePlaceId: path.googlePlaceId
      - text: Attach Google Place ID {googlePlaceId} to company {id}.
        slots:
          id: path.id
          googlePlaceId: path.googlePlaceId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/company/{id}/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company's supervision settings
      effect: read
      questions:
      - What supervision settings are configured for a company?
      - Can I read a company's supervision settings?
      instructions:
      - text: Show the supervision settings for company {id}.
        slots:
          id: path.id
      - text: Get company {id}'s supervision settings.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/company/{id}/settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a company's supervision settings
      effect: write
      questions:
      - How do I change the supervision settings of a company?
      - Can I update a company's supervision settings?
      instructions:
      - text: Update the supervision settings of company {id}.
        slots:
          id: path.id
      - text: Save new supervision settings for company {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-company-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.