Deputy API

https://integrations-directory.prod.dpty.io/postmancollection/
Admin
Deputy is a workforce management platform providing REST APIs for managing locations, employees,...
Tokens:17,774
Snippets:131
Trust Score:4.3
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get User's Work Setup

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves information about the user's work setup, including roles and permissions. Requires an Authorization header.

```http
GET {{depBaseUrl}}/api/v1/my/setup
```

--------------------------------

### Start Employee Timesheet (Clock On) - POST API Request

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Initiate an employee's timesheet by sending a POST request to the start endpoint. Requires an Authorization header.

```json
{
					"name": "Start an employees timesheet (Clock On)",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "Authorization",
								"value": "Bearer {{depApiKey}}",
								"type": "text"
							}
						],
						"url": {
							"raw": "{{depBaseUrl}}/api/v1/supervise/timesheet/start",
							"host": [
								"{{depBaseUrl}}"
							],
							"path": [
								"api",
								"v1",
								"supervise",
								"timesheet",
								"start"
							]
						}
					},
					"response": []
				}
```

--------------------------------

### Where can I work/What do I do

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves information about the user's work setup and roles.

```APIDOC
## GET /api/v1/my/setup

### Description
Retrieves information about the user's work setup and roles.

### Method
GET

### Endpoint
/api/v1/my/setup

### Headers
- Authorization: Bearer {{depApiKey}}

```

--------------------------------

### Get my training

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves training information for the authenticated user.

```APIDOC
## GET /api/v1/my/training

### Description
Retrieves training information for the authenticated user.

### Method
GET

### Endpoint
/api/v1/my/training

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **field1** (type) - Description
```

--------------------------------

### Get Available Rosters for Swap - GET API Request

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieve a list of rosters that are available for swapping. This GET request requires an Authorization header and includes a raw JSON body, though it's typically used for GET requests.

```json
{
					"name": "Get rosters available for swap",
					"protocolProfileBehavior": {
						"disableBodyPruning": true
					},
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "Authorization",
								"value": "Bearer {{depApiKey}}",
								"type": "text"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"intRosterArray\": [400]\n    }",
							"options": {
								"raw": {
									"language": "json"
								}
							}
						},
						"url": {
							"raw": "{{depBaseUrl}}/api/v1/supervise/roster/autobuild",
							"host": [
								"{{depBaseUrl}}"
							],
							"path": [
								"api",
								"v1",
								"supervise",
								"roster",
								"autobuild"
							]
						}
					},
					"response": []
				}
```

--------------------------------

### Start Employee Timesheet (Clock On)

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Initiate an employee's timesheet, effectively clocking them in.

```APIDOC
## POST /api/v1/supervise/timesheet/start

### Description
Start an employees timesheet (Clock On).

### Method
POST

### Endpoint
{{depBaseUrl}}/api/v1/supervise/timesheet/start
```

--------------------------------

### Get All Employees

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves details for all employees.

```APIDOC
## GET /api/v1/supervise/employee

### Description
Retrieves details for all employees.

### Method
GET

### Endpoint
/api/v1/supervise/employee
```

--------------------------------

### Get All Employees

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves details for all employees within the company.

--------------------------------

### Add New Workplace

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

This endpoint allows you to add a new workplace/location to your existing Deputy install.

```APIDOC
## POST /api/v1/my/setup/addNewWorkplace

### Description
This endpoint allows you to add a new workplace/location to your existing Deputy install.

### Method
POST

### Endpoint
/api/v1/my/setup/addNewWorkplace

### Parameters
#### Request Body
- **strWorkplaceName** (String) - Required - String naming the workplace
- **strWorkplaceTimezone** (String) - Required - Timezone for the workplace using TZ database naming
- **strAddress** (String) - Required - String of the locations address
- **strLat** (String) - Required - The latitude of the location using a string
- **strLon** (String) - Required - The longitude of the location using a string
- **intCountry** (Integer) - Required - An integer which defines which country the location is in
- **arrAreaNames** (Array) - Required - An array of the area names to add to the location
- **strWorkplaceCode** (String) - Required - A string with a length of 3 allowing you to define a short code for the location
- **strPayrollExportCode** (String) - Optional - String naming what to use as a code for payroll exports to applications such as Xero
- **strParentCompany** (String) - Optional - Name or integer id of the company the location belongs to
- **blnIsWorkplace** (Boolean) - Required - Whether the location is considered a workplace (1 - True, 0 - False)
- **blnIsPayrollEntity** (Boolean) - Required - Whether the location has payroll setup (1 - True, 0 - False)

### Request Example
```json
{
    "strWorkplaceName": "Simons Sambos - Sydney2",
    "strWorkplaceTimezone": "Australia/Sydney",
    "strAddress": "580 George St",
    "strLat": "151.2093",
    "strLon": "33.8688",
    "intCountry": 13,
    "arrAreaNames": ["Chef", "Cashier"],
    "strWorkplaceCode": "SYD",
    "strPayrollExportCode": "SYDEXPORT",
    "blnIsWorkplace": 1,
    "blnIsPayrollEntity": 1
}
```
```

