### Webhook URL Parameters Example

Source: https://www.zoho.com/crm/developer/docs/api/v8/update-webhook.html

Example for sending data as query parameters in the URL. This is applicable for GET requests and can include module, custom, or user-defined parameters.

```json
{
     "url_parameters": {
       "module_parameters": "${!Leads.Email}",
       "custom_parameters": {"API_version": "v2"},
       "user_defined_parameters": {"message": "Webhook for ${!Leads.Last_Name}"}
     }
   }
```

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

### Separate Scopes for Leads, Deals, and Settings

Source: https://www.zoho.com/crm/developer/docs/api/v8/scopes.html

This example demonstrates how to request access to specific modules (leads, deals) and settings using separate scopes. It includes placeholders for client ID, response type, access type, and redirect URI.

```url
https://accounts.zoho.com/oauth/v2/auth?scope=ZohoCRM.modules.leads.ALL,ZohoCRM.modules.deals.ALL,ZohoCRM.settings.ALL&client_id={client_id}&response_type=code&access_type={"offline"or"online"}&redirect_uri={redirect_uri}
```

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

### Sample SQL to COQL Query

Source: https://www.zoho.com/crm/developer/docs/api/v8/COQL-Overview.html

This example shows a sample SQL query and its equivalent COQL query for fetching specific fields from the Leads module with filtering, grouping, ordering, and limiting.

```SQL
SELECT Last_Name, Created_Time
                    FROM Leads
                    WHERE Last_Name IS NOT NULL 
                      AND Created_Time >= '2019-02-19T12:57:55+05:30'
                    GROUP BY Last_Name, Created_Time
                    ORDER BY Created_Time, id ASC
                    LIMIT 10 OFFSET 2;
```

```COQL
{
        "select_query" : "select Last_Name, Created_Time from Leads where (Last_Name is not null and Created_Time >= '2019-02-19T12:57:55+05:30')  group by Last_Name, Created_Time order by Created_Time, id asc limit 10, 2"
        }
```

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

### Get Fiscal Year Settings

Source: https://www.zoho.com/crm/developer/docs/api/v8/get-fiscal-year.html

Retrieves the details of fiscal year settings for your organization. This includes how the fiscal year is displayed (based on start or end month) and the specific start month.

```APIDOC
## GET /settings/fiscal_year

### Description
Retrieves the details of fiscal year settings of your organization.

### Method
GET

### Endpoint
{api-domain}/crm/{version}/settings/fiscal_year

### Parameters
#### Header
- **Authorization** (string) - Required - Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
- **scope** (string) - Required - ZohoCRM.settings.fiscal_year.READ

### Request Example
```
curl "https://www.zohoapis.com/crm/v8/settings/fiscal_year"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X GET
```

### Response
#### Success Response (200)
- **display_based_on** (string) - Represents whether the fiscal year is based on start month or end month.
- **start_month** (string) - Represents the start month of the fiscal year.

#### Response Example
```json
{
    "fiscal_year": {
        "display_based_on": "start_month",
        "start_month": "JANUARY",
        "id": "431581000000004272"
    }
}
```

#### Possible Errors
- **INVALID_URL_PATTERN** (HTTP 404) - Please check if the URL trying to access is a correct one.
- **OAUTH_SCOPE_MISMATCH** (HTTP 401) - Client does not have ZohoCRM.settings.fiscal_year.READ scope.
- **NO_PERMISSION** (HTTP 403) - Permission denied to read fiscal year settings.
- **INTERNAL_ERROR** (HTTP 500) - Internal Server Error.
- **INVALID_REQUEST_METHOD** (HTTP 400) - The http request method type is not a valid one.
- **AUTHORIZATION_FAILED** (HTTP 400) - User does not have sufficient privilege to read fiscal year settings.
```

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

### Get Related Records Count Response Example

Source: https://www.zoho.com/crm/developer/docs/api/v8/get-related-records-count.html

This snippet shows a sample response from the Get Related Records Count API, indicating the count of related records and the details of the related list.

```json
{
    "get_related_records_count": [
        {
            "count": 11,
            "related_list": {
                "api_name": "Notes",
                "id": "3652397000000015122"
            }
        }
    ]
}
```

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

