# Zoho Workely Integration via LowCodeAPI

**Last Updated**: February 10, 2026

## Overview
Team collaboration

**Categories:**
- {'id': 'zoho-suite', 'name': 'Zoho Suite'}

## Base Endpoint
https://api.lowcodeapi.com/zohoworkely

**Important**: Always include the provider name in the URL path after `api.lowcodeapi.com/`

## Authentication
**Type:** OAUTH2.0

**Official Documentation:** https://www.zoho.com/workerly/developer-guide/whats-new.html

## URL Format (Important)

LowCodeAPI supports two URL formats. **Always try the New Format first**, then fall back to Old Format if needed.

### New Format (Priority)
- Path parameters stay in the URL path
- Do NOT include path parameters as query parameters
- Example: `https://api.lowcodeapi.com/{provider}/resource/{id}?api_token=XXX`

### Old Format (Fallback)
- Path parameters become query parameters
- Example: `https://api.lowcodeapi.com/{provider}/resource/id?id={id}&api_token=XXX`

### Decision Flow for AI Agents
1. Always use **New Format** first - keep path parameters in the URL path
2. If you get a 404 or error, try **Old Format** with sanitized path
3. Log which format worked for future requests to this provider

## API Categories

## Common Endpoints

### Fields

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

**New Format URL:**
https://api.lowcodeapi.com/zohoworkely/workelry/v2/settings/fields?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/zohoworkely/workelry/v2/settings/fields?api_token=YOUR_API_TOKEN

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| module | string |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/zohoworkely/workelry/v2/settings/fields?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://www.zoho.com/workerly/developer-guide/field-meta.html

### Layouts

**Method:** GET
**LowCodeAPI Path:** /workerly/v2/settings/layouts/{module_id}

**New Format URL:**
https://api.lowcodeapi.com/zohoworkely/workerly/v2/settings/layouts/{module_id}?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/zohoworkely/workerly/v2/settings/layouts/module_id?api_token=YOUR_API_TOKEN

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| module | string |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/zohoworkely/workerly/v2/settings/layouts/{module_id}?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://www.zoho.com/workerly/developer-guide/layouts-meta.html

### Custom Views Meta Data

**Method:** GET
**LowCodeAPI Path:** /workerly/v2/settings/modules/{module_api_name}

**New Format URL:**
https://api.lowcodeapi.com/zohoworkely/workerly/v2/settings/modules/{module_api_name}?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/zohoworkely/workerly/v2/settings/modules/module_api_name?api_token=YOUR_API_TOKEN

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| module | string |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/zohoworkely/workerly/v2/settings/modules/{module_api_name}?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://www.zoho.com/workerly/developer-guide/custom-view-meta.html

### Related Lists Meta Data

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

**New Format URL:**
https://api.lowcodeapi.com/zohoworkely/workerly/v2/settings/related_lists?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/zohoworkely/workerly/v2/settings/related_lists?api_token=YOUR_API_TOKEN

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| module | string |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/zohoworkely/workerly/v2/settings/related_lists?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://www.zoho.com/workerly/developer-guide/related-list-meta.html

### Get Records

**Method:** GET
**LowCodeAPI Path:** /workerly/v2/{module_api_name}

**New Format URL:**
https://api.lowcodeapi.com/zohoworkely/workerly/v2/{module_api_name}?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/zohoworkely/workerly/v2/module_api_name?api_token=YOUR_API_TOKEN

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| approved | string |  |
| converted | string |  |
| cvid | number |  |
| fields | string |  |
| include_child | boolean |  |
| page | number |  |
| per_page | number |  |
| sort_by | string |  |
| sort_order | string |  |
| territory_id | number |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/zohoworkely/workerly/v2/{module_api_name}?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://www.zoho.com/workerly/developer-guide/get-records.html

### Insert Records

**Method:** POST
**LowCodeAPI Path:** /workerly/v2/{module_api_name}

**New Format URL:**
https://api.lowcodeapi.com/zohoworkely/workerly/v2/{module_api_name}?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/zohoworkely/workerly/v2/module_api_name?api_token=YOUR_API_TOKEN

**Request Body:**

| Field | Type | Description |
|-------|------|-------------|
| Checkbox | boolean |  |
| Currency | number |  |
| Date | string |  |
| Date/time | string |  |
| Decimal | number |  |
| Email | string |  |
| Long Integer | string |  |
| Lookup | object |  |
| Multi-Line | string |  |
| Multi-Select Picklist | array |  |
| Multi-select lookup | object |  |
| Number | number |  |
| Percent | number |  |
| Phone | string |  |
| Picklist | string |  |
| Single Line | string |  |
| URL | string |  |
| User | object |  |

**Example Request (New Format):**