--------------------------------

### Get Employee Leave Information via Deputy API

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Fetch leave details for a specific employee. The employee ID is a path parameter. Note: The example JSON in the description appears to be for posting a memo, not retrieving leave.

```http
GET /api/v1/supervise/leave/{{employeeid}} HTTP/1.1
Host: {{depBaseUrl}}
Authorization: Bearer {{depApiKey}}
```

--------------------------------

### Get Recommendation

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves recommendations for a given roster ID.

```APIDOC
## GET /api/v1/supervise/getRecommendation/{rosterid}

### Description
Retrieves recommendations for a given roster ID.

### Method
GET

### Endpoint
/api/v1/supervise/getRecommendation/{{rosterid}}

### Parameters
#### Path Parameters
- **rosterid** (string) - Required - The ID of the roster for which to get recommendations.
```

--------------------------------

### Get my tasks

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves the tasks assigned to the authenticated user.

```APIDOC
## GET /api/v1/my/tasks

### Description
Retrieves the tasks assigned to the authenticated user.

### Method
GET

### Endpoint
/api/v1/my/tasks

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **field1** (type) - Description
```

--------------------------------

### Get Location Details by ID

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieve details for a specific location using its unique ID. This is a GET request and requires an 'Authorization' header.

```http
GET {{depBaseUrl}}/api/v1/my/location/{{id}}
```

--------------------------------

### Get a locations settings

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves the specific settings for a given location.

```APIDOC
## GET /api/v1/supervise/company/{{companyid}}/settings

### Description
Retrieves the settings for a specific location.

### Method
GET

### Endpoint
/api/v1/supervise/company/{{companyid}}/settings

### Parameters
#### Path Parameters
- **companyid** (string) - Required - The ID of the company (location) to retrieve settings for.

### Headers
- Authorization: Bearer {{depApiKey}}
```

--------------------------------

### Get Rosters Available for Swap

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieve a list of rosters that are available for swapping.

```APIDOC
## GET /api/v1/supervise/roster/autobuild

### Description
Get rosters available for swap.

### Method
GET

### Endpoint
{{depBaseUrl}}/api/v1/supervise/roster/autobuild
```

--------------------------------

### Get Roster Suggestions via Deputy API

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieve suggestions for a roster by its ID. This endpoint requires an `Authorization` header.

```http
GET /api/v1/supervise/roster/suggestions/{{rosterid}} HTTP/1.1
Host: {{depBaseUrl}}
Authorization: Bearer {{depApiKey}}
```

--------------------------------

### Get Operational Units

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves a list of operational units.

```APIDOC
## GET /api/v1/resource/OperationalUnit/

### Description
Retrieves a list of all operational units.

### Method
GET

### Endpoint
/api/v1/resource/OperationalUnit/

### Headers
- Authorization: Bearer {{depApiKey}}
```

--------------------------------

### Get my newsfeed

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves the newsfeed for the authenticated user.

```APIDOC
## GET /api/v1/my/memo

### Description
Retrieves the newsfeed for the authenticated user.

### Method
GET

### Endpoint
/api/v1/my/memo

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **field1** (type) - Description
```

--------------------------------

### View Timesheet Details - GET API Request

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieve detailed information for a specific timesheet using its ID. This GET request requires an Authorization header and the timesheet ID in the URL path.

```json
{
					"name": "View a timesheet by id",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "Authorization",
								"value": "Bearer {{depApiKey}}",
								"type": "text"
							}
						],
						"url": {
							"raw": "{{depBaseUrl}}/api/v1/supervise/timesheet/{{timesheetid}}/details",
							"host": [
								"{{depBaseUrl}}"
							],
							"path": [
								"api",
								"v1",
								"supervise",
								"timesheet",
								"{{timesheetid}}",
								"details"
							]
						}
					},
					"response": []
				}
```

--------------------------------

### Get Locations

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves a list of all locations within the company.

```APIDOC
## GET /api/v1/resource/Company

### Description
Retrieves a list of all locations.

### Method
GET

### Endpoint
/api/v1/resource/Company

### Headers
- Authorization: Bearer {{depApiKey}}
```

--------------------------------