### Querying Multi Module Lookup

Source: https://www.zoho.com/crm/developer/docs/api/v8/Get-Records-through-COQL-Query.html

This example demonstrates how to query across multiple modules using COQL, fetching related fields from Leads and Accounts.

```APIDOC
## POST /coql

### Description
Fetches data by querying across multiple modules using COQL, allowing retrieval of related fields.

### Method
POST

### Endpoint
/coql

### Request Body
- **data** (object) - Required - Contains the COQL query and its parameters.
  - **select_query** (string) - Required - The COQL query string.

### Request Example
```json
{
    "data": [
        {
            "select_query": "select 'What_Id->Leads.Last_Name', 'What_Id->Accounts.Account_Type', 'id' from Appointments__s where id is not null"
        }
    ]
}
```

### Response
#### Success Response (200)
- **data** (array) - An array of records matching the query.
  - **What_Id->Leads.Last_Name** (string) - The last name from the related Leads module.
  - **What_Id->Accounts.Account_Type** (string) - The account type from the related Accounts module.
  - **id** (string) - The ID of the record.
- **info** (object) - Information about the response.
  - **count** (integer) - The number of records returned.
  - **more_records** (boolean) - Indicates if there are more records available.

#### Response Example
```json
{
    "data": [
        {
            "What_Id->Leads.Last_Name": "Sam",
            "What_Id->Accounts.Account_Type": "Partner",
            "id": "5725767000000420632"
        },
        {
            "What_Id->Leads.Last_Name": "Jane",
            "What_Id->Accounts.Account_Type": "Vendor",
            "id": "5725767000000420633"
        }
    ],
    "info": {
        "count": 2,
        "more_records": true
    }
}
```
```

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

### Sample Fiscal Year Response

Source: https://www.zoho.com/crm/developer/docs/api/v8/get-fiscal-year.html

This is an example of the JSON response you will receive when successfully retrieving fiscal year settings. It indicates whether the year is based on the start or end month and specifies the start month.

```json
{
    "fiscal_year": {
        "display_based_on": "start_month",
        "start_month": "JANUARY",
        "id": "431581000000004272"
    }
}
```

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

### Composite Request Example

Source: https://www.zoho.com/crm/developer/docs/api/v8/composite-api.html

This example demonstrates how to structure a composite API request, including multiple sub-requests for creating leads, retrieving lead details, and executing COQL queries. It also shows the `rollback_on_fail` and `parallel_execution` options.

