Deputy

Deputy Employees API

The Employees API from Deputy — 14 operation(s) for employees.

GitHub OpenAPI
Business capability
HR Operations Management BC-300.70

Operations 18

GET /v1/supervise/employee Get details for all employees #
POST /v1/supervise/employee Add an employee #
GET /v1/supervise/employee/{employeeid} Get details for a employee by id #
POST /v1/supervise/employee/{employeeid}/activate Re-activate a terminated employee #
POST /v1/supervise/employee/{employeeid}/assoc/{locationid} Add a location against an employee #
POST /v1/supervise/employee/{employeeid}/delete Delete an employees account in Deputy #
POST /v1/supervise/employee/{employeeid}/invite Invite employee to Deputy #
POST /v1/supervise/employee/{employeeid}/setAwardFromLibrary Set award for employee #
POST /v1/supervise/employee/{employeeid}/terminate Terminate an employee #
POST /v1/supervise/employee/{employeeid}/unassoc/{locationid} Remove a location from an employee #
POST /v1/supervise/employee/{id} Update an existing employee #
GET /management/v2/employees Retrieve list of employees #
POST /management/v2/employees Create an employee setup #
GET /management/v2/employees/{id} Retrieve employee by given Id #
PATCH /management/v2/employees/{id} Patch an employee setup #
POST /management/v2/employees:bulk Create a bunch of employee setups #
PATCH /management/v2/employees:bulk Patch an employee setup #
POST /management/v2/employees:validate-emails Validate emails #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/openapi/deputy-employees-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-employees-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-employees-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Deputy Employees API
  version: '1.0'
  description: 'Operations tagged Employees across 2 of this provider''s published API definitions: deputy-deputy-openapi.yml, deputy-v2-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{install}.{geo}.deputy.com/api
  variables:
    install:
      default: ''
    geo:
      default: ''
- url: https://{subdomain}.{region}.deputy.com/api
  description: Deputy tenant
  variables:
    subdomain:
      default: your-subdomain
      description: Your Deputy tenant subdomain
    region:
      default: deputy
      enum:
      - au
      - eu
      - na
      - deputy
      description: 'Deputy region: au, eu, na, or deputy (AU default)'
tags:


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