### Get my timesheets

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves a list of timesheets for the authenticated user.

```APIDOC
## GET /api/v1/my/timesheets

### Description
Retrieves a list of timesheets for the authenticated user.

### Method
GET

### Endpoint
/api/v1/my/timesheets

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **field1** (type) - Description
```

--------------------------------

### Add New Workplace

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

This endpoint allows you to add a new workplace/location to your existing Deputy install. It requires detailed information about the location, including its name, address, timezone, and associated area names.

```json
{
    "strWorkplaceName": "Simons Sambos - Sydney2",
    "strWorkplaceTimezone": "Australia/Sydney",
    "strAddress": "580 George St",
    "strLat": "151.2093",
    "strLon": "33.8688",
    "intCountry": 13,
    "arrAreaNames": ["Chef", "Cashier"],
    "strWorkplaceCode": "SYD",
    "strPayrollExportCode": "SYDEXPORT",
    "blnIsWorkplace": 1,
    "blnIsPayrollEntity": 1
}
```

--------------------------------

### Get My Notifications

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves notifications for the authenticated user.

```APIDOC
## GET /api/v1/my/notification

### Description
Retrieves notifications for the authenticated user.

### Method
GET

### Endpoint
/api/v1/my/notification

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **field1** (type) - Description
```

--------------------------------

### Get Employee by ID

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves details for a specific employee by their ID.

```APIDOC
## GET /api/v1/supervise/employee/{employeeid}

### Description
Retrieves details for a specific employee by their ID.

### Method
GET

### Endpoint
/api/v1/supervise/employee/{{employeeid}}

### Parameters
#### Path Parameters
- **employeeid** (string) - Required - The ID of the employee.
```

--------------------------------

### Get Unavailability Details

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves unavailability details for a specific employee.

```APIDOC
## GET /api/v1/supervise/unavail/{employeeid}

### Description
Retrieves unavailability details for a specific employee.

### Method
GET

### Endpoint
/api/v1/supervise/unavail/{{employeeid}}

### Parameters
#### Path Parameters
- **employeeid** (string) - Required - The ID of the employee for whom to retrieve unavailability details.
```

--------------------------------

### Get User's Roster

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves the user's upcoming work schedule or roster. Requires an Authorization header.

```http
GET {{depBaseUrl}}/api/v1/my/roster
```

--------------------------------

### GET Operational Units - Deputy API

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves a list of operational units. Requires an Authorization header.

```json
{
					"name": "Get Operational Units",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "Proxy-Authorization",
								"value": "",
								"type": "text",
								"disabled": true
							},
							{
								"key": "Authorization",
								"value": "Bearer {{depApiKey}}",
								"type": "text"
							}
						],
						"url": {
							"raw": "{{depBaseUrl}}/api/v1/resource/OperationalUnit/",
							"host": [
								"{{depBaseUrl}}"
							],
							"path": [
								"api",
								"v1",
								"resource",
								"OperationalUnit",
								""
							]
						}
					},
					"response": []
				}
```

--------------------------------

### Get my subordinate contact details

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves contact details for the user's subordinates.

```APIDOC
## GET /api/v1/my/contactaddress/subordinate

### Description
Retrieves contact details for the user's subordinates.

### Method
GET

### Endpoint
/api/v1/my/contactaddress/subordinate

### Headers
- Authorization: Bearer {{depApiKey}}

```

--------------------------------

### Get simplified location list

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves a simplified list of locations, useful for dropdowns or quick lookups.

```APIDOC
## GET /api/v1/supervise/company/simple

### Description
Retrieves a simplified list of locations.

### Method
GET

### Endpoint
/api/v1/supervise/company/simple

### Headers
- Authorization: Bearer {{depApiKey}}
```

--------------------------------

### Get my individual timesheet

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves the details of a specific timesheet for the authenticated user.

```APIDOC
## GET /api/v1/my/timesheets/{timesheetid}/detail

### Description
Retrieves the details of a specific timesheet for the authenticated user.

### Method
GET

### Endpoint
/api/v1/my/timesheets/{timesheetid}/detail

### Parameters
#### Path Parameters
- **timesheetid** (string) - Required - The ID of the timesheet to retrieve details for.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **field1** (type) - Description
```

--------------------------------

### Get User's Work Locations

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves a list of locations where the user is authorized to work. Requires an Authorization header.

```http
GET {{depBaseUrl}}/api/v1/my/location
```

--------------------------------

### Get Logged-in User Details

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves the details of the currently authenticated user. Requires an Authorization header with the API key.

```http
GET {{depBaseUrl}}/api/v1/me
```

--------------------------------

### Get location by id

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves the details of a specific location by its ID.