```APIDOC
## Composite API Request

### Description
Allows executing multiple API requests in a single call. Supports options for parallel execution and transaction rollback on failure.

### Method
POST

### Endpoint
`/crm/v8/composite/actions`

### Parameters
#### Request Body
- **rollback_on_fail** (boolean) - Optional - If true, the entire transaction is rolled back if any sub-request fails.
- **parallel_execution** (boolean) - Optional - If true, sub-requests are executed in parallel.
- **__composite_requests** (array) - Required - An array of sub-requests to be executed.
  - **sub_request_id** (string) - Required - A unique identifier for the sub-request.
  - **method** (string) - Required - The HTTP method for the sub-request (e.g., POST, GET).
  - **uri** (string) - Required - The API endpoint for the sub-request.
  - **headers** (object) - Optional - Headers for the sub-request.
  - **params** (object) - Optional - Query parameters for the sub-request.
  - **body** (object) - Optional - Request body for the sub-request.

### Request Example
```json
{
  "rollback_on_fail": true,
  "parallel_execution": false,
  "__composite_requests": [
    {
      "sub_request_id": "1",
      "method": "POST",
      "uri": "/crm/v6/Leads",
      "headers": {},
      "body": {
        "data": [
          {
            "Last_Name": "Sam"
          }
        ]
      }
    },
    {
      "sub_request_id": "2",
      "params": {
        "fields": "Last_Name,Company,Email",
        "per_page": "3",
        "page": "1",
        "ids": "@{1:$.data[0].details.id}"
      },
      "method": "GET",
      "uri": "/crm/v6/Leads"
    },
    {
      "sub_request_id": "3",
      "method": "GET",
      "uri": "/crm/v6/Leads",
      "params": {
        "fields": "Last_Name,Company,Email",
        "page": 1
      },
      "body": {
        "data": [
          {
            "Last_Name": "Sam"
          }
        ]
      }
    },
    {
      "sub_request_id": "4",
      "method": "POST",
      "body": {
        "select_query": "select Last_Name from Leads where Last_Name is not null limit 26"
      },
      "uri": "/crm/v6/coql"
    },
    {
      "sub_request_id": "5",
      "method": "GET",
      "params": {
        "fields": "Last_Name,Company,Email"
      },
      "uri": "crm/v6/Leads"
    }
  ]
}
```

### Response
#### Success Response (200)
- **__composite_requests** (array) - An array containing the results of each sub-request.
  - **code** (string) - Status code for the sub-request (e.g., SUCCESS, ROLLBACK_PERFORMED).
  - **details** (object) - Additional details about the sub-request result.
  - **message** (string) - A message describing the sub-request result.
  - **status** (string) - Overall status of the sub-request (e.g., success, error).

#### Response Example (Rollback)
```json
{
  "__composite_requests": [
    {
      "code": "ROLLBACK_PERFORMED",
      "details": {
        "rollbacked_by_sub_request_index": 3
      },
      "message": "the transaction was rolled back since another sub request in the same transaction failed.",
      "status": "error"
    },
    {
      "code": "ROLLBACK_PERFORMED",
      "details": {
        "rollbacked_by_sub_request_index": 3
      },
      "message": "the transaction was rolled back since another sub request in the same transaction failed.",
      "status": "error"
    },
    {
      "code": "ROLLBACK_PERFORMED",
      "details": {
        "rollbacked_by_sub_request_index": 3
      },
      "message": "the transaction was rolled back since another sub request in the same transaction failed.",
      "status": "error"
    },
    {
      "code": "SUCCESS",
      "details": {
        "response": {
          "headers": {
            "X-ACCESSTOKEN-RESET": "2022-02-02T11:43:59+05:30",
            "X-Content-Type-Options": "nosniff",
            "Content-Disposition": "attachment; filename=response.json",
            "X-Download-Options": "noopen",
            "content-type": "application/json;charset=utf-8",
            "clientVersion": "4725537",
            "clientsubVersion": "1fbb2cd4aec39c18e65a4eebcff5a8cc"
          },
          "status_code": 400,
          "body": {
            "code": "LIMIT_EXCEEDED",
            "details": {
              "by": "limit",
              "limit": 25
            },
            "message": "limit exceeded",
            "status": "error"
          }
        }
      },
      "message": "composite sub request executed successfully",
      "status": "success"
    },
    {
      "code": "PROCESSING_STOPPED",
      "details": {
        "rollbacked_by_sub_request_index": 3
      },
      "message": "the transaction was rolled back since another sub request in the same transaction failed.",
      "status": "error"
    }
  ]
}
```
```

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

### Fetching Owner Profile and Role Details

Source: https://www.zoho.com/crm/developer/docs/api/v8/Get-Records-through-COQL-Query.html

This example shows how to retrieve details of the owner's profile and role, such as ID, name, and creation/modification times.

```APIDOC
## POST /coql

### Description
Fetches details of the owner's profile and role, including their IDs, names, and timestamps.

### Method
POST

### Endpoint
/coql

### Parameters
#### Request Body
- **data** (object) - Required - Contains the COQL query and its parameters.
  - **select_query** (string) - Required - The COQL query string.

### Request Example
```json
{
    "data": [
        {
            "select_query": "select Owner.profile.id, Owner.profile.name, Owner.profile.created_by, Owner.profile.modified_by, Owner.profile.description, Owner.profile.created_time, Owner.profile.modified_time from Contacts where Last_Name is not null limit 2"
        }
    ]
}
```

### Response
#### Success Response (200)
- **data** (array) - An array of records matching the query.
  - **Owner.profile.id** (string) - The ID of the owner's profile.
  - **Owner.profile.name** (string) - The name of the owner's profile.
  - **Owner.profile.created_by** (object) - Details of the user who created the profile.
  - **Owner.profile.modified_by** (object) - Details of the user who modified the profile.
  - **Owner.profile.description** (string) - The description of the profile.
  - **Owner.profile.created_time** (string) - The creation timestamp of the profile.
  - **Owner.profile.modified_time** (string) - The modification timestamp of the profile.
  - **id** (string) - The ID of the contact record.
- **info** (object) - Information about the response.
  - **count** (integer) - The number of records returned.
  - **more_records** (boolean) - Indicates if there are more records available.

#### Response Example
```json
{
    "data": [
        {
            "Owner.profile.id": "3652397000000026011",
            "Owner.profile.modified_by": null,
            "Owner.profile.description": "crm.security.profile.admin.desc",
            "Owner.profile.created_by": null,
            "Owner.profile.modified_time": null,
            "Owner.profile.created_time": null,
            "id": "3652397000000190181",
            "Owner.profile.name": "Administrator"
        }
    ],
    "info": {
        "count": 2,
        "more_records": true
    }
}
```
```

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

