# Deputy

> Read employees, locations, shifts, timesheets, leave and employment information.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/deputy

## Actions

### Get area

Get one area by its ID, returning its name, the location it belongs to and whether it is active.

**Inputs**

- Area (`area_id`, number, required): Area ID. At least 1.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {}
}
```

### Get employee

Get one employee by their ID, returning their name, contact details, main location and whether they are active.

**Inputs**

- Employee (`employee_id`, number, required): Employee ID. At least 1.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {}
}
```

### Get employee agreement

Get one employee agreement by its ID, returning the employee, pay rate details, contract and active dates.

**Inputs**

- Employee agreement ID (`employee_agreement_id`, number, required): Employee agreement ID. At least 1.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {}
}
```

### Get employment contract

Get one employment contract by its ID, returning its name, code and pay settings.

**Inputs**

- Employment contract ID (`employment_contract_id`, number, required): Employment contract ID. At least 1.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {}
}
```

### Get leave request

Get one leave request by its ID, returning the employee, leave dates, hours, type and approval status.

**Inputs**

- Leave request ID (`leave_request_id`, number, required): Leave request ID. At least 1.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {}
}
```

### Get location

Get one location by its ID, returning its name, code, address and settings.

**Inputs**

- Location (`location_id`, number, required): Location ID. At least 1.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {}
}
```

### Get shift

Get one rostered shift by its ID, returning its employee, area, start and end times, breaks and whether it is published.

**Inputs**

- Shift ID (`shift_id`, number, required): Shift ID. At least 1.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {}
}
```

### Get task

Get one task by its ID, returning its question, who it is assigned to, its due date and whether it is complete.

**Inputs**

- Task ID (`task_id`, number, required): Task ID. At least 1.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {}
}
```

### Get timesheet

Get one timesheet by its ID, returning the employee, worked start and end times, breaks, total hours and approval state.

**Inputs**

- Timesheet ID (`timesheet_id`, number, required): Timesheet ID. At least 1.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {}
}
```

### Get timesheet pay return

Get one timesheet pay return by its ID, returning its timesheet, pay rule, hours and cost.

**Inputs**

- Timesheet pay return ID (`timesheet_pay_return_id`, number, required): Timesheet pay return ID. At least 1.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {}
}
```

### List areas

List the areas (operational units) shifts are rostered to, optionally only those changed since a given time. Returns one page; use start and max for the next page.

**Inputs**

- Start (`start`, number): Start. At least 0.
- Max (`max`, number): Max. From 1 to 500.
- Modified since (`modified_since`, date and time): Modified since.

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### List employee agreements

List employee agreements, which link an employee to their pay rates and contract, optionally only those changed since a given time. Returns one page; use start and max for the next page.

**Inputs**

- Start (`start`, number): Start. At least 0.
- Max (`max`, number): Max. From 1 to 500.
- Modified since (`modified_since`, date and time): Modified since.

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### List employees

List the employees in your Deputy account, optionally only those changed since a given time. Returns one page; use start and max for the next page.

**Inputs**

- Start (`start`, number): Start. At least 0.
- Max (`max`, number): Max. From 1 to 500.
- Modified since (`modified_since`, date and time): Modified since.

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### List employment contracts

List employment contracts (award or pay templates), optionally only those changed since a given time. Returns one page; use start and max for the next page.

**Inputs**

- Start (`start`, number): Start. At least 0.
- Max (`max`, number): Max. From 1 to 500.
- Modified since (`modified_since`, date and time): Modified since.

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### List leave requests

List leave requests, optionally only those changed since a given time. Returns one page with each request's employee, dates and status; use start and max for the next page.

**Inputs**

- Start (`start`, number): Start. At least 0.
- Max (`max`, number): Max. From 1 to 500.
- Modified since (`modified_since`, date and time): Modified since.

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### List locations

List your Deputy locations (workplaces), optionally only those changed since a given time. Returns one page; use start and max for the next page.

**Inputs**

- Start (`start`, number): Start. At least 0.
- Max (`max`, number): Max. From 1 to 500.
- Modified since (`modified_since`, date and time): Modified since.

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### List shifts

List rostered shifts, optionally only those changed since a given time. Returns one page with each shift's employee, area, start and end; use start and max for the next page.

**Inputs**

- Start (`start`, number): Start. At least 0.
- Max (`max`, number): Max. From 1 to 500.
- Modified since (`modified_since`, date and time): Modified since.

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### List tasks

List tasks assigned to staff, optionally only those changed since a given time. Returns one page with each task's question, assignee and due date; use start and max for the next page.

**Inputs**

- Start (`start`, number): Start. At least 0.
- Max (`max`, number): Max. From 1 to 500.
- Modified since (`modified_since`, date and time): Modified since.

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### List timesheet pay returns

List timesheet pay returns, the pay lines calculated from approved timesheets, optionally only those changed since a given time. Returns one page; use start and max for the next page.

**Inputs**

- Start (`start`, number): Start. At least 0.
- Max (`max`, number): Max. From 1 to 500.
- Modified since (`modified_since`, date and time): Modified since.

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```

### List timesheets

List timesheets, optionally only those changed since a given time. Returns one page with each timesheet's employee, times and approval state; use start and max for the next page.

**Inputs**

- Start (`start`, number): Start. At least 0.
- Max (`max`, number): Max. From 1 to 500.
- Modified since (`modified_since`, date and time): Modified since.

**Outputs**

- `data` (list): Response.

**Example output**

```json
{
  "data": []
}
```
