Deputy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Deputy Resource Resource API

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

$.info
$.paths['/v1/resource/Employee/{employeeid}'].get
$.paths['/Address'].get
$.paths['/Address/INFO'].get
$.paths['/Address/QUERY'].post
$.paths['/Category'].get
$.paths['/Category/INFO'].get
$.paths['/Category/QUERY'].post
$.paths['/Comment'].get
$.paths['/Comment/INFO'].get
$.paths['/Comment/QUERY'].post
$.paths['/Company'].get
$.paths['/Company'].post
$.paths['/Company/INFO'].get
$.paths['/CompanyPeriod'].get
$.paths['/CompanyPeriod/INFO'].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 Resource Resource API
  version: 1.0.0
extends: openapi/deputy-resource-api-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: 61
- target: $.paths['/v1/resource/Employee/{employeeid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an employee by ID
      effect: read
      questions:
      - How do I look up one employee's details by their employee ID?
      - Can I fetch a single employee record from a location?
      instructions:
      - text: Get employee {employeeid}.
        slots:
          employeeid: path.employeeid
      - text: Show me the record for employee {employeeid}.
        slots:
          employeeid: path.employeeid
      method: generated
      generated: '2026-11-17'
- target: $.paths['/Address'].get
  update:
    x-apievangelist-phrasing:
      intent: List address records
      effect: read
      questions:
      - What address records exist in the company?
      - Can I list all address records?
      instructions:
      - text: List all address records.
      - text: Show every address record.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/Address/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get address object metadata
      effect: read
      questions:
      - What fields does the address object have?
      - Can I get the address object's metadata?
      instructions:
      - text: Get address object info.
      - text: Show the address object's metadata.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/Address/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search address records
      effect: read
      questions:
      - How do I find an address record matching a search?
      - Can I search address records by a query?
      instructions:
      - text: Search address records with {search}.
        slots:
          search: requestBody.search
      - text: Find an address record matching {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-11-17'
- target: $.paths['/Category'].get
  update:
    x-apievangelist-phrasing:
      intent: List category records
      effect: read
      questions:
      - What category records exist in the company?
      - Can I list all category records?
      instructions:
      - text: List all category records.
      - text: Show every category record.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/Category/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get category object metadata
      effect: read
      questions:
      - What fields does the category object have?
      - Can I get the category object's metadata?
      instructions:
      - text: Get category object info.
      - text: Show the category object's metadata.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/Category/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search category records
      effect: read
      questions:
      - How do I find a category record matching a search?
      - Can I search category records by a query?
      instructions:
      - text: Search category records with {search}.
        slots:
          search: requestBody.search
      - text: Find a category record matching {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-11-17'
- target: $.paths['/Comment'].get
  update:
    x-apievangelist-phrasing:
      intent: List comment records
      effect: read
      questions:
      - What comment records exist in the company?
      - Can I list all comment records?
      instructions:
      - text: List all comment records.
      - text: Show every comment record.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/Comment/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get comment object metadata
      effect: read
      questions:
      - What fields does the comment object have?
      - Can I get the comment object's metadata?
      instructions:
      - text: Get comment object info.
      - text: Show the comment object's metadata.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/Comment/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search comment records
      effect: read
      questions:
      - How do I find a comment record matching a search?
      - Can I search comment records by a query?
      instructions:
      - text: Search comment records with {search}.
        slots:
          search: requestBody.search
      - text: Find a comment record matching {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-11-17'
- target: $.paths['/Company'].get
  update:
    x-apievangelist-phrasing:
      intent: List company locations
      effect: read
      questions:
      - Which company locations exist?
      - Can I list all company locations?
      instructions:
      - text: List company locations.
      - text: Show every company location.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/Company'].post
  update:
    x-apievangelist-phrasing:
      intent: Search company locations
      effect: read
      questions:
      - How do I find a company location matching a search?
      - Can I search company locations by a query?
      instructions:
      - text: Search company locations with {search}.
        slots:
          search: requestBody.search
      - text: Find a company location matching {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-11-17'
- target: $.paths['/Company/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get company locations object metadata
      effect: read
      questions:
      - What fields does the company locations object have?
      - Can I get the company locations object's metadata?
      instructions:
      - text: Get company locations object info.
      - text: Show the company locations object's metadata.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/CompanyPeriod'].get
  update:
    x-apievangelist-phrasing:
      intent: List company periods
      effect: read
      questions:
      - Which company periods are set up?
      - Can I list all company periods?
      instructions:
      - text: List company periods.
      - text: Show every company period.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/CompanyPeriod/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get company periods object metadata
      effect: read
      questions:
      - What fields does the company periods object have?
      - Can I get the company periods object's metadata?
      instructions:
      - text: Get company periods object info.
      - text: Show the company periods object's metadata.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/CompanyPeriod/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search company periods
      effect: read
      questions:
      - How do I find a company period matching a search?
      - Can I search company periods by a query?
      instructions:
      - text: Search company periods with {search}.
        slots:
          search: requestBody.search
      - text: Find a company period matching {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-11-17'
- target: $.paths['/Contact/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get contact object metadata
      effect: read
      questions:
      - What fields does the contact object have?
      - Can I get the contact object's metadata?
      instructions:
      - text: Get contact object info.
      - text: Show the contact object's metadata.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/Contact/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search contact records
      effect: read
      questions:
      - How do I find a contact record matching a search?
      - Can I search contact records by a query?
      instructions:
      - text: Search contact records with {search}.
        slots:
          search: requestBody.search
      - text: Find a contact record matching {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-11-17'
- target: $.paths['/Country/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get country object metadata
      effect: read
      questions:
      - What fields does the country object have?
      - Can I get the country object's metadata?
      instructions:
      - text: Get country object info.
      - text: Show the country object's metadata.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/Country/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search country records
      effect: read
      questions:
      - How do I find a country record matching a search?
      - Can I search country records by a query?
      instructions:
      - text: Search country records with {search}.
        slots:
          search: requestBody.search
      - text: Find a country record matching {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-11-17'
- target: $.paths['/CustomAppData'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom app data entries
      effect: read
      questions:
      - Where can I see the custom app data entries I've stored?
      - Can I list all custom app data entries?
      instructions:
      - text: List my custom app data entries.
      - text: Show every custom app data entry.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/CustomAppData/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get custom app data object info
      effect: read
      questions:
      - What does the custom app data object schema look like?
      - Can I get the metadata for custom app data entries?
      instructions:
      - text: Get custom app data object info.
      - text: Show the custom app data object schema.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/CustomAppData/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search custom app data entries
      effect: read
      questions:
      - How do I search my custom app data entries?
      - Can I find a custom app data entry by a search term?
      instructions:
      - text: Search custom app data entries for {search}.
        slots:
          search: requestBody.search
      - text: Find the custom app data entry matching {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-11-17'
- target: $.paths['/CustomField'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom fields
      effect: read
      questions:
      - Which custom fields are defined in my account?
      - Can I get the list of custom fields?
      instructions:
      - text: List my custom fields.
      - text: Show every custom field.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/CustomField'].post
  update:
    x-apievangelist-phrasing:
      intent: Search custom fields
      effect: read
      questions:
      - How do I search custom fields by name?
      - Can I find a custom field using a search term?
      instructions:
      - text: Search custom fields for {search}.
        slots:
          search: requestBody.search
      - text: Find the custom field matching {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-11-17'
- target: $.paths['/CustomField/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get custom field object info
      effect: read
      questions:
      - What does the custom field object schema look like?
      - Can I get the metadata for custom fields?
      instructions:
      - text: Get custom field object info.
      - text: Show the custom field object schema.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/CustomField/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search custom field data entries
      effect: read
      questions:
      - How do I search custom field data entries?
      - Can I find a custom field data entry by a search term?
      instructions:
      - text: Search custom field data entries for {search}.
        slots:
          search: requestBody.search
      - text: Find the custom field data entry matching {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-11-17'
- target: $.paths['/CustomFieldData/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get custom field data object info
      effect: read
      questions:
      - What custom fields are available in Deputy for custom field data objects?
      - Where can I find the object info for custom field data?
      instructions:
      - text: Get custom field data object info.
      - text: Show the available custom field data object definitions.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/Employee/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get employee object info
      effect: read
      questions:
      - What does the employee object schema look like?
      - Can I get the metadata for employee records?
      instructions:
      - text: Get employee object info.
      - text: Show the employee object schema.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/Employee/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search employees
      effect: read
      questions:
      - How do I find an employee by name or email?
      - Can I search employees with a search term?
      instructions:
      - text: Search employees for {search}.
        slots:
          search: requestBody.search
      - text: Find the employee matching {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmployeeAgreement'].get
  update:
    x-apievangelist-phrasing:
      intent: List employee agreements
      effect: read
      questions:
      - Which employee agreements have been signed?
      - Can I list all employee agreements?
      instructions:
      - text: List my employee agreements.
      - text: Show every employee agreement.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmployeeAgreement/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get employee agreement object info
      effect: read
      questions:
      - What fields does the employee agreement object type contain?
      - Can I look up the employee agreement object definition?
      instructions:
      - text: Get employee agreement object info.
      - text: Show the fields of the employee agreement object type.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmployeeAgreement/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search employee agreements
      effect: read
      questions:
      - How do I search employee agreements?
      - Can I find an employee agreement by a search term?
      instructions:
      - text: Search employee agreements for {search}.
        slots:
          search: requestBody.search
      - text: Find the employee agreement matching {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmployeeAgreementHistory'].get
  update:
    x-apievangelist-phrasing:
      intent: List employee agreement history
      effect: read
      questions:
      - What has been recorded in the employee agreement history?
      - Can I list employee agreement history entries?
      instructions:
      - text: List my employee agreement history.
      - text: Show every employee agreement history entry.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmployeeAgreementHistory/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get employee agreement history object info
      effect: read
      questions:
      - What does the employee agreement history object track?
      - Where can I find the object definition for employee agreement history?
      instructions:
      - text: Get employee agreement history object info.
      - text: Show the employee agreement history object fields.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmployeeAgreementHistory/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search employee agreement history
      effect: read
      questions:
      - How do I search employee agreement history?
      - Can I find an employee agreement history entry by a search term?
      instructions:
      - text: Search employee agreement history for {search}.
        slots:
          search: requestBody.search
      - text: Find the employee agreement history entry matching {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmployeeAppraisal'].get
  update:
    x-apievangelist-phrasing:
      intent: List employee appraisals
      effect: read
      questions:
      - Which employee appraisals have been completed?
      - Can I list all employee appraisals?
      instructions:
      - text: List my employee appraisals.
      - text: Show every employee appraisal.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmployeeAppraisal'].post
  update:
    x-apievangelist-phrasing:
      intent: Search employee appraisals
      effect: read
      questions:
      - How do I search employee appraisals?
      - Can I find an employee appraisal by a search term?
      instructions:
      - text: Search employee appraisals for {search}.
        slots:
          search: requestBody.search
      - text: Find the employee appraisal matching {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmployeeAppraisal/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get employee appraisal object info
      effect: read
      questions:
      - What fields does the employee appraisal object type have?
      - Is there an object definition for employee appraisals?
      instructions:
      - text: Get employee appraisal object info.
      - text: Show the fields of the employee appraisal object type.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmployeeAvailability'].get
  update:
    x-apievangelist-phrasing:
      intent: Get employee availability
      effect: read
      questions:
      - What are my employees' availabilities?
      - Can I get employee availability records?
      instructions:
      - text: Get my employee availability.
      - text: Show every employee's availability.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmployeeAvailability/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the employee availability object info
      effect: read
      questions:
      - What does the employee availability object contain?
      - Can I get metadata about the employee availability resource?
      instructions:
      - text: Get the employee availability object info.
      - text: Show the structure of the employee availability resource.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmployeeAvailability/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search employee availability
      effect: read
      questions:
      - Can I find when an employee is available to work?
      - Which employees are free on a given date?
      instructions:
      - text: Search employee availability with {search}.
        slots:
          search: requestBody.search
      - text: Find employees available on a date using {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmployeeHistory'].get
  update:
    x-apievangelist-phrasing:
      intent: List employee history
      effect: read
      questions:
      - What has happened to an employee over time?
      - Can I see an employee's work history?
      instructions:
      - text: Get employee history.
      - text: List the work history of an employee.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmployeeHistory/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the employee history object info
      effect: read
      questions:
      - What does the employee history object contain?
      - Can I get metadata about the employee history resource?
      instructions:
      - text: Get the employee history object info.
      - text: Show the structure of the employee history resource.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmployeeHistory/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search employee history
      effect: read
      questions:
      - Can I find an employee's leave or roster history?
      - Which employees have a specific history record?
      instructions:
      - text: Search employee history with {search}.
        slots:
          search: requestBody.search
      - text: Find employees with history matching {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmployeeRole'].get
  update:
    x-apievangelist-phrasing:
      intent: List employee roles
      effect: read
      questions:
      - What roles do employees hold?
      - Can I get the list of employee roles?
      instructions:
      - text: Get employee roles.
      - text: List all employee roles.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmployeeRole/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the employee role object info
      effect: read
      questions:
      - What does the employee role object contain?
      - Can I get metadata about the employee role resource?
      instructions:
      - text: Get the employee role object info.
      - text: Show the structure of the employee role resource.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmployeeRole/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search employee roles
      effect: read
      questions:
      - Can I find employees with a particular role?
      - Which employees hold a given role?
      instructions:
      - text: Search employee roles with {search}.
        slots:
          search: requestBody.search
      - text: Find employees with role {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmployeeWorkplace'].get
  update:
    x-apievangelist-phrasing:
      intent: List employee workplaces
      effect: read
      questions:
      - Which workplaces do employees work at?
      - Can I get the list of employee workplaces?
      instructions:
      - text: Get employee workplaces.
      - text: List all employee workplaces.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmployeeWorkplace'].post
  update:
    x-apievangelist-phrasing:
      intent: Search employee workplaces
      effect: read
      questions:
      - Can I find the workplace an employee works at?
      - Which employees are assigned to a workplace?
      instructions:
      - text: Search employee workplaces with {search}.
        slots:
          search: requestBody.search
      - text: Find employees assigned to a workplace using {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmploymentCondition'].get
  update:
    x-apievangelist-phrasing:
      intent: List employment conditions
      effect: read
      questions:
      - What employment conditions are available?
      - Can I get the list of employment conditions?
      instructions:
      - text: Get employment conditions.
      - text: List all employment conditions.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmploymentCondition/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the employment condition object info
      effect: read
      questions:
      - What does the employment condition object contain?
      - Can I get metadata about the employment condition resource?
      instructions:
      - text: Get the employment condition object info.
      - text: Show the structure of the employment condition resource.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmploymentCondition/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search employment conditions
      effect: read
      questions:
      - Can I find an employment condition by name?
      - Which employees have a given employment condition?
      instructions:
      - text: Search employment conditions with {search}.
        slots:
          search: requestBody.search
      - text: Find employment conditions matching {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmploymentContract/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the employment contract object info
      effect: read
      questions:
      - What does the employment contract object contain?
      - Can I get metadata about the employment contract resource?
      instructions:
      - text: Get the employment contract object info.
      - text: Show the structure of the employment contract resource.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmploymentContract/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search employment contracts
      effect: read
      questions:
      - Can I find an employee's employment contract?
      - Which employees have a contract matching a search?
      instructions:
      - text: Search employment contracts with {search}.
        slots:
          search: requestBody.search
      - text: Find employment contracts matching {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmploymentContractLeaveRules'].get
  update:
    x-apievangelist-phrasing:
      intent: List employment contract leave rules
      effect: read
      questions:
      - What leave rules apply to an employment contract?
      - Can I get the leave rules for a contract?
      instructions:
      - text: Get employment contract leave rules.
      - text: List leave rules for an employment contract.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmploymentContractLeaveRules'].post
  update:
    x-apievangelist-phrasing:
      intent: Search employment contract leave rules
      effect: read
      questions:
      - Can I find leave rules for a contract?
      - Which contract leave rules match a search?
      instructions:
      - text: Search employment contract leave rules with {search}.
        slots:
          search: requestBody.search
      - text: Find leave rules for a contract using {search}.
        slots:
          search: requestBody.search
      method: generated
      generated: '2026-11-17'
- target: $.paths['/EmploymentContractLeaveRules/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the employment contract leave rules object info
      effect: read
      questions:
      - What does the employment contract leave rules object contain?
      - Can I get metadata about the leave rules resource?
      instructions:
      - text: Get the employment contract leave rules object info.
      - text: Show the structure of the employment contract leave rules resource.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/Event'].get
  update:
    x-apievangelist-phrasing:
      intent: List events
      effect: read
      questions:
      - What events are scheduled?
      - Can I get the list of events?
      instructions:
      - text: Get events.
      - text: List all events.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/Event/INFO'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the event object info
      effect: read
      questions:
      - What does the event object contain?
      - Can I get metadata about the event resource?
      instructions:
      - text: Get the event object info.
      - text: Show the structure of the event resource.
      method: generated
      generated: '2026-11-17'
- target: $.paths['/Event/QUERY'].post
  update:
    x-apievangelist-phrasing:
      intent: Search events
      effect: read
      questions:
      - How do I find events matching a search?
      - Can I query events by date or type?
      instructions:
      - text: Search events with {search}.
        slots:
          search: requestBody.search
      - text: Find events matching {search}.
        slots:
          search: requestBody.search
      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-resource-api-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.