```APIDOC
## GET /api/v1/my/location/{id}

### Description
Retrieves the details of a specific location by its ID.

### Method
GET

### Endpoint
/api/v1/my/location/{{id}}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the location to retrieve.
```

--------------------------------

### Get All User Contact Addresses

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves all contact addresses for the user, including emergency contacts. Requires an Authorization header.

```http
GET {{depBaseUrl}}/api/v1/my/contactaddress/all
```

--------------------------------

### Get Colleagues

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves a list of colleagues associated with the user. Requires an Authorization header.

```http
GET {{depBaseUrl}}/api/v1/my/colleague
```

--------------------------------

### Get Awards Library List

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves a list of available awards from the Deputy awards library.

```json
GET {{depBaseUrl}}/api/v1/awards
```

--------------------------------

### Get Subordinate Contact Details

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves contact details for subordinates of the current user. Requires an Authorization header.

```http
GET {{depBaseUrl}}/api/v1/my/contactaddress/subordinate
```

--------------------------------

### Get Agreed Hours by Employee ID

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves the agreed hours for a specific employee.

```APIDOC
## GET /api/management/v2/agreed_hour/{employeeid}

### Description
Retrieves the agreed hours for a specific employee identified by their ID.

### Method
GET

### Endpoint
/api/management/v2/agreed_hour/{employeeid}

### Parameters
#### Path Parameters
- **employeeid** (string) - Required - The ID of the employee.

### Headers
- Authorization: Bearer {{depApiKey}}
```

--------------------------------

### Get List of Rosters

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves a list of rosters within a specified time frame. The default range is from the last 12 hours to the next 36 hours.

```http
GET
{{depBaseUrl}}/api/v1/supervise/roster
```

--------------------------------

### Get User's Contact Address

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves the primary contact address on file for the user. Requires an Authorization header.

```http
GET {{depBaseUrl}}/api/v1/my/contactaddress
```

--------------------------------

### GET Awards Library - Deputy API

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves the awards library. Requires an Authorization header with a Bearer token.

```json
{
						"method": "GET",
						"header": [
							{
								"key": "Authorization",
								"value": "Bearer {{depApiKey}}",
								"type": "text"
							}
						],
						"url": {
							"raw": "{{depBaseUrl}}/api/v1/payroll/listAwardsLibrary",
							"host": [
								"{{depBaseUrl}}"
							],
							"path": [
								"api",
								"v1",
								"payroll",
								"listAwardsLibrary"
							]
						}
					},
					"response": []
				}
```

--------------------------------

### GET Agreed Hours by Employee ID - Deputy API

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves agreed hours for a specific employee. Requires an Authorization header and the employee ID as a path parameter.

```json
{
					"name": "Get Agreed Hours by Employee ID",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "Authorization",
								"value": "Bearer {{depApiKey}}",
								"type": "text"
							}
						],
						"url": {
							"raw": "{{depBaseUrl}}/api/management/v2/agreed_hour/{{employeeid}}",
							"host": [
								"{{depBaseUrl}}"
							],
							"path": [
								"api",
								"management",
								"v2",
								"agreed_hour",
								"{{employeeid}}"
							]
						}
					},
					"response": []
				}
```

--------------------------------

### Get Employee Shift Info via Deputy API

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieve an employee's shift status using their ID. Requires an `Authorization` header with a Bearer token and the employee's ID in the URL.

```http
GET /api/v1/supervise/empshiftinfo/{{employeeid}} HTTP/1.1
Host: {{depBaseUrl}}
Authorization: Bearer {{depApiKey}}
```

--------------------------------

### Add Employee Unavailability

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Adds unavailability details for an employee. Includes start and end timestamps, comments, and recurrence rules.

```json
{
    "employee": 1,
    "start": {
        "timestamp": 1657001675
    },
    "end": {
        "timestamp": 1657001676
    },
    "strComment": "Here is a note for some unavailability",
    "recurrence": {
        "FREQ": "WEEKLY",
        "INTERVAL": 2,
        "BYDAY": "MO"
    }
}
```

--------------------------------

### Create a Department

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Creates a new department with the provided details.

