### List or Get Setup

Source: https://developer.deputy.com/reference/my_setup__get

Retrieves setup information for the authenticated employee.

```APIDOC
## GET /my/setup

### Description
Retrieves setup information for the authenticated employee.

### Method
GET

### Endpoint
/my/setup

### Responses
#### Success Response (200)
- **Success**: Indicates the request was successful.

#### Error Responses
- **400**: Bad request
- **401**: Not authenticated
- **403**: Insufficient permissions
- **404**: Not found
```

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

### GET Setup Apps

Source: https://developer.deputy.com/reference/my_setup__apps_get

Retrieves a list of setup applications available in the system.

```APIDOC
## GET /my/setup/apps

### Description
Retrieves a list of setup applications.

### Method
GET

### Endpoint
/my/setup/apps

### Responses
#### Success Response (200)
- **Success** (object) - Indicates a successful retrieval of applications.

#### Response Example
```json
{
  "example": "response body"
}
```

#### Error Responses
- **400** - Bad request
- **401** - Not authenticated
- **403** - Insufficient permissions
- **404** - Not found
```

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

### GET Setup / :action

Source: https://developer.deputy.com/reference/my_setup__gamingfy_action_get

Retrieves setup information for gamingfy based on the provided action. The action parameter can be either 'list' or 'decline'.

```APIDOC
## GET /my/setup/gamingfy/{action}

### Description
Retrieves setup information for gamingfy. This endpoint supports actions such as listing available setups or declining a setup.

### Method
GET

### Endpoint
/my/setup/gamingfy/{action}

### Parameters
#### Path Parameters
- **action** (string) - Required - The action to perform, must be either 'list' or 'decline'.

### Response
#### Success Response (200)
- The response body will contain the requested setup information in JSON format. The exact structure depends on the action performed.

#### Response Example
```json
{
  "example": "response body"
}
```

#### Error Responses
- **400**: Bad request
- **401**: Not authenticated
- **403**: Insufficient permissions
- **404**: Not found
```

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

### GET Timesheet Setup by ID

Source: https://developer.deputy.com/reference/my_timesheet__id_setup_get

Fetches the setup configuration for a given timesheet ID.

```APIDOC
## GET /my/timesheet/{id}/setup

### Description
Retrieves the setup details for a specific timesheet entry.

### Method
GET

### Endpoint
/my/timesheet/{id}/setup

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the timesheet.

### Response
#### Success Response (200)
- **object** - Contains the timesheet setup configuration.

#### Error Responses
- **400** - Bad request
- **401** - Not authenticated
- **403** - Insufficient permissions
- **404** - Not found
```

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

### OpenAPI Definition for GET Setup Apps

Source: https://developer.deputy.com/reference/my_setup__apps_get

This OpenAPI 3.0.0 definition specifies the GET /my/setup/apps endpoint. It includes details on the server URL, authentication methods, and response codes.

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Deputy V1 My API",
    "version": "1.0.0",
    "description": "Generated reference for Deputy's legacy V1 `/supervise/` (supervisor-level operations) and `/my/` (authenticated-employee operations) endpoints.\n\nEnumerated statically from router classes under `deputy-webapp/app/api/v1/routers/Super*Router.php` and `My*Router.php`. V1 is in maintenance mode — new integrations should prefer V2.\n\nThis spec covers only the `/my/*` routes. The sibling family is in a separate ReadMe spec."
  },
  "servers": [
    {
      "url": "https://{subdomain}.{region}.deputy.com/api/v1",
      "description": "Deputy tenant",
      "variables": {
        "subdomain": {
          "default": "your-subdomain"
        },
        "region": {
          "default": "deputy",
          "enum": [
            "au",
            "eu",
            "na",
            "deputy"
          ]
        }
      }
    }
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "OAuth 2.0 access token or Deputy Permanent Token."
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Setup",
      "description": "V1 /my/setup/* endpoints"
    }
  ],
  "paths": {
    "/my/setup/apps": {
      "get": {
        "tags": [
          "Setup"
        ],
        "summary": "GET Setup / apps",
        "operationId": "my_setup__apps_get",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Not authenticated"
          },
          "403": {
            "description": "Insufficient permissions"
          },
          "404": {
            "description": "Not found"
          }
        }
      }
    }
  }
}
```

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

### Get Task Setups

Source: https://developer.deputy.com/reference/bulktasksetup-1

Retrieves a list of task setups. Supports filtering and pagination.

```APIDOC
## GET /task-setups

