# Zoho Assist Integration via LowCodeAPI

## Overview

Remote support

## Base Endpoint

```
https://api.lowcodeapi.com/zohoassist/
```

## Authentication

LowCodeAPI handles authentication automatically. You only need to:

1. **Sign up** at [Zoho Assist](https://www.zoho.com/assist)
2. **Get your credentials** from [credential page](https://accounts.zoho.com/developerconsole)
3. **Connect your account** in LowCodeAPI dashboard
4. **Use your `api_token`** in all requests

**Auth Type**: OAUTH2.0

## API Categories

- **Computers** - 4 endpoints
- **Groups** - 4 endpoints
- **Reports** - 1 endpoints
- **Session** - 3 endpoints
- **Users** - 1 endpoints

## Common Endpoints

### Category: Computers

#### Get Device Details

**Method**: `GET` | **LowCodeAPI Path**: `/api/v2/devices/resource_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoassist/api/v2/devices/resource_id?api_token={api_token}
```

**Description**: This API returns the device details

---

#### Get Unattended Computer

**Method**: `GET` | **LowCodeAPI Path**: `/api/v2/devices`

**Full URL**:
```
https://api.lowcodeapi.com/zohoassist/api/v2/devices?index={index}&count={count}&include={include}&recent={recent}&favorites={favorites}&sort_by={sort_by}&is_ascending={is_ascending}&resource_type={resource_type}&group_ids={group_ids}&device_status={device_status}&installation_status={installation_status}&os_platforms={os_platforms}&os_names={os_names}&os_versions={os_versions}&domain_ids={domain_ids}&display_name={display_name}&device_name={device_name}&public_ip={public_ip}&private_ip={private_ip}&agent_version={agent_version}&computer_full_name={computer_full_name}&os_platform={os_platform}&os_name={os_name}&os_version={os_version}&domain_name={domain_name}&manufacturer={manufacturer}&product={product}&api_token={api_token}
```

**Description**: This API returns the list of devices in the given department

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`index` | number | No | Position of computer in the list |
|`count` | number | No | Number of records to be given in the response |
|`include` | string | No | The details to be included in response |
|`recent` | Boolean | No | Returns only recently connected devices |
|`favorites` | Boolean | No | Returns only favorite devices |
|`sort_by` | string | No | The column by which the data must be sorted |
|`is_ascending` | Boolean | No | Sort direction |
|`resource_type` | number | No | Only computers |
|`group_ids` | string | No | Groups Ids for filtering devices |
|`device_status` | string | No | Device status |
|`installation_status` | string | No | Installation status |
|`os_platforms` | string | No | Os platforms |
|`os_names` | string | No | Os names |
|`os_versions` | string | No | Os versions |
|`domain_ids` | string | No | Domain ids |
|`display_name` | string | No | Display name |
|`device_name` | string | No | Device name |
|`public_ip` | string | No | Public ip |
|`private_ip` | string | No | Private ip |
|`agent_version` | string | No | Agent version |
|`computer_full_name` | string | No | Computer full name |
|`os_platform` | string | No | Os platform |
|`os_name` | string | No | Os name |
|`os_version` | string | No | Os version |
|`domain_name` | string | No | Domain name |
|`manufacturer` | string | No | Manufacturer |
|`product` | string | No | Manufacturer |

---

#### Update Unattended Computer

**Method**: `PUT` | **LowCodeAPI Path**: `/api/v2/devices/resource_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoassist/api/v2/devices/resource_id?api_token={api_token}
```

**Description**: This API is used to update the display name of the device

**Request Body**:
```json
{
  "display_name": "<string>"
}
```

---

#### Delete Unattended Computer

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v2/devices/resource_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoassist/api/v2/devices/resource_id?api_token={api_token}
```

**Description**: This API is used to delete the device

---

### Category: Groups

#### Get Unattended Groups

**Method**: `GET` | **LowCodeAPI Path**: `/api/v2/unattended_computer/group`

**Full URL**:
```
https://api.lowcodeapi.com/zohoassist/api/v2/unattended_computer/group?q={q}&department_id={department_id}&api_token={api_token}
```

**Description**: This API fetches the details of existing groups in Zoho Assist

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`q` | string | No | The Name of the Unattended Group |
|`department_id` | number | Yes | Department in which the group is created |

---

#### Create Unattended Groups

**Method**: `POST` | **LowCodeAPI Path**: `/api/v2/unattended_computer/group`

**Full URL**:
```
https://api.lowcodeapi.com/zohoassist/api/v2/unattended_computer/group?api_token={api_token}
```

**Description**: This API allows you to create a new group in Zoho Assist

**Request Body**:
```json
{
  "department_id": "<number>",
  "group_name": "<string>",
  "description": "<string>"
}
```

---

#### Update Unattended Groups

**Method**: `PUT` | **LowCodeAPI Path**: `/api/v2/unattended_computer/group`

**Full URL**:
```
https://api.lowcodeapi.com/zohoassist/api/v2/unattended_computer/group?api_token={api_token}
```

**Description**: Using this API, you can update the existing group details

**Request Body**:
```json
{
  "id": "<string>",
  "department_id ": "<string>"
}
```

---

#### Delete Unattended Groups

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v2/unattended_computer/group`

**Full URL**:
```
https://api.lowcodeapi.com/zohoassist/api/v2/unattended_computer/group?api_token={api_token}
```

**Description**: Delete the existing unattended computer groups using this API

---

### Category: Reports

#### Get Session Reports

**Method**: `GET` | **LowCodeAPI Path**: `/api/v2/reports`

**Full URL**:
```
https://api.lowcodeapi.com/zohoassist/api/v2/reports?type={type}&fromdate={fromdate}&todate={todate}&email={email}&index={index}&count={count}&api_token={api_token}
```

**Description**: This API fetches you the reports of previously conducted sessions

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`type` | string | Yes | Session type |
|`fromdate` | number | Yes | Fromdate |
|`todate` | number | Yes | Todate |
|`email` | string | No | To fetch reports conducted by specific technician |
|`index` | string | No | Index of the record |
|`count` | string | No | Number of rows per page |

---

### Category: Session

#### Create a session

**Method**: `POST` | **LowCodeAPI Path**: `/api/v2/session`

**Full URL**:
```
https://api.lowcodeapi.com/zohoassist/api/v2/session?api_token={api_token}
```

**Description**: This API allows you to create a remote support or screen sharing session

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Schedule Session

**Method**: `POST` | **LowCodeAPI Path**: `/api/v2/session/schedule`

**Full URL**:
```
https://api.lowcodeapi.com/zohoassist/api/v2/session/schedule?api_token={api_token}
```

**Description**: Using this API, you can schedule a remote support sessions

**Request Body**:
```json
{
  "mode": "<string>",
  "title": "<string>",
  "customer_email": "<string>",
  "schedule_time": "<string>",
  "utc_offset": "<string>",
  "time_zone": "<string>",
  "reminder": "<string>",
  "department_id": "<string>"
}
```

---

#### Unattended Session

**Method**: `POST` | **LowCodeAPI Path**: `/api/v2/unattended/resource_id/connect`

**Full URL**:
```
https://api.lowcodeapi.com/zohoassist/api/v2/unattended/resource_id/connect?api_token={api_token}
```

**Description**: This API allows you to create an unattended remote session

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`resource_id` | number | Yes | The resource id of the device with which the session is to be created |

**Request Body**:
```json
{
  "department_id": "<number>"
}
```

---

### Category: Users

#### Get User Info

**Method**: `GET` | **LowCodeAPI Path**: `/api/v2/user`

**Full URL**:
```
https://api.lowcodeapi.com/zohoassist/api/v2/user?api_token={api_token}
```

**Description**: This API fetches the details of an existing user in Zoho Assist

---

## Complete Endpoint Reference

For a complete list of all 13 endpoints, refer to:
- **OpenAPI Definition**: `https://backend.lowcodeapi.com/zohoassist/definition`
- **Official Provider Documentation**: https://www.zoho.com/assist/api/introduction.html