```APIDOC
## PUT /api/v1/supervise/department

### Description
Creates a new department with the specified details.

### Method
PUT

### Endpoint
/api/v1/supervise/department

### Headers
- Authorization: Bearer {{depApiKey}}

### Request Body
- **intCompanyId** (integer) - Required - The ID of the company.
- **strOpunitName** (string) - Required - The name of the operational unit.
- **strAddress** (string) - Required - The address of the operational unit.
- **strExportName** (string) - Required - The export name for the department.
- **intSortOrder** (integer) - Required - The sort order for the department.
- **intOpunitType** (integer) - Required - The type of the operational unit.
- **LocationId** (integer) - Required - The ID of the location.

### Request Example
{
    "intCompanyId": 1,
    "strOpunitName": "Deutsche Bank Park",
    "strAddress": "Mörfelder Landstraße 362, 60528 Frankfurt am Main",
    "strExportName": "Fußball",
    "intSortOrder": 0,
    "intOpunitType": 1,
    "LocationId": 1
}
```

--------------------------------

### Post a Memo to Deputy API

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Use this snippet to post a new memo. Ensure the `strContent`, `intCompany`, and `blnRequireConfirm` fields are correctly populated.

```json
{
    "strContent": "Hello, this is a memo",
    "intCompany": 1,
    "blnRequireConfirm": 0
}
```

--------------------------------

### Do a task

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Marks a specific task as completed for the authenticated user.

```APIDOC
## GET /api/v1/my/tasks/{id}/do

### Description
Marks a specific task as completed for the authenticated user.

### Method
GET

### Endpoint
/api/v1/my/tasks/{id}/do

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the task to mark as done.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **field1** (type) - Description
```

--------------------------------

### Add Employee

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Adds a new employee to the system.

```APIDOC
## POST /api/v1/supervise/employee

### Description
Adds a new employee to the system.

### Method
POST

### Endpoint
/api/v1/supervise/employee

### Request Body
- **strFirstName** (string) - Required - The first name of the employee.
- **strLastName** (string) - Required - The last name of the employee.
- **intCompanyId** (integer) - Required - The ID of the company the employee belongs to.
- **intGender** (integer) - Required - The gender of the employee.
- **strCountryCode** (string) - Required - The country code of the employee.
- **strDob** (string) - Required - The date of birth of the employee (YYYY-MM-DD).
- **strStartDate** (string) - Required - The start date of employment (YYYY-MM-DD).
- **strMobilePhone** (string) - Optional - The mobile phone number of the employee.
- **strPayrollId** (string) - Optional - The payroll ID of the employee.
- **fltWeekDayRate** (number) - Optional - The weekday rate of the employee.
```

--------------------------------

### Create a new roster

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Creates a new roster. Note: This endpoint appears to be identical to the 'Publish a roster' endpoint in the provided data.

```APIDOC
## POST /api/v1/supervise/roster/publish

### Description
Creates a new roster. (Note: This endpoint appears to be identical to the 'Publish a roster' endpoint in the provided data.)

### Method
POST

### Endpoint
/api/v1/supervise/roster/publish

### Request Body
- **intMode** (integer) - Required - Mode for creating the roster.
- **blnAllLocationsMode** (integer) - Required - Flag to create for all locations.
- **intRosterArray** (array) - Required - An array of roster IDs to create.

### Request Example
{
    "intMode": 1,
    "blnAllLocationsMode": 1,
    "intRosterArray": [400]
    }
```

--------------------------------

### Create a Memo

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Allows you to create a new memo for a company. It requires the content of the memo, the company ID, and a flag indicating if confirmation is required.

```APIDOC
## POST /api/v1/supervise/memo

### Description
Creates a new memo.

### Method
POST

### Endpoint
/api/v1/supervise/memo

### Request Body
- **strContent** (string) - Required - The content of the memo.
- **intCompany** (integer) - Required - The ID of the company.
- **blnRequireConfirm** (integer) - Required - Flag to indicate if confirmation is required (0 for no, 1 for yes).

### Request Example
```json
{
    "strContent": "Hello, this is a memo",
    "intCompany": 1,
    "blnRequireConfirm": 0
}
```
```

--------------------------------

### PUT Create Department - Deputy API

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Creates a new department. Requires an Authorization header and a JSON body with department details.

```json
{
					"name": "Create a Department",
					"request": {
						"method": "PUT",
						"header": [
							{
								"key": "Authorization",
								"value": "Bearer {{depApiKey}}",
								"type": "text"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n        \"intCompanyId\": 1,\n        \"strOpunitName\": 'Deutsche Bank Park',\n        \"strAddress\": 'Mörfelder Landstraße 362, 60528 Frankfurt am Main',\n        \"strExportName\": 'Fußball',\n        \"intSortOrder\": 0,\n        \"intOpunitType\": 1,\n        \"LocationId\": 1\n    }",
							"options": {
								"raw": {
									"language": "json"
								}
							}
						},
						"url": {
							"raw": "{{depBaseUrl}}/api/v1/supervise/department",
							"host": [
								"{{depBaseUrl}}"
							],
							"path": [
								"api",
								"v1",
								"supervise",
								"department"
							]
						}
					},
					"response": []
				}
```

