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.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Deputy V2 Employee Profile API
version: 1.0.0
extends: openapi/deputy-employee-profile-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-11-17'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/management/v2/employee-profile/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get one employee profile
effect: read
questions:
- Can I fetch a single employee's profile by ID?
- What does one employee profile record include?
instructions:
- text: Get employee profile {id}.
slots:
id: path.id
- text: Show me the profile of employee {id}.
slots:
id: path.id
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/employee-profile:by-ids-and-custom-filters'].post
update:
x-apievangelist-phrasing:
intent: Look up several employee profiles
effect: read
questions:
- Can I fetch profiles for a list of employee IDs at once?
- Is there a way to filter employee profiles by location or employment type?
instructions:
- text: Get employee profiles {employeeIds}.
slots:
employeeIds: requestBody.employeeIds
- text: Find employees at locations {mainLocations} with employment type {employmentTypes}.
slots:
mainLocations: requestBody.mainLocations
employmentTypes: requestBody.employmentTypes
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/employees-profile'].get
update:
x-apievangelist-phrasing:
intent: List employee profiles
effect: read
questions:
- Which employees are on the roster right now?
- Can I search employee profiles by name or role?
instructions:
- text: List employee profiles matching {filters}.
slots:
filters: query.filters
- text: Show employees with role {role}, ordered by {orderBy}.
slots:
role: query.filters
orderBy: query.orderBy
method: generated
generated: '2026-11-17'
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.