### Get Related Records Count - Sample Input JSON

Source: https://www.zoho.com/crm/developer/docs/api/v8/get-related-records-count.html

This JSON object specifies the related list for which to fetch the record count. You can use either the 'id' or 'api_name' of the related list. This example shows how to get the count of 'Notes' for a record.

```json
{
    "get_related_records_count": [
        {
            "related_list": {
                "id": "3652397000000015122",
                "api_name": "Notes"
            }
        }
]
}

```

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

### Get Fiscal Year Settings

Source: https://www.zoho.com/crm/developer/docs/api/v8/get-fiscal-year.html

Retrieve the current fiscal year configuration for your organization. This is useful for understanding how financial periods are defined within your CRM setup.

```curl
curl "https://www.zohoapis.com/crm/v8/settings/fiscal_year"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X GET
```

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

### Sample Response for Querying Appointments Module

Source: https://www.zoho.com/crm/developer/docs/api/v8/Get-Records-through-COQL-Query.html

This is a sample JSON response for a query on the Appointments module.

```json
{
 "select_query": "select 'Appointment_For->Contacts.Lead_Source' from Appointments__s where id is not null"
}
```

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

### Sample Query With Two Relations (Joins)

Source: https://www.zoho.com/crm/developer/docs/api/v8/Get-Records-through-COQL-Query.html

This example demonstrates how to perform a query with two joins, linking Contacts to Accounts and then to their Parent Accounts.

```APIDOC
## Get Contacts with Parent Account Information

### Description
Retrieves contact records, including the name of their parent account, by establishing two joins through the Account Name lookup field.

### Method
POST

### Endpoint
/coql

### Request Body
- **select_query** (string) - Required - The COQL query string.

### Request Example
```json
{
  "select_query" : "select Last_Name, Account_Name.Parent_Account, Account_Name.Parent_Account.Account_Name from Contacts where Last_Name is not null and Account_Name.Parent_Account.Account_Name is not null"
}
```

### Response
#### Success Response (200)
- **data** (array) - Contains the query results.
  - **Account_Name.Parent_Account.Account_Name** (string) - The name of the parent account.
  - **Last_Name** (string) - The last name of the contact.
  - **Account_Name.Parent_Account** (object) - Information about the parent account.
    - **id** (string) - The ID of the parent account.
  - **id** (string) - The ID of the contact.
- **info** (object) - Contains metadata about the response.
  - **count** (integer) - The number of records returned.
  - **more_records** (boolean) - Indicates if there are more records available.

#### Response Example
```json
{
    "data": [
        {
            "Account_Name.Parent_Account.Account_Name": "Zylker",
            "Last_Name": "Boyle",
            "Account_Name.Parent_Account": {
                "id": "554023000000238121"
            },
            "id": "554023000000310003"
        },
        {
            "Account_Name.Parent_Account.Account_Name": "Zylker",
            "Last_Name": "Patricia",
            "Account_Name.Parent_Account": {
                "id": "554023000000238121"
            },
            "id": "554023000000310012"
        }
    ],
    "info": {
        "count": 2,
        "more_records": false
    }
}
```
```

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

### Sample Bulk Read API Request

Source: https://www.zoho.com/crm/developer/docs/api/v8/hipaa-compliance.html