### Description
Retrieves a list of all task setups. This endpoint is useful for fetching multiple task setup configurations at once.

### Method
GET

### Endpoint
/task-setups

### Query Parameters
- **limit** (integer) - Optional - The maximum number of task setups to return.
- **offset** (integer) - Optional - The number of task setups to skip before starting to collect the result set.

### Responses
#### Success Response (200)
- **description**: Success
- **content**: application/json
  - **schema**: array of TaskSetup objects

#### Error Responses
- **400**: Bad request
- **401**: Authentication required or invalid token
- **403**: Forbidden — token lacks access to this resource
- **404**: Resource not found
```

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

### GET Setup / getStateCountryList

Source: https://developer.deputy.com/reference/my_setup__getstatecountrylist_get

Retrieves a list of countries available for setup. This endpoint is part of the V1 /my/setup/* endpoints and requires authentication.

```APIDOC
## GET /my/setup/getStateCountryList

### Description
Retrieves a list of countries for setup purposes.

### Method
GET

### Endpoint
/my/setup/getStateCountryList

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **(object)** - A JSON object containing country data.

#### Response Example
```json
{
  "example": "response body"
}
```

#### Error Responses
- **400**: Bad request
- **401**: Not authenticated
- **403**: Insufficient permissions
- **404**: Not found
```

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

### Get History Task Setups

Source: https://developer.deputy.com/reference/historytasksetup-1

Retrieves a list of all history task setups.

```APIDOC
## GET /historytasksetup

### Description
Retrieves a list of all history task setups.

### Method
GET

### Endpoint
/historytasksetup

### Responses
#### Success Response (200)
- **body** (array) - A list of TaskSetup objects.

#### Response Example
```json
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "taskType": "string",
    "enabled": true,
    "schedule": {
      "type": "string",
      "cronExpression": "string",
      "interval": "string"
    },
    "createdAt": "string",
    "updatedAt": "string"
  }
]
```

#### Error Responses
- **400** - Bad request
- **401** - Authentication required or invalid token
- **403** - Forbidden — token lacks access to this resource
- **404** - Resource not found
```

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

### Get Task Setup

Source: https://developer.deputy.com/reference/historytasksetuptravel-1

Retrieves the details of a specific task setup. This endpoint allows fetching task setup information based on provided identifiers.

```APIDOC
## GET /tasksetups/{id}

### Description
Retrieves the details of a specific task setup.

### Method
GET

### Endpoint
/tasksetups/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the task setup.

### Responses
#### Success Response (200)
- **TaskSetup** (object) - Details of the task setup.

#### Response Example
```json
{
  "id": 123,
  "name": "Example Task Setup",
  "description": "This is an example task setup.",
  "createdAt": 1678886400,
  "updatedAt": 1678886400
}
```

#### Error Responses
- **400** - Bad request
- **401** - Authentication required or invalid token
- **403** - Forbidden — token lacks access to this resource
- **404** - Resource not found
```

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

### GET Setup / supportAccess

Source: https://developer.deputy.com/reference/my_setup__supportaccess_get

Retrieves the support access configuration. This endpoint is part of the V1 /my/setup/* routes.

```APIDOC
## GET /my/setup/supportAccess

### Description
Retrieves the support access configuration.

### Method
GET

### Endpoint
/my/setup/supportAccess