--------------------------------

### Retrieve Sales Data

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Fetches raw sales metrics for a specified period and area. Ensure the 'depApiKey' and 'depBaseUrl' environment variables are set.

```http
GET {{depBaseUrl}}/api/v2/metrics/raw?areas=1&types=Sales&start=1626203567&end=1657775576
```

--------------------------------

### What locations can I work in

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves a list of locations where the user is authorized to work.

```APIDOC
## GET /api/v1/my/location

### Description
Retrieves a list of locations where the user is authorized to work.

### Method
GET

### Endpoint
/api/v1/my/location

### Headers
- Authorization: Bearer {{depApiKey}}

```

--------------------------------

### Add a location

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Adds a new location to the system.

```APIDOC
## PUT /api/v1/supervise/company

### Description
Adds a new location.

### Method
PUT

### Endpoint
/api/v1/supervise/company

### Headers
- Authorization: Bearer {{depApiKey}}
```

--------------------------------

### Retrieve current system time

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Fetches the current system time. Requires authentication.

```APIDOC
## GET /api/v1/time

### Description
Retrieves the current system time. This endpoint is useful for synchronizing operations or logging.

### Method
GET

### Endpoint
/api/v1/time

### Request Example
```http
GET /api/v1/time HTTP/1.1
Authorization: Bearer {{depApiKey}}
Host: {{depBaseUrl}}

```

### Response
#### Success Response (200)
(Response structure not provided in source)
```

--------------------------------

### Create Company Resource

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Use this endpoint to create a new company resource. Ensure the request body is a valid JSON object with the required fields.

```json
{"strWorkplaceName":"Asims' Avocado's","strWorkplaceCode":"ASI","strAddress":"Ultimo, Sydney","strAddressNotes":"This is an address note","intParentCompany":0,"intIsWorkplace":1,"intIsPayrollEntity":1,"strTimezone":"Australia/Sydney","strPayrollExportCode":"XYZ123"}
```

--------------------------------

### Create Multiple Departments

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Creates multiple departments in a single request.

```APIDOC
## PUT /api/v1/supervise/department/create/

### Description
Creates multiple departments using an array of department details.

### Method
PUT

### Endpoint
/api/v1/supervise/department/create/

### Headers
- Authorization: Bearer {{depApiKey}}

### Request Body
- **arrArea** (array) - Required - An array of department objects to create.
  - Each object should contain:
    - **intCompanyId** (integer) - Required - The ID of the company.
    - **strOpunitName** (string) - Required - The name of the operational unit.
    - **intAddressId** (integer) - Optional - The ID of the address.
    - **strAddress** (string) - Optional - The address of the operational unit.
    - **strExportName** (string) - Optional - The export name for the department.
    - **arrTrainingId** (array) - Optional - An array of training IDs.
    - **intCountry** (integer) - Required - The country ID.
    - **intOpunitType** (integer) - Required - The type of the operational unit.
    - **intSortOrder** (integer) - Optional - The sort order for the department.

### Request Example
{
    "arrArea": [{
        "intCompanyId": 1,
        "strOpunitName": "Stamford Bridge",
        "intAddressId": 172,
        "arrTrainingId": [2],
        "intCountry": 222,
        "intOpunitType": 1
    },
    {
        "intCompanyId": 1,
        "strOpunitName": "Craven Cottage",
        "strAddress": "Moor Ln, Salford M7 3BS, United Kingdom",
        "strExportName": "Project92Ltd",
        "intSortOrder": 0,
        "intCountry": 222,
        "intOpunitType": 1
    }]
}
```

--------------------------------

### Post a Journal Entry via Deputy API

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Submit a new journal entry for an employee. The `strComment` and `intEmployeeId` are required fields.

```json
{
    "strComment": "This is a journal",
    "intEmployeeId": 1
}
```

--------------------------------

### Publish Roster

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Publishes a roster, making it active. This can be done for all locations or specific rosters within an array.

```json
{
    "intMode": 1,
    "blnAllLocationsMode": 1,
    "intRosterArray": [400]
    }
```

--------------------------------

### My address on file

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves the user's primary contact address.

```APIDOC
## GET /api/v1/my/contactaddress

### Description
Retrieves the user's primary contact address.

### Method
GET

### Endpoint
/api/v1/my/contactaddress

### Headers
- Authorization: Bearer {{depApiKey}}

```

--------------------------------

### Invite employee to Deputy

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Sends an invitation to an employee to join Deputy.

