# Deputy Employee API

**Canonical:** https://apis.io/apis/deputy/deputy-employee-api/  
**Provider:** Deputy — https://apis.io/providers/deputy/  
**Base URL:** https://{install}.{geo}.deputy.com/api/v1  
**Documentation:** https://developer.deputy.com/deputy-docs

Deputy Employee API is one of 217 APIs that [Deputy](https://apis.io/providers/deputy/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 28 JSON Schema definitions. Tagged areas include Employee. The published artifact set on APIs.io includes an OpenAPI specification and 28 JSON Schemas.

Operations on the Employee resource

## Operations (60 of 65)

| Method | Path | Summary |
|---|---|---|
| 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 |

…and 5 more operations. They are listed in full on the page.

## Machine-readable artifacts (29)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/deputy/refs/heads/main/openapi/deputy-employee-api-openapi.yml
- **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

## Other Deputy APIs (12)

- [Deputy Public API](https://apis.io/apis/deputy/public-api/)
- [Deputy Access Management Employee API](https://apis.io/apis/deputy/deputy-access-management-employee-api/)
- [Deputy Access Management Employee Role API](https://apis.io/apis/deputy/deputy-access-management-employee-role-api/)
- [Deputy Access Management Employee Role History API](https://apis.io/apis/deputy/deputy-access-management-employee-role-history-api/)
- [Deputy Access Management Privilege Hierarchy API](https://apis.io/apis/deputy/deputy-access-management-privilege-hierarchy-api/)
- [Deputy Access Management Role API](https://apis.io/apis/deputy/deputy-access-management-role-api/)
- [Deputy Account Stats API](https://apis.io/apis/deputy/deputy-account-stats-api/)
- [Deputy Add Entitlement To Employees API](https://apis.io/apis/deputy/deputy-add-entitlement-to-employees-api/)
- [Deputy Address API](https://apis.io/apis/deputy/deputy-address-api/)
- [Deputy Agreed Hour API](https://apis.io/apis/deputy/deputy-agreed-hour-api/)
- [Deputy AI Assistant API](https://apis.io/apis/deputy/deputy-ai-assistant-api/)
- [Deputy Area Management API](https://apis.io/apis/deputy/deputy-area-management-api/)

## Tags

Employee

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/deputy/deputy-employee-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/deputy/.
