Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy Employee API

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

$.info
$.paths['/resource/Employee'].get
$.paths['/resource/Employee'].put
$.paths['/resource/Employee'].post
$.paths['/resource/Employee/BULK'].post
$.paths['/resource/Employee/INFO'].get
$.paths['/resource/Employee/PREDICT'].post
$.paths['/resource/Employee/QUERY'].post
$.paths['/resource/Employee/{id}'].get
$.paths['/resource/Employee/{id}'].put
$.paths['/resource/Employee/{id}'].post
$.paths['/resource/Employee/{id}'].delete
$.paths['/resource/Employee/{id}/COMMENTS'].get
$.paths['/resource/Employee/{id}/COMMENTS'].post
$.paths['/resource/Employee/{id}/COMMENTS/{commentId}'].delete
$.paths['/resource/Employee/{id}/HISTORY'].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 Employee API
  version: 1.0.0
extends: openapi/deputy-employee-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: 65
- target: $.paths['/resource/Employee'].get
  update:
    x-apievangelist-phrasing:
      intent: List employees
      effect: read
      questions:
      - Who are the employees in my company?
      - Can I see every employee record I have access to?
      instructions:
      - text: List all employees.
      - text: Show every employee record.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Employee'].put
  update:
    x-apievangelist-phrasing:
      intent: Create an employee record
      effect: write
      questions:
      - How do I add a new employee to Deputy?
      - Can I create an employee record with a full profile?
      instructions:
      - text: Create an employee with first name {FirstName}, last name {LastName}, role {Role}, active {Active}, contact {Contact}, company {Company}, display name {DisplayName}, modified {Modified}.
        slots:
          FirstName: requestBody.FirstName
          LastName: requestBody.LastName
          Role: requestBody.Role
          Active: requestBody.Active
          Contact: requestBody.Contact
          Company: requestBody.Company
          DisplayName: requestBody.DisplayName
          Modified: requestBody.Modified
      - text: Add a new employee record.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Employee'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new employee to the system
      effect: write
      questions:
      - How do I add a new staff member with their contact and role details?
      - Can I record an employee's date of birth and gender when I create them?
      instructions:
      - text: Create a new employee with first name {first_name}, last name {last_name}, role {role}, and active set to {active}.
        slots:
          first_name: requestBody.FirstName
          last_name: requestBody.LastName
          role: requestBody.Role
          active: requestBody.Active
      - text: Add a new staff member named {display_name} with contact {contact} and company {company}.
        slots:
          display_name: requestBody.DisplayName
          contact: requestBody.Contact
          company: requestBody.Company
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Employee/BULK'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update many employees at once
      effect: write
      questions:
      - How do I import a batch of employees?
      - Can I create or update several employees in one request?
      instructions:
      - text: Bulk create or update employees.
      - text: Import a batch of employee records.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Employee/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get employee field metadata
      effect: read
      questions:
      - Which fields can I search on for employees?
      - What field types and associations does the employee resource have?
      instructions:
      - text: Show the employee field metadata.
      - text: Get the employee resource field list and types.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Employee/PREDICT'].post
  update:
    x-apievangelist-phrasing:
      intent: Find an existing employee by partial details
      effect: read
      questions:
      - How do I find an existing employee before creating one?
      - Can I match a new hire to a record I already have?
      instructions:
      - text: Predict the employee record matching first name {FirstName}, last name {LastName}, role {Role}, active {Active}, contact {Contact}, company {Company}, display name {DisplayName}, modified
          {Modified}.
        slots:
          FirstName: requestBody.FirstName
          LastName: requestBody.LastName
          Role: requestBody.Role
          Active: requestBody.Active
          Contact: requestBody.Contact
          Company: requestBody.Company
          DisplayName: requestBody.DisplayName
          Modified: requestBody.Modified
      - text: Find an existing employee for these details.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Employee/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search employees
      effect: read
      questions:
      - How do I find employees by name or role?
      - Can I sort and page through employee records?
      instructions:
      - text: Search employees matching {search}.
        slots:
          search: requestBody.search
      - text: Find employees sorted by {sort}, {max} at a time.
        slots:
          sort: requestBody.sort
          max: requestBody.max
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Employee/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee
      effect: read
      questions:
      - How do I look up one employee by id?
      - What details are stored for a single employee?
      instructions:
      - text: Get employee {id}.
        slots:
          id: path.id
      - text: Show the profile of employee {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Employee/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an employee record
      effect: write
      questions:
      - How do I fully replace an employee record?
      - Can I overwrite an employee's whole profile?
      instructions:
      - text: Replace employee {id} with first name {FirstName}, last name {LastName}, role {Role}, active {Active}, contact {Contact}, company {Company}, display name {DisplayName}, modified {Modified}.
        slots:
          id: path.id
          FirstName: requestBody.FirstName
          LastName: requestBody.LastName
          Role: requestBody.Role
          Active: requestBody.Active
          Contact: requestBody.Contact
          Company: requestBody.Company
          DisplayName: requestBody.DisplayName
          Modified: requestBody.Modified
      - text: Overwrite the full employee record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Employee/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an employee
      effect: write
      questions:
      - How do I change an employee's role or contact details?
      - Can I edit an existing employee record?
      instructions:
      - text: Update employee {id} with first name {FirstName}, last name {LastName}, role {Role}, active {Active}, contact {Contact}, company {Company}, display name {DisplayName}, modified {Modified}.
        slots:
          id: path.id
          FirstName: requestBody.FirstName
          LastName: requestBody.LastName
          Role: requestBody.Role
          Active: requestBody.Active
          Contact: requestBody.Contact
          Company: requestBody.Company
          DisplayName: requestBody.DisplayName
          Modified: requestBody.Modified
      - text: Edit the existing employee record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Employee/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an employee
      effect: destructive
      questions:
      - How do I remove an employee from the system?
      - Can I delete an employee record?
      instructions:
      - text: Delete employee {id}.
        slots:
          id: path.id
      - text: Remove the employee record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Employee/{id}/COMMENTS'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on an employee
      effect: read
      questions:
      - What comments have been left on an employee?
      - Can I see the notes on a specific employee?
      instructions:
      - text: List comments on employee {id}.
        slots:
          id: path.id
      - text: Show the notes on employee {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Employee/{id}/COMMENTS'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a comment to an employee
      effect: write
      questions:
      - How do I add a note to an employee?
      - Can I leave a comment on an employee record?
      instructions:
      - text: Add comment {Comment} to employee {id}.
        slots:
          Comment: requestBody.Comment
          id: path.id
      - text: Leave a note on employee {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Employee/{id}/COMMENTS/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an employee comment
      effect: destructive
      questions:
      - How do I remove a comment from an employee?
      - Can I delete a note on an employee record?
      instructions:
      - text: Delete comment {commentId} from employee {id}.
        slots:
          commentId: path.commentId
          id: path.id
      - text: Remove the note {commentId} on employee {id}.
        slots:
          commentId: path.commentId
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Employee/{id}/HISTORY'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee's change history
      effect: read
      questions:
      - What changes have been made to an employee over time?
      - Can I see the edit history of an employee?
      instructions:
      - text: Show the change history of employee {id}.
        slots:
          id: path.id
      - text: List the edits made to employee {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-17'
- target: $.paths['/resource/Employee/{id}/HISTORY/travel/{timestamp}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee as it was at a past time
      effect: read
      questions:
      - How did an employee's record look at a point in the past?
      - Can I travel back to an employee's record before a change?
      instructions:
      - text: Get employee {id} as it was at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      - text: Show employee {id} frozen at {timestamp}.
        slots:
          id: path.id
          timestamp: path.timestamp
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee'].put
  update:
    x-apievangelist-phrasing:
      intent: Create an employee via the supervise endpoint
      effect: write
      questions:
      - How do I create an employee through the supervise API?
      - Can I add an employee using the supervise endpoint?
      instructions:
      - text: Create an employee through the supervise endpoint.
      - text: Add an employee using supervise.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update an employee via supervise
      effect: write
      questions:
      - How do I create or update an employee through the supervise API?
      - Can I upsert an employee using supervise?
      instructions:
      - text: Create or update an employee through the supervise endpoint.
      - text: Upsert an employee using supervise.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Query employees via the supervise API
      effect: read
      questions:
      - How do I search employees through the supervise API?
      - Can I query employees using supervise?
      instructions:
      - text: Query employees through the supervise endpoint.
      - text: Search employees using supervise.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/amendABP'].post
  update:
    x-apievangelist-phrasing:
      intent: Amend an employee's ABP via supervise
      effect: write
      questions:
      - How do I amend an employee's ABP through the supervise API?
      - Can I update an employee's ABP using supervise?
      instructions:
      - text: Amend an employee's ABP through the supervise endpoint.
      - text: Update an employee's ABP using supervise.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/checkLicense'].post
  update:
    x-apievangelist-phrasing:
      intent: Check an employee's license
      effect: read
      questions:
      - How do I verify an employee's license before they start?
      - Can I check a license without creating an employee record?
      instructions:
      - text: Check the license for this employee.
      - text: Verify the employee's license details.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/contractedhours/template'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the contracted hours template
      effect: read
      questions:
      - What contracted hours template is used for new employees?
      - Can I see the default contracted hours template?
      instructions:
      - text: Get the contracted hours template.
      - text: Show the default hours template.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/contractedhours/template'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the contracted hours template
      effect: write
      questions:
      - How do I change the default contracted hours template?
      - Can I overwrite the hours template for new employees?
      instructions:
      - text: Update the contracted hours template.
      - text: Replace the default hours template with a new one.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/contractedhours/template'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contracted hours template
      effect: write
      questions:
      - How do I add a new contracted hours template?
      - Can I create a template for a specific roster type?
      instructions:
      - text: Create a contracted hours template.
      - text: Add a new hours template for employees.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/contractedhours/template/{templateId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contracted hours template
      effect: write
      questions:
      - How do I create a contracted hours template with a specific ID?
      - Can I add a template to a roster type by its template ID?
      instructions:
      - text: Create a contracted hours template with ID {templateId}.
        slots:
          templateId: path.templateId
      - text: Add a new hours template {templateId} for roster type.
        slots:
          templateId: path.templateId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/contractedhours/template/{templateId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a contracted hours template
      effect: destructive
      questions:
      - How do I remove a contracted hours template?
      - Can I delete an hours template by its template ID?
      instructions:
      - text: Delete contracted hours template {templateId}.
        slots:
          templateId: path.templateId
      - text: Remove the hours template {templateId}.
        slots:
          templateId: path.templateId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/create'].put
  update:
    x-apievangelist-phrasing:
      intent: Create an employee record
      effect: write
      questions:
      - How do I create a new employee record?
      - Can I create an employee through the supervise endpoint?
      instructions:
      - text: Create an employee record.
      - text: Add a new employee to the supervise system.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a new employee invitation through the supervisor view
      effect: write
      questions:
      - How do I invite a new employee to join the company?
      - Can I send an employee invitation from the supervisor experience?
      instructions:
      - text: Send an employee invitation through the supervisor create endpoint.
      - text: Invite a new staff member using the supervisory employee invitation form.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/demo'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a demo employee record
      effect: read
      questions:
      - Can I fetch a demo employee record for testing?
      - What does a demo employee record look like?
      instructions:
      - text: Get a demo employee record.
      - text: Show me a test employee record.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/invitation'].get
  update:
    x-apievangelist-phrasing:
      intent: View an employee invitation
      effect: read
      questions:
      - What status does the invited employee's invitation have?
      - How do I check an employee invitation in the supervisor view?
      instructions:
      - text: Show the employee invitation.
      - text: Get the current invitation status for an employee.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/invitation'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a new employee invitation request
      effect: write
      questions:
      - How do I submit an invitation request for a new hire using the invitation form endpoint?
      - Is there a POST endpoint dedicated to employee invitations rather than employee creation?
      instructions:
      - text: Submit a POST to the supervise employee invitation endpoint to invite a new hire.
      - text: Post a new employee invitation request through the invitation endpoint, not the create endpoint.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/invitation'].delete
  update:
    x-apievangelist-phrasing:
      intent: Withdraw an employee invitation
      effect: destructive
      questions:
      - Can I withdraw an invitation sent to a new employee?
      - How do I cancel an employee invitation through the supervisor view?
      instructions:
      - text: Withdraw the employee invitation.
      - text: Cancel the pending invite sent to a new staff member.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/invitation/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate an employee invitation
      effect: write
      questions:
      - How do I confirm an employee's invitation details?
      - Can I validate an employee invitation before it's processed?
      instructions:
      - text: Validate the employee invitation.
      - text: Confirm the pending invite details for a new employee.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/real'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the real employee ID
      effect: read
      questions:
      - What is the real employee ID for a staff member?
      - How do I retrieve the actual employee ID from the supervisor endpoint?
      instructions:
      - text: Get the real employee ID.
      - text: Look up the actual staff member ID via the supervise endpoint.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/real/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count real employees
      effect: read
      questions:
      - How many real employees are in the system?
      - Can I get a headcount of live employees?
      instructions:
      - text: Count the real employees.
      - text: Give me the number of live employee records.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/reset/gender'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset an employee's gender
      effect: destructive
      questions:
      - How do I reset an employee's gender field?
      - Can I clear the gender stored for an employee?
      instructions:
      - text: Reset the gender for this employee.
      - text: Clear the employee's gender field.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/role/manage'].get
  update:
    x-apievangelist-phrasing:
      intent: Manage employee roles
      effect: read
      questions:
      - How do I manage roles for employees?
      - Can I list the roles available for employees?
      instructions:
      - text: Manage employee roles.
      - text: Show the employee role management screen.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/validate'].put
  update:
    x-apievangelist-phrasing:
      intent: Validate an employee record
      effect: write
      questions:
      - How do I validate an employee record?
      - Can I confirm an employee record is valid?
      instructions:
      - text: Validate the employee record.
      - text: Confirm this employee record is valid.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate an employee record
      effect: write
      questions:
      - How do I validate an employee record with a POST request?
      - Can I confirm an employee record is valid through the validate endpoint?
      instructions:
      - text: Validate the employee record with a POST request.
      - text: Confirm this employee record is valid using the validate endpoint.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/{employeeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee's details
      effect: read
      questions:
      - How do I look up a staff member's details by ID?
      - What information is available about an employee?
      instructions:
      - text: Show employee {employee_id}'s details.
        slots:
          employee_id: path.employeeId
      - text: Get the profile of staff member {employee_id}.
        slots:
          employee_id: path.employeeId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/{employeeId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Supervise an employee
      effect: write
      questions:
      - How do I supervise an employee through the supervisor API?
      - Can I supervise an employee by their ID?
      instructions:
      - text: Supervise employee {employeeId}.
        slots:
          employeeId: path.employeeId
      - text: Start supervising {employeeId} as a supervisor.
        slots:
          employeeId: path.employeeId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/{employeeId}/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate an employee
      effect: write
      questions:
      - How do I activate an employee so they can start work?
      - Can I turn on an employee's account through the supervisor API?
      instructions:
      - text: Activate employee {employeeId}.
        slots:
          employeeId: path.employeeId
      - text: Turn on {employeeId} so they can start work.
        slots:
          employeeId: path.employeeId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/{employeeId}/assoc/{wpId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Associate an employee with a work pattern
      effect: write
      questions:
      - How do I link an employee to a work pattern?
      - Can I associate an employee with a work pattern by ID?
      instructions:
      - text: Associate employee {employeeId} with work pattern {wpId}.
        slots:
          employeeId: path.employeeId
          wpId: path.wpId
      - text: Link {employeeId} to work pattern {wpId}.
        slots:
          employeeId: path.employeeId
          wpId: path.wpId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/{employeeId}/contractedhours'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee's contracted hours
      effect: read
      questions:
      - How many hours is an employee contracted to work?
      - What contracted hours are on file for an employee?
      instructions:
      - text: Get the contracted hours for employee {employeeId}.
        slots:
          employeeId: path.employeeId
      - text: Show {employeeId}'s contracted hours.
        slots:
          employeeId: path.employeeId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/{employeeId}/contractedhours'].put
  update:
    x-apievangelist-phrasing:
      intent: Set an employee's contracted hours
      effect: write
      questions:
      - How do I set an employee's contracted hours?
      - Can I update an employee's contracted hours to a new number?
      instructions:
      - text: Set the contracted hours for employee {employeeId}.
        slots:
          employeeId: path.employeeId
      - text: Update {employeeId}'s contracted hours.
        slots:
          employeeId: path.employeeId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/{employeeId}/contractedhours'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an employee's contracted hours record
      effect: write
      questions:
      - How do I create a contracted hours record for an employee?
      - Can I add contracted hours for an employee that has none yet?
      instructions:
      - text: Create a contracted hours record for employee {employeeId}.
        slots:
          employeeId: path.employeeId
      - text: Add contracted hours for {employeeId}.
        slots:
          employeeId: path.employeeId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/{employeeId}/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Terminate an employee via the supervisor view
      effect: destructive
      questions:
      - How do I terminate an employee using the supervisor experience?
      - Can I end an employee's record through supervise?
      instructions:
      - text: Terminate employee {employee_id} through the supervise endpoint.
        slots:
          employee_id: path.employeeId
      - text: End the employment record for staff member {employee_id} using supervise.
        slots:
          employee_id: path.employeeId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/{employeeId}/hr/onboarding'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee's HR onboarding status
      effect: read
      questions:
      - Has an employee completed their HR onboarding?
      - What is the HR onboarding status for an employee?
      instructions:
      - text: Get the HR onboarding status for employee {employeeId}.
        slots:
          employeeId: path.employeeId
      - text: Show whether {employeeId} has finished HR onboarding.
        slots:
          employeeId: path.employeeId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/{employeeId}/hr/onboarding'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an employee's HR onboarding
      effect: write
      questions:
      - How do I start an employee's HR onboarding?
      - Can I kick off HR onboarding for an employee?
      instructions:
      - text: Start HR onboarding for employee {employeeId}.
        slots:
          employeeId: path.employeeId
      - text: Kick off onboarding for {employeeId}.
        slots:
          employeeId: path.employeeId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/{employeeId}/hr/payroll/connected'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if an employee's payroll is connected
      effect: read
      questions:
      - Is an employee's payroll connected to the system?
      - Has payroll been connected for an employee?
      instructions:
      - text: Check whether payroll is connected for employee {employeeId}.
        slots:
          employeeId: path.employeeId
      - text: Show the payroll connection status for {employeeId}.
        slots:
          employeeId: path.employeeId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/{employeeId}/hr/payroll/sync'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee's payroll sync status
      effect: read
      questions:
      - Has an employee's payroll been synced?
      - What is the payroll sync status for an employee?
      instructions:
      - text: Get the payroll sync status for employee {employeeId}.
        slots:
          employeeId: path.employeeId
      - text: Show whether {employeeId}'s payroll has synced.
        slots:
          employeeId: path.employeeId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/{employeeId}/hr/payroll/sync'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync an employee's payroll
      effect: write
      questions:
      - How do I sync an employee's payroll?
      - Can I force a payroll sync for an employee?
      instructions:
      - text: Sync payroll for employee {employeeId}.
        slots:
          employeeId: path.employeeId
      - text: Force a payroll sync for {employeeId}.
        slots:
          employeeId: path.employeeId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/{employeeId}/invite'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite an employee to the system
      effect: write
      questions:
      - How do I invite an employee to the system?
      - Can I send an employee an invitation to join?
      instructions:
      - text: Invite employee {employeeId} to the system.
        slots:
          employeeId: path.employeeId
      - text: Send an invitation to {employeeId}.
        slots:
          employeeId: path.employeeId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/{employeeId}/manage-login'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee's login management details
      effect: read
      questions:
      - How do I manage an employee's login details?
      - What login management options exist for an employee?
      instructions:
      - text: Get the login management details for employee {employeeId}.
        slots:
          employeeId: path.employeeId
      - text: Show how to manage {employeeId}'s login.
        slots:
          employeeId: path.employeeId
      method: generated
      generated: '2026-11-17'
- target: $.paths['/supervise/employee/{employeeId}/photo'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an employee's photo
      effect: write
      questions:
      - How do I upload a photo for an employee?
      - Can I set an employee's profile photo?
      instructions:
      - text: Upload a photo for employee {employeeId}.
        slots:
          employeeId: path.employeeId
      - text: Set {employeeId}'s profile photo.
        slots:
          employeeId: path.employeeId
      method: generated
      generated: '2026-11-17'


# --- truncated at 32 KB (38 KB total) ---
# Full source: https://artifacts.apis.io/deputy/overlays/deputy-employee-api-phrasing-overlay.yaml

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-employee-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.