Example of a GET request to the Bulk Read API. Note that sensitive HIPAA data will be empty if access is restricted in compliance settings.

```curl
curl "https://www.zohoapis.com/crm/bulk/v6/read/554023000000568002/result"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
```

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

### Get Related Records of a Deleted Lead

Source: https://www.zoho.com/crm/developer/docs/api/v8/get-related-records-of-deleted-record.html

This cURL example demonstrates how to retrieve related Campaign records for a deleted Lead. Ensure you have the correct Authorization token and API domain.

```curl
curl "https://www.zohoapis.com/crm/v8/Leads/deleted/2423488000000552938/Campaigns?fields=Owner,Parent_Id"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
```

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

### Configure Webhook With Headers

Source: https://www.zoho.com/crm/developer/docs/api/v8/create-webhook.html

This example demonstrates how to configure a webhook with custom headers, including module-specific parameters and general custom parameters. It also includes the module, URL, HTTP method, and authentication.

```APIDOC
## POST /webhooks

### Description
Configures a new webhook with custom headers, including module parameters and custom parameters.

### Method
POST

### Endpoint
/webhooks

### Request Body
- **webhooks** (array) - Required - An array of webhook configurations.
  - **headers** (object) - Optional - Custom headers to be sent with the webhook request.
    - **module_parameters** (array) - Optional - Parameters derived from the module's fields.
      - **name** (string) - Required - The name of the module parameter.
      - **value** (string) - Required - The value of the module parameter, potentially using variables like `${!Leads.Email}`.
    - **custom_parameters** (array) - Optional - Custom key-value pairs to be included in the headers.
      - **name** (string) - Required - The name of the custom parameter.
      - **value** (string) - Required - The value of the custom parameter.
  - **module** (object) - Required - Details of the module the webhook is associated with.
    - **api_name** (string) - Required - The API name of the module.
    - **id** (string) - Required - The ID of the module.
  - **description** (string) - Optional - A description for the webhook.
  - **url** (string) - Required - The URL to which the webhook events will be sent.
  - **http_method** (string) - Required - The HTTP method to use for the webhook request (e.g., POST).
  - **name** (string) - Required - The name of the webhook.
  - **authentication** (object) - Required - Authentication details for the webhook.
    - **type** (string) - Required - The type of authentication (e.g., 'general').

### Request Example
```json
{
    "webhooks": [
        {
            "headers": {
                "module_parameters": [
                    {
                        "name": "lead_email",
                        "value": "${!Leads.Email}"
                    },
                    {
                        "name": "lead_id",
                        "value": "${!Leads.Id}"
                    },
                    {
                        "name": "lead_owner",
                        "value": "${!Leads.Owner}"
                    }
                ],
                "custom_parameters": [
                    {
                        "name": "source",
                        "value": "website"
                    },
                    {
                        "name": "version",
                        "value": "1.0"
                    }
                ]
            },
            "module": {
                "api_name": "Leads",
                "id": "5725767000000002175"
            },
            "description": "Protected Data",
            "url": "https://webhook.site/3588de27-e3bd-4237-894b-f140143f3d99",
            "http_method": "POST",
            "name": "Zoho's Data",
            "authentication": {
                "type": "general"
            }
        }
    ]
}
```
```

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

### Get All Profiles (Deluge)

Source: https://www.zoho.com/crm/developer/docs/api/v8/get-profiles.html

Retrieve a list of all profiles in your Zoho CRM organization using Deluge script. This is useful for understanding the available access levels within your CRM setup.

```Deluge
response = invokeurl
[
	url: "https://www.zohoapis.com/crm/v8/settings/profiles"
	type: GET
	connection:"crm_oauth_connection"
];
info response;
```

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

### Sample Response for Successful Portal Creation

Source: https://www.zoho.com/crm/developer/docs/api/v8/create-portal.html

This is a sample successful response after creating a portal. It confirms the creation and provides details of the created portal, including its name.

```json
{
    "portals": [
        {
            "code": "SUCCESS",
            "details": {
                "name": "PortalsAPItest100"
            },
            "message": "Portal created successfully with given name.",
            "status": "success"
        }
    ]
}
```

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

### Get Data Enrichment Configuration

