# Deputy API Documentation

This is the complete API documentation for connecting to the Deputy API using MindCloud's Universal API.

MindCloud offers one normalized API to access 3,400+ apps from a single place. It centralizes authentication and normalizes app APIs so they are easier and more consistent to use.

## Quickstart

1. A **MindCloud account** — sign in or create an account at [MindCloud](https://app.mindcloud.co).
2. A **MindCloud API Key** — create one in [API Keys](https://app.mindcloud.co/user/api-keys). Keep it on your server.
3. At least one **Deputy connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

```text
POST https://connect.mindcloud.co/v2/universal/apps/deputy/actions/{actionSlug}/run
```

## Deputy actions

- POST `add-shift` Add Shift
- POST `create-employee` Create Employee
- POST `create-leave-request` Create Leave Request
- GET `get-contact` Get Contact
- GET `get-custom-field` Get Custom Field
- GET `get-employee` Get Employee
- GET `get-leave-request` Get Leave Request
- GET `get-timesheet-details` Get Timesheet Details
- GET `list-contacts` List Contacts
- GET `list-countries` List Countries
- GET `list-custom-fields` List Custom Fields
- GET `list-employee-pay-conditions` List Employee Pay Conditions
- GET `list-employees` List Employees
- GET `list-labor-model-rules` List Labor Model Rules
- GET `list-leave-requests` List Leave Requests
- GET `list-sales-data` List Sales Data
- GET `list-shifts` List Shifts
- GET `list-states` List States
- GET `list-timesheet-pay-returns` List Timesheet Pay Returns
- GET `list-timesheets` List Timesheets
- GET `search-contacts` Search Contacts
- GET `search-custom-fields` Search Custom Fields
- GET `search-employees` Search Employees
- GET `search-leave-requests` Search Leave Requests