### Responses
#### Success Response (200)
- **Success** (object) - Indicates a successful retrieval of support access settings.

#### Error Responses
- **400** - Bad request
- **401** - Not authenticated
- **403** - Insufficient permissions
- **404** - Not found
```

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

### GET Setup / supportAccess OpenAPI Definition

Source: https://developer.deputy.com/reference/my_setup__supportaccess_get

This OpenAPI definition describes the GET /my/setup/supportAccess endpoint. It includes details on the server URL, authentication, and possible responses such as success (200), bad request (400), not authenticated (401), insufficient permissions (403), and not found (404).

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Deputy V1 My API",
    "version": "1.0.0",
    "description": "Generated reference for Deputy's legacy V1 `/supervise/` (supervisor-level operations) and `/my/` (authenticated-employee operations) endpoints.\n\nEnumerated statically from router classes under `deputy-webapp/app/api/v1/routers/Super*Router.php` and `My*Router.php`. V1 is in maintenance mode — new integrations should prefer V2.\n\nThis spec covers only the `/my/*` routes. The sibling family is in a separate ReadMe spec."
  },
  "servers": [
    {
      "url": "https://{subdomain}.{region}.deputy.com/api/v1",
      "description": "Deputy tenant",
      "variables": {
        "subdomain": {
          "default": "your-subdomain"
        },
        "region": {
          "default": "deputy",
          "enum": [
            "au",
            "eu",
            "na",
            "deputy"
          ]
        }
      }
    }
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "OAuth 2.0 access token or Deputy Permanent Token."
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Setup",
      "description": "V1 /my/setup/* endpoints"
    }
  ],
  "paths": {
    "/my/setup/supportAccess": {
      "get": {
        "tags": [
          "Setup"
        ],
        "summary": "GET Setup / supportAccess",
        "operationId": "my_setup__supportAccess_get",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Not authenticated"
          },
          "403": {
            "description": "Insufficient permissions"
          },
          "404": {
            "description": "Not found"
          }
        }
      }
    }
  }
}
```

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

### GET Task Setup by Department ID

Source: https://developer.deputy.com/reference/supervise_task__department_deptid_setup_get

Fetches the task setup configuration for a specified department. Requires supervisor-level permissions.

```APIDOC
## GET /supervise/task/department/{deptid}/setup

### Description
Retrieves the task setup details for a specific department.

### Method
GET

### Endpoint
/supervise/task/department/{deptid}/setup

### Parameters
#### Path Parameters
- **deptid** (integer) - Required - The unique identifier of the department.

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **object** - Returns the task setup configuration for the department.

#### Response Example
```json
{
  "example": "response body"
}
```

#### Error Responses
- **400**: Bad request
- **401**: Not authenticated
- **403**: Insufficient permissions
- **404**: Not found
```

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

### GET Leave / (:strSetup)?

Source: https://developer.deputy.com/reference/my_leave__strsetup__get

Fetches leave details for a given setup identifier. This endpoint is part of the V1 /my/leave/* series.

```APIDOC
## GET Leave / (:strSetup)?

### Description
Retrieves leave information for a specific setup.

### Method
GET

### Endpoint
/my/leave/{strSetup}

### Parameters
#### Path Parameters
- **strSetup** (string) - Required - Must match the pattern "^setup$". This parameter specifies the setup for which leave information is requested.

### Response
#### Success Response (200)
- **object** - Success response with leave data.

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### OpenAPI Definition for GET Task / setup

Source: https://developer.deputy.com/reference/supervise_task__department_deptid_setup_get

This OpenAPI 3.0.0 definition details the GET request for the /supervise/task/department/{deptid}/setup endpoint. It specifies the operationId, parameters, and possible responses, including success (200) and error codes (400, 401, 403, 404).

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Deputy V1 Supervise API",
    "version": "1.0.0",
    "description": "Generated reference for Deputy's legacy V1 `/supervise/` (supervisor-level operations) and `/my/` (authenticated-employee operations) endpoints.\n\nEnumerated statically from router classes under `deputy-webapp/app/api/v1/routers/Super*Router.php` and `My*Router.php`. V1 is in maintenance mode — new integrations should prefer V2.\n\nThis spec covers only the `/supervise/*` routes. The sibling family is in a separate ReadMe spec."
  },
  "servers": [
    {
      "url": "https://{subdomain}.{region}.deputy.com/api/v1",
      "description": "Deputy tenant",
      "variables": {
        "subdomain": {
          "default": "your-subdomain"
        },
        "region": {
          "default": "deputy",
          "enum": [
            "au",
            "eu",
            "na",
            "deputy"
          ]
        }
      }
    }
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "OAuth 2.0 access token or Deputy Permanent Token."
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Task",
      "description": "V1 /my/task/* endpoints"
    }
  ],
  "paths": {
    "/supervise/task/department/{deptid}/setup": {
      "get": {
        "tags": [
          "Task"
        ],
        "summary": "GET Task / setup",
        "operationId": "supervise_task__department_deptid_setup_get",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Not authenticated"
          },
          "403": {
            "description": "Insufficient permissions"
          },
          "404": {
            "description": "Not found"
          }
        },
        "parameters": [
          {
            "name": "deptid",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "pattern": "\\d+"
            }
          }
        ]
      }
    }
  }
}
```

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

### POST Setup / :action

Source: https://developer.deputy.com/reference/my_setup__gamingfy_action_post

This endpoint allows you to perform setup actions for gamingfy. The 'action' parameter specifies the operation, and a request body is required.

```APIDOC
## POST /my/setup/gamingfy/{action}

### Description
Performs a setup action for gamingfy. The action can be 'list' or 'decline'.

### Method
POST

### Endpoint
/my/setup/gamingfy/{action}

### Parameters
#### Path Parameters
- **action** (string) - Required - The action to perform, must be 'list' or 'decline'.

#### Request Body
- **object** - Required - The request body is an object.

### Response
#### Success Response (200)
- **object** - Success response.

#### Error Responses
- **400** - Bad request
- **401** - Not authenticated
- **403** - Insufficient permissions
- **404** - Not found
```

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

### Search Task Setup Resources

Source: https://developer.deputy.com/reference/searchtasksetup-1

Allows searching and filtering of Task Setup resources. Supports pagination, sorting, and joining related objects. An empty request body will return the first page of results.

```APIDOC
## POST /resource/TaskSetup

### Description
Searches for Task Setup resources based on provided criteria. Supports filtering, sorting, and pagination.

### Method
POST

### Endpoint
`/resource/TaskSetup`

### Parameters
#### Query Parameters
- **start** (integer) - Optional - Pagination offset (0-indexed).
- **max** (integer) - Optional - Max records per page (server caps at 500).

#### Request Body
- **search** (object) - Optional - Map of search clauses keyed by an arbitrary id. Each clause filters one field.
  - **field** (string) - Required - Field name to filter on (e.g. `Id`, `Employee`).
  - **data** (any) - Required - Comparison value. Type depends on the field.
  - **type** (string) - Required - Comparison operator. Enum: `eq`, `ne`, `gt`, `lt`, `ge`, `le`, `is`, `is not`, `in`, `not in`, `starts`, `contains`.
- **sort** (object) - Optional - Map of field name → `asc` or `desc`.
- **join** (array) - Optional - Related ORMs to expand inline (e.g. `["EmployeeObject"]`).

### Request Example
```json
{
  "search": {
    "s1": {
      "field": "Id",
      "data": 1,
      "type": "ge"
    }
  },
  "max": 100
}
```

### Response
#### Success Response (200)
- **Id** (integer) - Unique identifier for the task setup.
- **GroupId** (integer) - Identifier for the group the task setup belongs to.
- **Type** (integer) - Type of the task setup.
- **Parent** (integer) - Identifier of the parent task setup, if any.
- **Question** (string) - The question associated with the task setup.
- **Default** (string) - Default answer for the task setup.
- **SortOrder** (integer) - Order in which the task setup should be displayed.
- **Schedule** (integer) - Scheduling information for the task setup.
- **OnYes** (string) - Action to take if the answer is 'yes'.
```

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

### List Task Setup

Source: https://developer.deputy.com/reference/listtasksetup-1

Retrieves a list of task setup configurations. Supports filtering and pagination.

```APIDOC
## GET /task-setup

### Description
Retrieves a list of task setup configurations. This endpoint allows for filtering by status and pagination.

### Method
GET

### Endpoint
/task-setup

### Query Parameters
- **status** (string) - Optional - Filters the task setups by their status (e.g., 'active', 'inactive').
- **page** (integer) - Optional - Specifies the page number for pagination. Defaults to 1.
- **pageSize** (integer) - Optional - Specifies the number of items per page. Defaults to 20.

### Response
#### Success Response (200)
- **data** (array) - An array of task setup objects.
  - **id** (string) - The unique identifier for the task setup.
  - **name** (string) - The name of the task setup.
  - **status** (string) - The current status of the task setup.
  - **createdAt** (string) - The timestamp when the task setup was created.
  - **updatedAt** (string) - The timestamp when the task setup was last updated.
- **pagination** (object) - Pagination details.
  - **currentPage** (integer) - The current page number.
  - **totalPages** (integer) - The total number of pages.
  - **totalItems** (integer) - The total number of items available.

#### Response Example
```json
{
  "data": [
    {
      "id": "ts_12345",
      "name": "Default Task Setup",
      "status": "active",
      "createdAt": "2023-10-27T10:00:00Z",
      "updatedAt": "2023-10-27T10:00:00Z"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalPages": 1,
    "totalItems": 1
  }
}
```

#### Error Response (400)
- **error** (string) - Description of the bad request.

#### Error Response (401)
- **error** (string) - Indicates authentication is required or the token is invalid.

#### Error Response (403)
- **error** (string) - Indicates the token lacks access to this resource.

#### Error Response (404)
- **error** (string) - Indicates the resource was not found.
```

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

### Get Task Setup by ID

Source: https://developer.deputy.com/reference/gettasksetupbyid-1

Retrieves the configuration details for a specific task setup using its ID.

```APIDOC
## GET /tasksetup/{id}

### Description
Retrieves the configuration details for a specific task setup using its ID.

### Method
GET

### Endpoint
/tasksetup/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the task setup.

### Response
#### Success Response (200)
- **TaskSetup** (object) - The task setup configuration details.

#### Error Responses
- **400** - Bad request
- **401** - Authentication required or invalid token
- **403** - Forbidden — token lacks access to this resource
- **404** - Resource not found
```

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

### Create Task Setup

Source: https://developer.deputy.com/reference/createtasksetup-1

This endpoint allows for the creation of a new task setup. It requires specific parameters to define the task's configuration.

```APIDOC
## POST /tasksetup

### Description
Creates a new task setup with the provided configuration.

### Method
POST

### Endpoint
/tasksetup

### Request Body
- **name** (string) - Required - The name of the task setup.
- **description** (string) - Optional - A detailed description of the task setup.
- **config** (object) - Required - The configuration object for the task setup.
  - **type** (string) - Required - The type of task configuration.
  - **settings** (object) - Optional - Specific settings for the task type.

### Request Example
```json
{
  "name": "Example Task Setup",
  "description": "This is a sample task setup for demonstration purposes.",
  "config": {
    "type": "data_processing",
    "settings": {
      "input_format": "csv",
      "output_format": "json"
    }
  }
}
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier for the created task setup.
- **name** (string) - The name of the task setup.
- **description** (string) - The description of the task setup.
- **config** (object) - The configuration object.
- **createdAt** (string) - The timestamp when the task setup was created.

#### Response Example
```json
{
  "id": "ts-12345",
  "name": "Example Task Setup",
  "description": "This is a sample task setup for demonstration purposes.",
  "config": {
    "type": "data_processing",
    "settings": {
      "input_format": "csv",
      "output_format": "json"
    }
  },
  "createdAt": "2023-10-27T10:00:00Z"
}
```

#### Error Response (400)
- **error** (string) - Description of the bad request.

#### Error Response (401)
- **error** (string) - Authentication required or invalid token.

#### Error Response (403)
- **error** (string) - Forbidden — token lacks access to this resource.

#### Error Response (404)
- **error** (string) - Resource not found.
```

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

### Create Employee Setup

Source: https://developer.deputy.com/reference/employeesv2controller_create

This endpoint allows for the creation of a new employee setup.

```APIDOC
## POST /management/v2/employees

### Description
Create an employee setup.

### Method
POST

### Endpoint
/management/v2/employees

### Request Body
- **schema** (object) - Required - The schema for the employee creation request.

### Request Example
```json
{
  "login": "johndoe",
  "pin": 1234,
  "sendInvite": true,
  "sendOnlyKioskInfo": false,
  "partnerUserId": "ext-123"
}
```

### Response
#### Success Response (200)
- **description** (string) - A successful response.
- **content** (object) - The content of the response, including the schema for the created employee.

#### Response Example
```json
{
  "employeeId": "emp-abc-123",
  "createdAt": "2023-10-27T10:00:00Z",
  "modifiedAt": "2023-10-27T10:00:00Z"
}
```
```

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

### GET Timesheet by Start Timestamp, Reverse, and Limit

Source: https://developer.deputy.com/reference/my_timesheet__starttimestamp_starttimestamp_reverse_reverse_limit_limit_get

Retrieves timesheet entries starting from a specific timestamp, ordered in reverse, and limited to a certain number of results.

```APIDOC
## GET /my/timesheet/startTimestamp/{startTimestamp}/reverse/{reverse}/limit/{limit}

### Description
Retrieves timesheet entries starting from a specific timestamp, ordered in reverse, and limited to a certain number of results.

### Method
GET

### Endpoint
/my/timesheet/startTimestamp/{startTimestamp}/reverse/{reverse}/limit/{limit}

### Parameters
#### Path Parameters
- **startTimestamp** (string) - Required - The starting timestamp for filtering timesheet entries.
- **reverse** (string) - Required - Specifies the order of results. Use 'true' for reverse chronological order.
- **limit** (string) - Required - The maximum number of timesheet entries to return.

#### Response
#### Success Response (200)
- **object** (object) - A JSON object containing the timesheet data.

#### Response Example
{
  "example": "response body"
}
```

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

### GET Leave / :strSetup

Source: https://developer.deputy.com/reference/supervise_leave__intemployeeid_strsetup_get

Retrieves the leave setup details for a given employee.

```APIDOC
## GET /supervise/leave/{intEmployeeId}/{strSetup}

### Description
Retrieves the leave setup configuration for a specific employee.

### Method
GET

### Endpoint
/supervise/leave/{intEmployeeId}/{strSetup}

### Parameters
#### Path Parameters
- **intEmployeeId** (integer) - Required - The ID of the employee.
- **strSetup** (string) - Required - Must be the literal string "setup".

### Response
#### Success Response (200)
- **object** (object) - Contains the leave setup details.

#### Error Responses
- **400** - Bad request
- **401** - Not authenticated
- **403** - Insufficient permissions
- **404** - Not found
```

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

### POST Task / apply

Source: https://developer.deputy.com/reference/supervise_task__department_deptid_setup_apply_post

Applies the task setup for a given department ID.

```APIDOC
## POST /supervise/task/department/{deptid}/setup/apply

### Description
Applies the task setup for a given department ID.

### Method
POST

### Endpoint
/supervise/task/department/{deptid}/setup/apply

### Parameters
#### Path Parameters
- **deptid** (integer) - Required - The ID of the department for which to apply the task setup.

### Request Body
- **(object)** - Required - The request body schema is an object.

### Response
#### Success Response (200)
- **(object)** - Success response.

#### Error Responses
- **400** - Bad request
- **401** - Not authenticated
- **403** - Insufficient permissions
- **404** - Not found
```

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

### POST Setup / sf

Source: https://developer.deputy.com/reference/my_setup__sf_post

This endpoint allows for the configuration of 'sf' settings. It requires a JSON request body and returns a success message upon completion.

```APIDOC
## POST /my/setup/sf

### Description
Allows for the configuration of 'sf' settings.

### Method
POST

### Endpoint
/my/setup/sf

### Request Body
- **(object)** - Required - The configuration object for 'sf'.

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

### Response
#### Success Response (200)
- **(object)** - Success message.

#### Response Example
```json
{
  "example": "response body"
}
```
```

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

### OpenAPI Definition for GET Timesheet

Source: https://developer.deputy.com/reference/my_timesheet__start_end__get

This OpenAPI 3.0.0 definition outlines the GET request for the `/my/timesheet/{start}/{end}` endpoint. It specifies the parameters, expected responses, and security schemes.

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Deputy V1 My API",
    "version": "1.0.0",
    "description": "Generated reference for Deputy's legacy V1 `/supervise/` (supervisor-level operations) and `/my/` (authenticated-employee operations) endpoints.\n\nEnumerated statically from router classes under `deputy-webapp/app/api/v1/routers/Super*Router.php` and `My*Router.php`. V1 is in maintenance mode — new integrations should prefer V2.\n\nThis spec covers only the `/my/*` routes. The sibling family is in a separate ReadMe spec."
  },
  "servers": [
    {
      "url": "https://{subdomain}.{region}.deputy.com/api/v1",
      "description": "Deputy tenant",
      "variables": {
        "subdomain": {
          "default": "your-subdomain"
        },
        "region": {
          "default": "deputy",
          "enum": [
            "au",
            "eu",
            "na",
            "deputy"
          ]
        }
      }
    }
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "OAuth 2.0 access token or Deputy Permanent Token."
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Timesheet",
      "description": "V1 /my/timesheet/* endpoints"
    }
  ],
  "paths": {
    "/my/timesheet/{start}/{end}": {
      "get": {
        "tags": [
          "Timesheet"
        ],
        "summary": "GET Timesheet / :end)?",
        "operationId": "my_timesheet__start_end__get",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Not authenticated"
          },
          "403": {
            "description": "Insufficient permissions"
          },
          "404": {
            "description": "Not found"
          }
        },
        "parameters": [
          {
            "name": "start",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "pattern": "[0-9]{2,4}\-[0-9]{1,2}\-[0-9]{1,2}"
            }
          },
          {
            "name": "end",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "pattern": "[0-9]{2,4}\-[0-9]{1,2}\-[0-9]{1,2}"
            }
          }
        ]
      }
    }
  }
}
```

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

### Create or Replace Task Setup

Source: https://developer.deputy.com/reference/createorreplacetasksetup-1

This endpoint allows for the creation of a new task setup or the replacement of an existing one. It defines the structure for task setup objects and outlines possible HTTP responses.

```APIDOC
## POST /tasksetup

### Description
Creates or replaces a task setup.

### Method
POST

### Endpoint
/tasksetup

### Request Body
- **taskSetup** (object) - Required - The task setup object to be created or replaced. See components/schemas/TaskSetup for details.

### Response
#### Success Response (200)
- **taskSetup** (object) - Description of the created or replaced task setup.

#### Error Responses
- **400** - Bad request
- **401** - Authentication required or invalid token
- **403** - Forbidden — token lacks access to this resource
- **404** - Resource not found
```

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

### OpenAPI Definition for GET Timesheet Setup

Source: https://developer.deputy.com/reference/supervise_timesheet__id_setup_get

This JSON object defines the OpenAPI 3.0 specification for the `/supervise/timesheet/{id}/setup` GET endpoint. It includes details on parameters, security schemes, and responses.

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Deputy V1 Supervise API",
    "version": "1.0.0",
    "description": "Generated reference for Deputy's legacy V1 `/supervise/` (supervisor-level operations) and `/my/` (authenticated-employee operations) endpoints.\n\nEnumerated statically from router classes under `deputy-webapp/app/api/v1/routers/Super*Router.php` and `My*Router.php`. V1 is in maintenance mode — new integrations should prefer V2.\n\nThis spec covers only the `/supervise/*` routes. The sibling family is in a separate ReadMe spec."
  },
  "servers": [
    {
      "url": "https://{subdomain}.{region}.deputy.com/api/v1",
      "description": "Deputy tenant",
      "variables": {
        "subdomain": {
          "default": "your-subdomain"
        },
        "region": {
          "default": "deputy",
          "enum": [
            "au",
            "eu",
            "na",
            "deputy"
          ]
        }
      }
    }
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "OAuth 2.0 access token or Deputy Permanent Token."
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Timesheet",
      "description": "V1 /my/timesheet/* endpoints"
    }
  ],
  "paths": {
    "/supervise/timesheet/{id}/setup": {
      "get": {
        "tags": [
          "Timesheet"
        ],
        "summary": "GET Timesheet / setup",
        "operationId": "supervise_timesheet__id_setup_get",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Not authenticated"
          },
          "403": {
            "description": "Insufficient permissions"
          },
          "404": {
            "description": "Not found"
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "pattern": "\\d+"
            }
          }
        ]
      }
    }
  }
}
```

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

### OpenAPI Definition for POST Setup / :action

Source: https://developer.deputy.com/reference/my_setup__gamingfy_action_post

This OpenAPI 3.0.0 definition outlines the structure and parameters for the POST /my/setup/gamingfy/{action} endpoint. It specifies the request body, path parameters, and possible responses, including success (200) and error codes (400, 401, 403, 404).

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Deputy V1 My API",
    "version": "1.0.0",
    "description": "Generated reference for Deputy's legacy V1 `/supervise/` (supervisor-level operations) and `/my/` (authenticated-employee operations) endpoints.\n\nEnumerated statically from router classes under `deputy-webapp/app/api/v1/routers/Super*Router.php` and `My*Router.php`. V1 is in maintenance mode — new integrations should prefer V2.\n\nThis spec covers only the `/my/*` routes. The sibling family is in a separate ReadMe spec."
  },
  "servers": [
    {
      "url": "https://{subdomain}.{region}.deputy.com/api/v1",
      "description": "Deputy tenant",
      "variables": {
        "subdomain": {
          "default": "your-subdomain"
        },
        "region": {
          "default": "deputy",
          "enum": [
            "au",
            "eu",
            "na",
            "deputy"
          ]
        }
      }
    }
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "OAuth 2.0 access token or Deputy Permanent Token."
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Setup",
      "description": "V1 /my/setup/* endpoints"
    }
  ],
  "paths": {
    "/my/setup/gamingfy/{action}": {
      "post": {
        "tags": [
          "Setup"
        ],
        "summary": "POST Setup / :action",
        "operationId": "my_setup__gamingfy_action_post",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Not authenticated"
          },
          "403": {
            "description": "Insufficient permissions"
          },
          "404": {
            "description": "Not found"
          }
        },
        "parameters": [
          {
            "name": "action",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "pattern": "(list|decline)"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              }
            }
          }
        }
      }
    }
  }
}
```

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

### Basic Search Query Example

Source: https://developer.deputy.com/reference/searchcategory-1

This example demonstrates a simple search query using the 'eq' (equals) operator for the 'Id' field. The body supports 'search', 'sort', 'start', 'max', and 'join' clauses.

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