Source: https://www.zoho.com/crm/developer/docs/api/v8/zia-enrichment/get-config.html

Fetches the current configuration for data enrichment, showing how external data fields are mapped to your CRM fields. This is useful for understanding and managing your data enrichment setup.

```APIDOC
## GET /settings/zia/data_enrichment

### Description
Use this API to get the details of configuration for data enrichment. This API gives you the mapping of the enrich fields with their corresponding CRM fields for enriching data.

### Method
GET

### Endpoint
/crm/{version}/settings/zia/data_enrichment

### Parameters
#### Header
- **Authorization** (string) - Required - Zoho-oauthtoken <access-token>

#### Scope
ZohoCRM.Zia.enrichment.ALL or ZohoCRM.Zia.enrichment.READ

### Request Example
```curl
"https://www.zohoapis.com/crm/v8/settings/zia/data_enrichment"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
```

### Response
#### Success Response (200)
This endpoint returns the data enrichment configuration, including the mapping of enrichable fields to CRM fields. The exact structure will detail these mappings.

#### Response Example
(Response structure not provided in source text)
```

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

### Sample Subscription Response

Source: https://www.zoho.com/crm/developer/docs/api/v8/notifications/enable.html

This is a sample response received after successfully subscribing to module actions for notifications.

```json
{
    "watch": [
        {
            "code": "SUCCESS",
            "details": {
                "channel_expiry": "2023-08-02T16:59:50-11:00",
                "resource_uri": "https://www.zohoapis.com/crm/v8/Deals",
                "resource_id": "554023000000000131",
                "resource_name": "Deals",
                "channel_id": "10000"
            },
            "message": "Successfully subscribed for actions-watch of the given module",
            "status": "success"
        }
    ]
}
```

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

### Get User Calendar Preferences

Source: https://www.zoho.com/crm/developer/docs/api/v8/get-calendar-preferences.html

Fetches the calendar configuration settings for the user, such as working hours, holiday settings, week start preference, default activity durations, reminder configurations, notification channels, and meeting preferences.

```APIDOC
## GET /settings/calendar/user_calendar_preferences

### Description
To retrieve the user’s calendar configuration settings such as the working hours, holiday settings, week start preference, default activity durations, reminder configurations, notification channels, meeting preferences, etc.

### Method
GET

### Endpoint
{api-domain}/crm/{version}/settings/calendar/user_calendar_preferences

### Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

### Scope
ZohoCRM.settings.calendar.ALL or ZohoCRM.settings.calendar.READ

### Sample Request
```
curl "https://www.zohoapis.com/crm/v8/settings/calendar/user_calendar_preferences"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
```
```

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

### Sample Wizard Response

Source: https://www.zoho.com/crm/developer/docs/api/v8/get-wizards.html

This is a sample JSON response when retrieving wizard data. It includes details about the wizard's creation and modification times, associated portal user types, module information, name, modified by user, profiles, active status, and container configurations.