```bash
curl -X POST 'https://api.lowcodeapi.com/zohoworkely/workerly/v2/{module_api_name}?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://www.zoho.com/workerly/developer-guide/insert-records.html

### Update Records

**Method:** PUT
**LowCodeAPI Path:** /workerly/v2/{module_api_name}

**New Format URL:**
https://api.lowcodeapi.com/zohoworkely/workerly/v2/{module_api_name}?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/zohoworkely/workerly/v2/module_api_name?api_token=YOUR_API_TOKEN

**Request Body:**

| Field | Type | Description |
|-------|------|-------------|
| Checkbox | boolean |  |
| Currency | number |  |
| Date | string |  |
| Date/time | string |  |
| Decimal | number |  |
| Email | string |  |
| Long Integer | string |  |
| Lookup | object |  |
| Multi-Line | string |  |
| Multi-Select Picklist | array |  |
| Multi-select lookup | object |  |
| Number | number |  |
| Percent | number |  |
| Phone | string |  |
| Picklist | string |  |
| Single Line | string |  |
| URL | string |  |
| User | object |  |

**Example Request (New Format):**

```bash
curl -X PUT 'https://api.lowcodeapi.com/zohoworkely/workerly/v2/{module_api_name}?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://www.zoho.com/workerly/developer-guide/update-records.html

### Delete Records

**Method:** DELETE
**LowCodeAPI Path:** /workerly/v2/{module_api_name}

**New Format URL:**
https://api.lowcodeapi.com/zohoworkely/workerly/v2/{module_api_name}?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/zohoworkely/workerly/v2/module_api_name?api_token=YOUR_API_TOKEN

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| ids | number |  |
| wf_trigger | boolean |  |

**Example Request (New Format):**

```bash
curl -X DELETE 'https://api.lowcodeapi.com/zohoworkely/workerly/v2/{module_api_name}?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://www.zoho.com/workerly/developer-guide/delete-records.html

### List of Deleted Records

**Method:** GET
**LowCodeAPI Path:** /workerly/v2/{module_api_name}/deleted

**New Format URL:**
https://api.lowcodeapi.com/zohoworkely/workerly/v2/{module_api_name}/deleted?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/zohoworkely/workerly/v2/module_api_name/deleted?api_token=YOUR_API_TOKEN

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| type | string |  |
| module  | string |  |
| page | number |  |
| per_page | number |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/zohoworkely/workerly/v2/{module_api_name}/deleted?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://www.zoho.com/workerly/developer-guide/get-deleted-records.html

### Search Records

**Method:** GET
**LowCodeAPI Path:** /workerly/v2/{module_api_name}/search

**New Format URL:**
https://api.lowcodeapi.com/zohoworkely/workerly/v2/{module_api_name}/search?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/zohoworkely/workerly/v2/module_api_name/search?api_token=YOUR_API_TOKEN

**Query Parameters:**

| Parameter | Type | Description |
|-----------|------|-------------|
| approved | string |  |
| converted | string |  |
| criteria | string |  |
| email | string |  |
| page | number |  |
| per_page | number |  |
| phone | string |  |
| word | string |  |

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/zohoworkely/workerly/v2/{module_api_name}/search?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://www.zoho.com/workerly/developer-guide/search-records.html


## Usage Examples

### Example 1: Basic API Request (New Format)

Making a simple GET request to retrieve resources:

```bash
# Get a list of resources - no path parameters needed
curl -X GET "https://api.lowcodeapi.com/zohoworkely/endpoint?api_token=YOUR_API_TOKEN"
```

### Example 2: Request with Path Parameters (New Format)

Retrieving a specific resource using its ID:

```bash
# Get specific resource by ID - replace RESOURCE_ID with actual ID from previous response
curl -X GET "https://api.lowcodeapi.com/zohoworkely/endpoint/{RESOURCE_ID}?api_token=YOUR_API_TOKEN"
# Note: RESOURCE_ID typically comes from a previous list request or from the provider dashboard
```

### Example 3: POST Request with Body (New Format)

Creating a new resource:

```bash
# Create a new resource
curl -X POST "https://api.lowcodeapi.com/zohoworkely/endpoint?api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"field": "value", "another_field": "another_value"}'
```

## Error Handling

LowCodeAPI returns standard HTTP status codes. Common errors:

| Status Code | Description |
|-------------|-------------|
| 200 | Success - Request completed successfully |
| 400 | Bad Request - Invalid parameters or request body |
| 401 | Unauthorized - Invalid or missing API token |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found - Endpoint or resource doesn't exist |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Server Error - Provider API error |

All error responses include error details:

```json
{
  "data": {
    "error": {
      "message": "Error description",
      "code": "ERROR_CODE"
    }
  }
}
```

## Complete Endpoint Reference

| Endpoint | Method | Category |
|----------|--------|----------|
| Fields | GET | Meta Data API |
| Layouts | GET | Meta Data API |
| Custom Views Meta Data | GET | Meta Data API |
| Related Lists Meta Data | GET | Meta Data API |
| Get Records | GET | Records |
| Insert Records | POST | Records |
| Update Records | PUT | Records |
| Delete Records | DELETE | Records |
| List of Deleted Records | GET | Records |
| Search Records | GET | Records |

## API Definition Endpoints

You can fetch the complete API specification for this provider:

**New Format (OpenAPI spec):**
```bash
curl 'https://backend.lowcodeapi.com/zohoworkely/openapi'
```

**Old Format (API definition):**
```bash
curl 'https://backend.lowcodeapi.com/zohoworkely/definition'
```

## Response Format

All responses are wrapped in a `data` key:

```json
{
  "data": {
    // Actual response from provider (object or array)
  }
}
```