```APIDOC
## POST /api/v1/supervise/employee/{{employeeid}}/invite

### Description
Invites an employee to join Deputy.

### Method
POST

### Endpoint
{{depBaseUrl}}/api/v1/supervise/employee/{{employeeid}}/invite
```

--------------------------------

### Create or Update Memo

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

This endpoint is used for creating or updating a memo. It requires an 'Authorization' header and the specific details for the memo in the request body.

```http
PUT {{depBaseUrl}}/api/v1/my/setup/memo
```

--------------------------------

### Who do I work with?

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves a list of the user's colleagues.

```APIDOC
## GET /api/v1/my/colleague

### Description
Retrieves a list of the user's colleagues.

### Method
GET

### Endpoint
/api/v1/my/colleague

### Headers
- Authorization: Bearer {{depApiKey}}

```

--------------------------------

### PUT Create Multiple Departments - Deputy API

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Creates multiple departments in a single request. Requires an Authorization header and a JSON body containing an array of department objects.

```json
{
					"name": "Create Multiple Departments",
					"request": {
						"method": "PUT",
						"header": [
							{
								"key": "Authorization",
								"value": "Bearer {{depApiKey}}",
								"type": "text"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n        \"arrArea\": [{\n            \"intCompanyId\": 1,\n            \"strOpunitName\": \"Stamford Bridge\",\n            \"intAddressId\": 172,\n            \"arrTrainingId\": [2],\n            \"intCountry\": 222,\n            \"intOpunitType\": 1\n        },\n        {\n            \"intCompanyId\": 1,\n            \"strOpunitName\": \"Craven Cottage\",\n            \"strAddress\": \"Moor Ln, Salford M7 3BS, United Kingdom\",\n            \"strExportName\": \"Project92Ltd\",\n            \"intSortOrder\": 0,\n            \"intCountry\": 222,\n            \"intOpunitType\": 1\n        }]\n    }",
							"options": {
								"raw": {
									"language": "json"
								}
							}
						},
						"url": {
							"raw": "{{depBaseUrl}}/api/v1/supervise/department/create/",
							"host": [
								"{{depBaseUrl}}"
							],
							"path": [
								"api",
								"v1",
								"supervise",
								"department",
								"create",
								""
							]
						}
					},
					"response": []
				}
```

--------------------------------

### Retrieve Current System Time

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves the current system time.

```APIDOC
## GET /api/v1/time

### Description
Retrieves the current system time.

### Method
GET

### Endpoint
/api/v1/time

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **field1** (type) - Description
```

--------------------------------

### Add Employee

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Adds a new employee to the system. Requires various details including name, company ID, gender, country code, dates, and payroll information.

```json
{
    "strFirstName": "John",
    "strLastName": "Doe",
    "intCompanyId": 1,
    "intGender": 2,
    "strCountryCode": "AR",
    "strDob": "1971-01-01",
    "strStartDate": "2022-01-01",
    "strMobilePhone": "0441234567",
    "strPayrollId": "1234",
    "fltWeekDayRate": 30
}
```

--------------------------------

### When Am I Next Working

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves the user's upcoming work schedule.

```APIDOC
## GET /api/v1/my/roster

### Description
Retrieves the user's upcoming work schedule.

### Method
GET

### Endpoint
/api/v1/my/roster

### Headers
- Authorization: Bearer {{depApiKey}}

```

--------------------------------

### Invite Employee to Deputy

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Sends an invitation to an employee to join Deputy. Requires the employee ID in the URL.

```json
POST {{depBaseUrl}}/api/v1/supervise/employee/{{employeeid}}/invite
```

--------------------------------

### Search for Employees from a Location

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves employee information based on a search query, specifically filtering by EmployeeId. Requires 'depApiKey' and 'depBaseUrl' environment variables.

```json
{"search":{
    "s1":{ "field": "EmployeeId", "data": 1, "type": "eq"}
}}
```

--------------------------------

### Create Operational Unit

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Use this endpoint to create a new operational unit. Ensure all required fields are provided in the JSON payload.

```json
{
    "intCompanyId": 12,
    "intAddressId": 17,
    "strOpunitName": "Ibrox Stadium",
    "strExportName": "Rangers",
    "arrTrainingId": [1, 2, 3]
}
```

--------------------------------

### Retrieve current system time of a location

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Fetches the current system time for a specific company location. Requires authentication and the company ID.

```APIDOC
## GET /api/v1/time/{{companyid}}

### Description
Retrieves the current system time for a specified company location. Use this endpoint to get time-specific data for a particular company.

### Method
GET

### Endpoint
/api/v1/time/{{companyid}}

### Parameters
#### Path Parameters
- **companyid** (string) - Required - The ID of the company for which to retrieve the time.

### Request Example
```http
GET /api/v1/time/1 HTTP/1.1
Authorization: Bearer {{depApiKey}}
Host: {{depBaseUrl}}