```json
{
    "wizards": [
        {
            "created_time": "2024-05-09T23:25:22-07:00",
            "modified_time": "2024-05-09T23:25:22-07:00",
             "portal_user_types": [
                {
                    "display_label": "ClientPortal",
                    "name": "ClientPortal",
                    "id": "5725767000004742018"
                }
            ],
            "module": {
                "api_name": "Leads",
                "id": "5725767000000002175"
            },
            "name": "Lead",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "5725767000000411001"
            },
            "profiles": [
                {
                    "display_label": "Administrator",
                    "name": "Administrator",
                    "id": "5725767000000026011"
                },
                {
                    "display_label": "Standard",
                    "name": "Standard",
                    "id": "5725767000000026014"
                },
                {
                    "display_label": "asd",
                    "name": "asd",
                    "id": "5725767000000871001"
                }
            ],
            "active": true,
            "containers": [
                {
                    "layout": {
                        "display_label": "Standard",
                        "name": "Standard",
                        "id": "5725767000000091055"
                    },
                    "screens": [
                        {
                            "display_label": "Personal",
                            "api_name": "Personal1",
                            "id": "5725767000000526327"
                        },
                        {
                            "display_label": "Lead status",
                            "api_name": "Lead_status1",
                            "id": "5725767000000526329"
                        },
                        {
                            "display_label": "Income",
                            "api_name": "Income1",
                            "id": "5725767000000526331"
                        }
                    ],
                    "id": "5725767000000091055"
                },
                {
                    "layout": {
                        "display_label": "Zoho",
                        "name": "Zoho",
                        "id": "5725767000000526001"
                    },
                    "screens": [
                        {
                            "display_label": "Save Page",
                            "api_name": "Save_Page1",
                            "id": "5725767000000526395"
                        },
                        {
                            "display_label": "save page2",
                            "api_name": "save_page21",
                            "id": "5725767000000526397"
                        }
                    ],
                    "id": "5725767000000526001"
                }
            ],
            "id": "5725767000000526319",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "5725767000000411001"
            }
        },
        {
            "created_time": "2024-12-05T02:58:12-08:00",
            "modified_time": "2024-12-05T02:58:12-08:00",
            "portal_user_types": [
                {
                    "display_label": "ClientPortal",
                    "name": "ClientPortal",
                    "id": "5725767000004742018"
                }
            ],
            "module": {
                "api_name": "Leads",
                "id": "5725767000000002175"
            },
            "name": "test",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "5725767000000411001"
            },
            "profiles": [
                {
                    "display_label": "Administrator",
                    "name": "Administrator",
                    "id": "5725767000000026011"
                }
            ],
            "active": true,
            "containers": [
                {
                    "layout": {
                        "display_label": "Standard",
                        "name": "Standard",
                        "id": "5725767000000091055"
                    },
                    "screens": [
                        {
                            "display_label": "Screen 1",
                            "api_name": "Screen_1",
                            "id": "5725767000004742097"
                        },
                        {
                            "display_label": "Screen 2",
                            "api_name": "Screen_2",
                            "id": "5725767000004742099"
                        },
                        {
                            "display_label": "Screen 3",
                            "api_name": "Screen_3",
                            "id": "5725767000004742101"
                        }
                    ],
                    "id": "5725767000000091055"
                }
            ],
            "id": "5725767000004742095",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "5725767000000411001"
            }
        }
    ]
}
```

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

### Get Users Count

Source: https://www.zoho.com/crm/developer/docs/api/v8/api-references.html

Fetch the user count in your org. You can get the total number of users, or get the count by user type.

```APIDOC
## Get Users Count

### Description
Fetch the user count in your org. You can get the total number of users, or get the count by user type.

### Method
GET

### Endpoint
/crm/v8/users/count
```

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

### Custom Parameters Example

Source: https://www.zoho.com/crm/developer/docs/api/v8/create-webhook.html

Example of custom parameters for webhook authentication headers.

```json
{
    "custom_parameters": [
        {
            "name": "OAuth",
            "value": "2.0"
        }
    ]

}
```

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

### Get Attachments

Source: https://www.zoho.com/crm/developer/docs/api/v8/api-references.html

Get the list of attachments.

```APIDOC
## GET Attachments

### Description
Get the list of attachments.

### Method
GET

### Endpoint
/attachments

### Parameters
#### Query Parameters
- **recordId** (string) - Required - The ID of the record.

### Response
#### Success Response (200)
- **attachments** (array) - A list of attachments.
```

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

### Get Organization Details

Source: https://www.zoho.com/crm/developer/docs/api/v8/api-references.html

Get the organization data.

```APIDOC
## Get Organization Details

### Description
Get the organization data.

### Method
GET

### Endpoint
/crm/v8/org
```

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

### Sample API Response - Module Properties

Source: https://www.zoho.com/crm/developer/docs/api/v8/layouts-meta.html

Illustrates the structure of a sample API response detailing module properties, including field configurations and display settings.

