Deputy

Deputy Employee API

Operations on the Employee resource

GitHub OpenAPI
Business capability
HR Operations Management BC-300.70

Operations 65

GET /resource/Employee List Employee records #
POST /resource/Employee Create a Employee #
PUT /resource/Employee Create a Employee #
POST /resource/Employee/BULK Bulk create/update Employee #
GET /resource/Employee/INFO Get field metadata for Employee #
POST /resource/Employee/PREDICT Predict-match a Employee record #
POST /resource/Employee/QUERY Search Employee #
GET /resource/Employee/{id} Get a Employee by id #
POST /resource/Employee/{id} Update a Employee #
PUT /resource/Employee/{id} Update a Employee #
DELETE /resource/Employee/{id} Delete a Employee #
GET /resource/Employee/{id}/COMMENTS List comments on a Employee #
POST /resource/Employee/{id}/COMMENTS Add a comment to a Employee #
DELETE /resource/Employee/{id}/COMMENTS/{commentId} Delete a comment on a Employee #
GET /resource/Employee/{id}/HISTORY Get change history for a Employee #
GET /resource/Employee/{id}/HISTORY/travel/{timestamp} Get a Employee as it existed at a prior time #
PUT /supervise/employee Create Employee #
POST /supervise/employee Create or update Employee #
POST /supervise/employee/QUERY POST Employee / QUERY #
POST /supervise/employee/amendABP POST Employee / amendABP #
POST /supervise/employee/checkLicense POST Employee / checkLicense #
GET /supervise/employee/contractedhours/template GET Employee / template #
PUT /supervise/employee/contractedhours/template PUT Employee / template #
POST /supervise/employee/contractedhours/template POST Employee / template #
POST /supervise/employee/contractedhours/template/{templateId} POST Employee / :templateId #
DELETE /supervise/employee/contractedhours/template/{templateId} DELETE Employee / :templateId #
PUT /supervise/employee/create PUT Employee / create #
POST /supervise/employee/create POST Employee / create #
GET /supervise/employee/demo GET Employee / demo #
GET /supervise/employee/invitation GET Employee / invitation #
POST /supervise/employee/invitation POST Employee / invitation #
DELETE /supervise/employee/invitation DELETE Employee / invitation #
POST /supervise/employee/invitation/validate POST Employee / validate #
GET /supervise/employee/real GET Employee / real #
GET /supervise/employee/real/count GET Employee / count #
POST /supervise/employee/reset/gender POST Employee / gender #
GET /supervise/employee/role/manage GET Employee / manage #
PUT /supervise/employee/validate PUT Employee / validate #
POST /supervise/employee/validate POST Employee / validate #
GET /supervise/employee/{employeeId} GET Employee / (:employeeId)? #
POST /supervise/employee/{employeeId} POST Employee / :employeeId #
POST /supervise/employee/{employeeId}/activate POST Employee / activate #
POST /supervise/employee/{employeeId}/assoc/{wpId} POST Employee / :wpId #
GET /supervise/employee/{employeeId}/contractedhours GET Employee / contractedhours #
PUT /supervise/employee/{employeeId}/contractedhours PUT Employee / contractedhours #
POST /supervise/employee/{employeeId}/contractedhours POST Employee / contractedhours #
POST /supervise/employee/{employeeId}/delete POST Employee / delete #
GET /supervise/employee/{employeeId}/hr/onboarding GET Employee / onboarding #
POST /supervise/employee/{employeeId}/hr/onboarding POST Employee / onboarding #
GET /supervise/employee/{employeeId}/hr/payroll/connected GET Employee / connected #
GET /supervise/employee/{employeeId}/hr/payroll/sync GET Employee / sync #
POST /supervise/employee/{employeeId}/hr/payroll/sync POST Employee / sync #
POST /supervise/employee/{employeeId}/invite POST Employee / invite #
GET /supervise/employee/{employeeId}/manage-login GET Employee / manage login #
POST /supervise/employee/{employeeId}/photo POST Employee / photo #
POST /supervise/employee/{employeeId}/reset-2fa POST Employee / reset 2fa #
POST /supervise/employee/{employeeId}/send-reset-account POST Employee / send reset account #
POST /supervise/employee/{employeeId}/sendlogin POST Employee / sendlogin #
POST /supervise/employee/{employeeId}/setAwardFromLibrary POST Employee / setAwardFromLibrary #
POST /supervise/employee/{employeeId}/setAwardFromTemplate POST Employee / setAwardFromTemplate #
POST /supervise/employee/{employeeId}/terminate POST Employee / terminate #
POST /supervise/employee/{employeeId}/unassoc/{wpId} POST Employee / :wpId #
GET /supervise/employee/{employeeId}/validate GET Employee / validate #
POST /supervise/employee/{employeeId}/{action} POST Employee / :action #
GET /supervise/employee/{employeeId}/{action} GET Employee / :action #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/openapi/deputy-employee-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-addanemployee-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-createa-department-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-addleaveforaemployee-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-createamemo-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-add-new-workplace-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-setawardforemployee-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-custom-field-data-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-timesheet-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-employee-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-pay-rules-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-roster-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-employee-agreement-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-tenanttimesheetv2model-timesheet-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-pay-comparison-submit-report-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-v2model-leave-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-v2model-employment-contracts-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-copy-request-copy-request-data-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-v2model-area-profile-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-searchfor-employment-contract-leave-rules-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-searchforan-employee-agreement-history-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-searchforan-employee-availability-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-searchforacustomfielddataentry-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-searchforan-employment-condition-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-searchforan-employment-contract-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-hr-export-export-hr-bulk-data-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-user-info-get-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-hr-export-export-hr-data-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/json-schema/deputy-hr-export-export-hr-pay-details-data-response-schema.json

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/deputy:deputy-employee-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

deputy-employee-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Deputy Employee API
  version: 1.0.0
  description: 'Operations tagged Employee across 2 of this provider''s published API definitions: deputy-v1-resource-api-openapi.yml, deputy-v1-supervise-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{subdomain}.{region}.deputy.com/api/v1
  description: Deputy tenant
  variables:
    subdomain:
      default: your-subdomain
    region:
      default: deputy
      enum:
      - au
      - eu
      - na
      - deputy
tags:


# --- truncated at 32 KB (75 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/openapi/deputy-employee-api-openapi.yml