```

### Response
#### Success Response (200)
(Response structure not provided in source)
```

--------------------------------

### Add a webhook (URL)

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Adds a new webhook subscription to receive notifications for specific events. Requires authentication.

```APIDOC
## POST /api/v1/resource/Webhook

### Description
Adds a new webhook to receive event notifications. You can specify the topic, enable/disable the webhook, and provide the URL for receiving events.

### Method
POST

### Endpoint
/api/v1/resource/Webhook

### Request Body
- **Topic** (string) - Required - The event topic to subscribe to (e.g., "Timesheet.Insert").
- **Enabled** (integer) - Required - Indicates if the webhook is enabled (1 for enabled, 0 for disabled).
- **Type** (string) - Required - The type of webhook, typically "URL".
- **Address** (string) - Required - The URL where the webhook events will be sent.

### Request Example
```json
{
    "Topic": "Timesheet.Insert",
    "Enabled": 1,
    "Type": "URL",
    "Address": "https://webhook.site/a90b0a6b-43e9-4755-8bf5-3518980d373a"
}
```

### Response
#### Success Response (200)
(Response structure not provided in source)
```

--------------------------------

### Add Sale to Sales Metrics - POST API Request

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Record a sale in the sales metrics by sending a POST request with sales data, including timestamp, area, type, reference, value, employee, and location. Requires an Authorization header.

```json
{
					"name": "Add a sale to sales metrics",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "Authorization",
								"value": "Bearer {{depApiKey}}",
								"type": "text"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n    \"data\": [\n        {\n            \"timestamp\": 1660272300,\n            \"area\": 2,\n            \"type\": \"Sales\",\n            \"reference\": \"API-Sales-Entry-1660272300\",\n            \"value\": 100.30,\n            \"employee\": 1,\n            \"location\": 1\n        }\n    ]\n}",
							"options": {
								"raw": {
									"language": "json"
								}
							}
						},
						"url": {
							"raw": "{{depBaseUrl}}/api/v2/metrics",
							"host": [
								"{{depBaseUrl}}"
							],
							"path": [
								"api",
								"v2",
								"metrics"
							]
						}
					},
					"response": []
				}
```

--------------------------------

### My address on file including emergency

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves all contact addresses for the user, including emergency contact information.

```APIDOC
## GET /api/v1/my/contactaddress/all

### Description
Retrieves all contact addresses for the user, including emergency contact information.

### Method
GET

### Endpoint
/api/v1/my/contactaddress/all

### Headers
- Authorization: Bearer {{depApiKey}}

```

--------------------------------

### Copy Roster

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Copies an existing roster to a new date range and operational units. Specify the source dates, target operational units, and error detail requirements.

```json
{
    "strFromDate": "2022-07-25",
    "strToDate": "2022-07-28",
    "intOperationalUnitArray": [400],
    "blnRequireErrorDetails": 1
    }
```

--------------------------------

### Search for Unapproved Timesheets

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Searches for timesheets based on specified criteria, joining with 'TimesheetObject'. Requires 'depApiKey' and 'depBaseUrl' environment variables.

```json
{
    "search": {
        "field": "Id",
        "type": "eq",
        "data": 1
    },
    "join": ["TimesheetObject"]
}
```

--------------------------------

### Copy a Roster

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Copies an existing roster to a new date range. Requires specifying the source date range, target operational units, and whether to include error details.

```APIDOC
## POST /api/v1/supervise/roster/copy

### Description
Copies an existing roster to a new date range.

### Method
POST

### Endpoint
/api/v1/supervise/roster/copy

### Request Body
- **strFromDate** (string) - Required - The start date of the roster to copy.
- **strToDate** (string) - Required - The end date of the roster to copy.
- **intOperationalUnitArray** (array) - Required - An array of operational unit IDs to copy the roster to.
- **blnRequireErrorDetails** (integer) - Required - Flag to indicate if error details should be returned.

### Request Example
{
    "strFromDate": "2022-07-25",
    "strToDate": "2022-07-28",
    "intOperationalUnitArray": [400],
    "blnRequireErrorDetails": 1
    }
```

--------------------------------

### Who Am I

Source: https://integrations-directory.prod.dpty.io/postmancollection/Deputy.postman_collection.json

Retrieves the details of the currently logged-in user.

```APIDOC
## GET /api/v1/me

### Description
Retrieves the details of the currently logged-in user.

### Method
GET

### Endpoint
/api/v1/me

### Headers
- Authorization: Bearer {{depApiKey}}

```
Tokens:
Raw