```json
{
                                    "permission_type": "read_write",
                                    "name": "Administrator",
                                    "id": "2276164000000015972"
                                },
                                {
                                    "permission_type": "read_write",
                                    "name": "Standard",
                                    "id": "2276164000000015975"
                                }
                            ],
                            "view_type": {
                                "view": true,
                                "edit": true,
                                "quick_create": false,
                                "create": true
                            },
                            "separator": false,
                            "searchable": false,
                            "external": null,
                            "api_name": "Record_Image",
                            "unique": {},
                            "enable_colour_code": false,
                            "pick_list_values": [],
                            "system_mandatory": false,
                            "virtual_field": false,
                            "json_type": "string",
                            "crypt": null,
                            "created_source": "default",
                            "display_type": -1,
                            "ui_type": 66,
                            "validation_rule": null,
                            "modified_time": null,
                            "public": false,
                            "section_id": 5,
                            "email_parser": {
                                "fields_update_supported": false,
                                "record_operations_supported": false
                            },
                            "currency": {},
                            "custom_field": false,
                            "lookup": {},
                            "convert_mapping": {
                                "Contacts": null,
                                "Deals": null,
                                "Accounts": null
                            },
                            "rollup_summary": {},
                            "length": 255,
                            "column_name": "PHOTO_FILEID",
                            "display_field": false,
                            "pick_list_values_sorted_lexically": false,
                            "default_value": null,
                            "sortable": false,
                            "sequence_number": 1,
                            "global_picklist": null,
                            "history_tracking": null,
                            "data_type": "profileimage",
                            "formula": {},
                            "additional_column": null,
                            "decimal_place": null,
                            "mass_update": false,
                            "multiselectlookup": {},
                            "auto_number": {}
                        }
                    ],
                    "properties": null
                },
                .
                .
                .
            ],
            "display_label": "Standard",
            "show_business_card": true,
            "actions_allowed": {
                "edit": true,
                "rename": true,
                "clone": true,
                "downgrade": false,
                "delete": false,
                "deactivate": false,
                "set_layout_permissions": true
            },
            "modified_time": "2024-12-16T15:32:24+05:30",
            "api_name": "Standard__s",
            "name": "Standard",
            "modified_by": {
                "name": "Patricia",
                "id": "2276164000000471001"
            },
            "generated_type": "system",
            "id": "2276164000000095055",
            "status": "active"
        }
    ]
}
```

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

### Get Subforms

Source: https://www.zoho.com/crm/developer/docs/api/v8/api-references.html

Get the subform data of a record.

```APIDOC
## Get Subforms

### Description
Get the subform data of a record.

### Method
GET

### Endpoint
/crm/v8/{module}/{recordId}/{subformModule}
```

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

### Sample Response for Assignment Rules

Source: https://www.zoho.com/crm/developer/docs/api/v8/get-assignment-rules.html

This is an example of the JSON response you will receive when fetching assignment rules. It includes details like creation time, module, name, and assignee.

```json
{
    "assignment_rules": [
        {
            "created_time": "2020-04-12T00:00:00+05:30",
            "modified_time": "2021-02-26T12:45:14+05:30",
            "default_assignee": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "module": {
                "api_name": "Leads",
                "id": "3652397000000002175"
            },
            "name": "Lead Assignment Rule",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "description": "Assign the Leads to the Owners based on these criteria.",
            "id": "3652397000002045001",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            }
        }
    ]
}
```

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

### Sample Response for Multi Module Lookup

Source: https://www.zoho.com/crm/developer/docs/api/v8/Get-Records-through-COQL-Query.html

This is a sample JSON response when querying multi-module lookups.

```json
{
    "data": [
        {
            "What_Id->Leads.Last_Name": "Sam",
            "What_Id->Accounts.Account_Type":"Partner",
            "id": "5725767000000420632"
        },
        {
            "What_Id->Leads.Last_Name": "Jane",
            "What_Id->Accounts.Account_Type": "Vendor",
            "id": "5725767000000420633"
        }
    ],
    "info": {
        "count": 2,
        "more_records": true
    }
}
```

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

### Get Email Drafts

Source: https://www.zoho.com/crm/developer/docs/api/v8/api-references.html

Get email drafts.

```APIDOC
## Get Email Drafts

### Description
Get email drafts.

### Method
GET

### Endpoint
/crm/v8/{module}/{recordId}/Drafts
```

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

### Get Notes

Source: https://www.zoho.com/crm/developer/docs/api/v8/api-references.html

Get the list of notes in a module.

```APIDOC
## Get Notes

### Description
Get the list of notes in a module.

### Method
[HTTP method not specified]

### Endpoint
[Endpoint not specified]
```