# Zoho Workely Integration via LowCodeAPI

## Overview

Team collaboration

## Base Endpoint

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

## Authentication

LowCodeAPI handles authentication automatically. You only need to:

1. **Sign up** at [Zoho Workely](https://www.zoho.com/workerly/)
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

- **Meta Data API** - 4 endpoints
- **Records** - 6 endpoints

## Common Endpoints

### Category: Meta Data API

#### Fields

**Method**: `GET` | **LowCodeAPI Path**: `/workelry/v2/settings/fields`

**Full URL**:
```
https://api.lowcodeapi.com/zohoworkely/workelry/v2/settings/fields?module={module}&api_token={api_token}
```

**Description**: Retrieve information about the fields

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module` | string | No | Specify the API name of the required module |

---

#### Layouts

**Method**: `GET` | **LowCodeAPI Path**: `/workerly/v2/settings/layouts/module_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohoworkely/workerly/v2/settings/layouts/module_id?module={module}&api_token={api_token}
```

**Description**: Get layouts for a specific module

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module` | string | No | Specify the API name of the required module. For example, Temps, Contacts, Clients, Jobs and so on |

---

#### Custom Views Meta Data

**Method**: `GET` | **LowCodeAPI Path**: `/workerly/v2/settings/modules/module_api_name`

**Full URL**:
```
https://api.lowcodeapi.com/zohoworkely/workerly/v2/settings/modules/module_api_name?module={module}&api_token={api_token}
```

**Description**: Get the custom views data of a particular module

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module` | string | No | Specify the API name of the required module. For example, Temps, Contacts, Clients, and so on |

---

#### Related Lists Meta Data

**Method**: `GET` | **LowCodeAPI Path**: `/workerly/v2/settings/related_lists`

**Full URL**:
```
https://api.lowcodeapi.com/zohoworkely/workerly/v2/settings/related_lists?module={module}&api_token={api_token}
```

**Description**: Get the related list data of a particular module

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module` | string | No | Specify the API name of the required module. For example, Temps, Contacts, Clients, Timesheets and so on |

---

### Category: Records

#### Get Records

**Method**: `GET` | **LowCodeAPI Path**: `/workerly/v2/module_api_name`

**Full URL**:
```
https://api.lowcodeapi.com/zohoworkely/workerly/v2/module_api_name?fields={fields}&sort_order={sort_order}&sort_by={sort_by}&converted={converted}&approved={approved}&page={page}&per_page={per_page}&cvid={cvid}&territory_id={territory_id}&include_child={include_child}&api_token={api_token}
```

**Description**: TO get the list of available records from a module

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`fields` | string | No | To list all the module records with respect to fields |
|`sort_order` | string | No | To sort the available list of records in either ascending or descending order |
|`sort_by` | string | No | To sort the available list of records based on the given field |
|`converted` | string | No | To get the list of converted records |
|`approved` | string | No | To get the list of approved records |
|`page` | number | No | To get the list of records from the respective pages |
|`per_page` | number | No | To get the list of records available per page |
|`cvid` | number | No | To get the list of records based on custom views |
|`territory_id` | number | No | To get the list of records based on the territory |
|`include_child` | boolean | No | To include records from the child territories |

---

#### Insert Records

**Method**: `POST` | **LowCodeAPI Path**: `/workerly/v2/module_api_name`

**Full URL**:
```
https://api.lowcodeapi.com/zohoworkely/workerly/v2/module_api_name?api_token={api_token}
```

**Description**: To add new entities to a module

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

---

#### Update Records

**Method**: `PUT` | **LowCodeAPI Path**: `/workerly/v2/module_api_name`

**Full URL**:
```
https://api.lowcodeapi.com/zohoworkely/workerly/v2/module_api_name?api_token={api_token}
```

**Description**: To update existing entities in the module

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

---

#### Delete Records

**Method**: `DELETE` | **LowCodeAPI Path**: `/workerly/v2/module_api_name`

**Full URL**:
```
https://api.lowcodeapi.com/zohoworkely/workerly/v2/module_api_name?ids={ids}&wf_trigger={wf_trigger}&api_token={api_token}
```

**Description**: To delete entities or records from a module

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ids` | number | No | Specify the unique ID of the record |
|`wf_trigger` | boolean | No | Represents if the workflow rules are to be triggered upon record deletion |

---

#### List of Deleted Records

**Method**: `GET` | **LowCodeAPI Path**: `/workerly/v2/module_api_name/deleted`

**Full URL**:
```
https://api.lowcodeapi.com/zohoworkely/workerly/v2/module_api_name/deleted?module ={module }&type={type}&page={page}&per_page={per_page}&api_token={api_token}
```

**Description**: To get the list of deleted records

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module ` | string | No | Specify the module API name |
|`type` | string | No | To get the list of all deleted records Recycle |
|`page` | number | No | To get the list of records from the respective pages |
|`per_page` | number | No | To get the list of records available per page |

---

#### Search Records

**Method**: `GET` | **LowCodeAPI Path**: `/workerly/v2/module_api_name/search`

**Full URL**:
```
https://api.lowcodeapi.com/zohoworkely/workerly/v2/module_api_name/search?criteria={criteria}&email={email}&phone={phone}&word={word}&converted={converted}&approved={approved}&page={page}&per_page={per_page}&api_token={api_token}
```

**Description**: To retrieve the records that match your search criteria

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`criteria` | string | No | You can search for a maximum of 10 criteria (with same or different columns) with equals and starts_with conditions |
|`email` | string | No | Performs module search by email. All the email fields of a particular module will be searched and listed |
|`phone` | string | No | Performs module search by phone number. All the phone fields of a particular module will be searched and listed |
|`word` | string | No | Performs global search by word |
|`converted` | string | No | To get the list of converted records. Default value is false |
|`approved` | string | No | To get the list of approved records. Default value is true |
|`page` | number | No | To get the list of records from the respective pages |
|`per_page` | number | No | To get the list of records available per page |

---

## Complete Endpoint Reference

For a complete list of all 10 endpoints, refer to:
- **OpenAPI Definition**: `https://backend.lowcodeapi.com/zohoworkely/definition`
- **Official Provider Documentation**: https://www.zoho.com/workerly/developer-guide/whats-new.html