# Deputy Resource API

**Canonical:** https://apis.io/apis/deputy/deputy-resource-api-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 Resource 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 Resource API. The published artifact set on APIs.io includes an OpenAPI specification and 28 JSON Schemas.

The Resource API API from Deputy — 56 operation(s) for resource api.

## Operations (60 of 61)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/resource/Employee/{employeeid}` | Example - Search for employees from a location |
| GET | `/Address` | Get Addresses |
| GET | `/Address/INFO` | Get Address Object Info |
| POST | `/Address/QUERY` | Search for address |
| GET | `/Category` | Get Categories |
| GET | `/Category/INFO` | Get Category Object Info |
| POST | `/Category/QUERY` | Search for Category |
| GET | `/Comment` | Get Comments |
| GET | `/Comment/INFO` | Get Comment Object Info |
| POST | `/Comment/QUERY` | Search for a comment |
| GET | `/Company` | Get Locations |
| POST | `/Company` | Search for a Location |
| GET | `/Company/INFO` | Get Locations Object Info |
| GET | `/CompanyPeriod` | Get Company Periods |
| GET | `/CompanyPeriod/INFO` | Get Company Period Object Info |
| POST | `/CompanyPeriod/QUERY` | Search for a Company Period |
| GET | `/Contact/INFO` | Get Contact Object Info |
| POST | `/Contact/QUERY` | Search for a contact |
| GET | `/Country/INFO` | Get Country Object Info |
| POST | `/Country/QUERY` | Search for a country |
| GET | `/CustomAppData` | Get Custom App Data entries |
| GET | `/CustomAppData/INFO` | Get Custom App Data Object Info |
| POST | `/CustomAppData/QUERY` | Search for a custom app data entry |
| GET | `/CustomField` | Get Custom Fields |
| POST | `/CustomField` | Search for a Custom Field |
| GET | `/CustomField/INFO` | Get Custom Field Object Info |
| POST | `/CustomField/QUERY` | Search for a custom field data entry |
| GET | `/CustomFieldData/INFO` | Get Custom Field Data Object Info |
| GET | `/Employee/INFO` | Get Employee Object Info |
| POST | `/Employee/QUERY` | Search for an employee |
| GET | `/EmployeeAgreement` | Get Employee Agreements |
| GET | `/EmployeeAgreement/INFO` | Get Employee Agreement Object Info |
| POST | `/EmployeeAgreement/QUERY` | Search for an employee agreement |
| GET | `/EmployeeAgreementHistory` | Get Employee Agreement History |
| GET | `/EmployeeAgreementHistory/INFO` | Get Employee Agreement History Object Info |
| POST | `/EmployeeAgreementHistory/QUERY` | Search for an Employee Agreement History |
| GET | `/EmployeeAppraisal` | Get Employee Appraisals |
| POST | `/EmployeeAppraisal` | Search for an Employee Appraisal |
| GET | `/EmployeeAppraisal/INFO` | Get Employee Appraisal Object Info |
| GET | `/EmployeeAvailability` | Get Employee Availability |
| GET | `/EmployeeAvailability/INFO` | Get Employee Availability Object Info |
| POST | `/EmployeeAvailability/QUERY` | Search for an Employee Availability |
| GET | `/EmployeeHistory` | Get Employee History |
| GET | `/EmployeeHistory/INFO` | Get Employee History Object Info |
| POST | `/EmployeeHistory/QUERY` | Search for an Employee History |
| GET | `/EmployeeRole` | Get Employee Roles |
| GET | `/EmployeeRole/INFO` | Get Employee Role Object Info |
| POST | `/EmployeeRole/QUERY` | Search for an Employee Role |
| GET | `/EmployeeWorkplace` | Get Employee Workplaces |
| POST | `/EmployeeWorkplace` | Search for an Employee Workplace |
| GET | `/EmploymentCondition` | Get Employment Conditions |
| GET | `/EmploymentCondition/INFO` | Get Employment Condition Object Info |
| POST | `/EmploymentCondition/QUERY` | Search for an Employment Condition |
| GET | `/EmploymentContract/INFO` | Get Employment Contract Object Info |
| POST | `/EmploymentContract/QUERY` | Search for an Employment Contract |
| GET | `/EmploymentContractLeaveRules` | Get Employment Contract Leave Rules |
| POST | `/EmploymentContractLeaveRules` | Search for Employment Contract Leave Rules |
| GET | `/EmploymentContractLeaveRules/INFO` | Get Employment Contract Leave Rules Object Info |
| GET | `/Event` | Get Events |
| GET | `/Event/INFO` | Get Event Object Info |

…and 1 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-resource-api-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

Resource API

---

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