Zoho CRM Developer API v8

https://www.zoho.com/crm/developer/docs/api/v8/
Admin
Zoho CRM Developer API v8 provides comprehensive REST APIs and developer tools for building...
Tokens:1,488,380
Snippets:9,788
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Sample Response for Get All Wizards

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

Example JSON response containing wizard details such as created_time, module, profiles, and containers.

```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": "5725767000000091056"
                    },
                    "screens": [
                        {
                            "display_label": "Screen 1",
                            "api_name": "Screen1",
                            "id": "5725767000000526333"
                        }
                    ],
                    "id": "5725767000000091056"
                }
            ],
            "id": "5725767000000091055"
        }
    ]
}
```

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

### Sample Response JSON for Get Signals

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

Example response for the GET /settings/signals request. Contains an array of signal objects with fields such as display_label, extension, feature_availability, namespace, chat_enabled, enabled, and id.

```json
{
    "signals": [
        {
            "display_label": "Incoming",
            "extension": {
                "display_label": "Email",
                "namespace": "Email",
                "id": "3652397000000112001",
                "type": 2
            },
            "feature_availability": {
                "scoring": true,
                "signals": true
            },
            "namespace": "Email_Incoming__s",
            "chat_enabled": false,
            "id": "3652397000000112019",
            "enabled": true
        },
        {
            "display_label": "Competitor Alert",
            "extension": {
                "display_label": "Email",
                "namespace": "Email",
                "id": "3652397000000112001",
                "type": 2
            },
            "feature_availability": {
                "scoring": false,
                "signals": true
            },
            "namespace": "Email_Incoming_Competitors__s",
            "chat_enabled": false,
            "id": "3652397000004458132",
            "enabled": true
        },
        {
            "display_label": "Open",
            "extension": {
                "display_label": "Email Insights",
                "namespace": "EmailInsight",
                "id": "3652397000000112003",
                "type": 2
            },
            "feature_availability": {
                "scoring": true,
                "signals": true
            },
            "namespace": "EmailInsight_Open__s",
            "chat_enabled": false,
            "id": "3652397000000112021",
            "enabled": true
        },
        {
            "display_label": "Click",
            "extension": {
                "display_label": "Email Insights",
                "namespace": "EmailInsight",
                "id": "3652397000000112003",
                "type": 2
            },
            "feature_availability": {
                "scoring": true,
                "signals": true
            },
            "namespace": "EmailInsight_Click__s",
            "chat_enabled": false,
            "id": "3652397000000112023",
            "enabled": true
        },
        {
            "display_label": "Bounce",
            "extension": {
                "display_label": "Email Insights",
                "namespace": "EmailInsight",
                "id": "3652397000000112003",
                "type": 2
            },
            "feature_availability": {
                "scoring": true,
                "signals": true
            },
            "namespace": "EmailInsight_Bounce__s",
            "chat_enabled": false,
            "id": "3652397000000112025",
            "enabled": true
        }
    ]
}
```

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

### Sample Response

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

Example JSON response from the Get Recycle Bin API. Contains a recycle_bin array with record details and an info object with pagination metadata.

```json
{
    "recycle_bin": [
        {
            "owner": {
                "name": "Patricia Boyle",
                "id": "4876876000000327001"
            },
            "module": {
                "api_name": "Leads",
                "id": "4876876000000002175"
            },
            "deleted_by": {
                "name": "Patricia Boyle",
                "id": "4876876000000327001"
            },
            "id": "4876876000007018006",
            "display_name": "John Doe",
            "deleted_time": "2024-07-23T15:37:52+05:30"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}
```

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

### Get Sources by Type - Sample Response

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

Example response for the Get Sources by Type request. Shows the sources array with source name and ID, type, subordinates boolean, and info object with pagination details.

```json
{
    "sources": [
        {
            "source": {
                "name": "CEO",
                "id": "3652397000000026005"
            },
            "type": "roles",
            "subordinates": false
        },
        {
            "source": {
                "name": "Manager",
                "id": "3652397000000026008"
            },
            "type": "roles",
            "subordinates": true
        }
    ],
    "info": {
        "per_page": 200,
        "count": 2,
        "page": 1,
        "more_records": false
    }
}
```

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

### Sample Input - Get Records

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

Example JSON for the GetRecordsUpdate state, specifying a get_record action with an id and name.

```json
{
    "states": [
        {
            "name": "GetRecordsUpdate",
            "details": {
                "get_record": {
                    "id": "5039614000001057567",
                    "name": "Call Get Records"
                }
            }
        }
    ]
}
```

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

### Get Notes API sample requests (curl and Deluge)

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

Sample requests for the Get Notes API. The curl example uses the GET method with the Authorization header and fields parameter. The Deluge example uses invokeurl with a crm_oauth_connection and prints the response.

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

```deluge
response = invokeurl
[
	url: "https://www.zohoapis.com/crm/v8/Notes?fields=Owner,Created_Time,Note_Title"
	type: GET
	connection:"crm_oauth_connection"
];
info response;
```

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

### Sample Input - Create Record (Via User Input)

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

Sample input for the quick_create_record action state. It creates a record in the Contacts module using field mappings with static and merge_field values, and specifies a layout and module by ID.

```json
{
  "states": [
    {
      "name": "Action 3",
      "from_transition": {
        "id": "1019138000016172571"
      },
      "type": "action",
      "details": {
        "type": "quick_create_record",
        "quick_create_record": {
          "field_mappings": [
            {
              "field": {
                "id": "1019138000000002489",
                "api_name": "First_Name"
              },
              "type": "merge_field",
              "value": "${!Lead_Update2.CurrentRecord.Name}"
            },
            {
              "field": {
                "id": "1019138000000002491",
                "api_name": "Last_Name"
              },
              "type": "static",
              "value": "LoanMember"
            },
            {
              "field": {
                "id": "1019138000000002497",
                "api_name": "Email"
              },
              "type": "merge_field",
              "value": "${!Lead_Update2.CurrentRecord.Email}"
            },
            {
              "field": {
                "id": "1019138000000002503",
                "api_name": "Phone"
              },
              "type": "static",
              "value": "7235910056"
            }
          ],
          "layout": {
            "id": "1019138000000091033",
            "name": "Standard"
          },
          "module": {
            "id": "1019138000000002179",
            "api_name": "Contacts"
          }
        }
      }
    }
  ]
}
```

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

### Get Tags API sample requests (curl and Deluge)

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

Sample requests for the Get Tags API. The curl example uses the GET method with an Authorization header containing a Zoho OAuth token. The Deluge example uses invokeurl with a connection named crm_oauth_connection and prints the response.

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

```deluge
response = invokeurl
[
	url: "https://www.zohoapis.com/crm/v8/settings/tags?module=Leads"
	type: GET
	connection:"crm_oauth_connection"
];
info response;
```

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

### Sample Input - Create Record (Via User Input)

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

Sample input for the quick_create_record action state. The details object contains the type set to quick_create_record, a layout with id and name, and a module with id and api_name. This action displays a form for user input to create a record.

```json
{
    "states": [
        {
            "name": "Quick",
            "details": {
                "quick_create_record": {
                    "type":"quick_create_record",
                    "layout": {
                        "id": "5039614000000095053",
                        "name": "Standard"
                    },
                    "module": {
                        "id": "5039614000000000143",
                        "api_name": "Tasks"
                    }
                }
            }
        }
    ]
}
```

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

### Get Record Count for a Tag - Sample Request (curl and Deluge)

Source: https://www.zoho.com/crm/developer/docs/api/v8/tag-record-count.html

Sample request to get the record count for a specific tag. The curl example uses a GET request with an OAuth token; the Deluge example uses the invokeurl function with a connection named "crm_oauth_connection". Both target the same endpoint and module.

```curl
curl "https://www.zohoapis.com/crm/v8/settings/tags/2000000039007/actions/records_count?module=Contacts"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
```

```deluge
response = invokeurl
[
	url: "https://www.zohoapis.com/crm/v8/settings/tags/2000000039007/actions/records_count?module=Contacts"
	type: GET
	connection:"crm_oauth_connection"
];
info response;
```

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

### Sample Input - Create Record (Predefined Configuration)

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

Sample input for the create_record action state. The details object contains type set to create_record, a layout, a module, and a field_mappings array with a static field mapping. This action creates a record with predefined configuration.

```json
{
    "states": [
        {
            "name": "CREATE RECORD",
            "details": {
                "type": "create_record",
                "create_record": {
                    "layout": {
                        "id": "5039614000000095055",
                        "api_name": "Standard"
                    },
                    "module": {
                        "id": "5039614000000000125",
                        "api_name": "Leads"
                    },
                    "field_mappings": [
                        {
                            "field": {
                                "id": "5039614000000000555",
                                "api_name": "Company"
                            },
                            "type": "static",
                            "value": "Test"
                        }
                    ]
                }
            }
        }
    ]
}
```

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

### Retrieve territories with curl and Deluge

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

Sample requests to retrieve all territories. The curl example uses the include_inner_details parameter to get the manager's ZUID and status. The Deluge example uses the invokeurl function with a GET request and a connection named crm_oauth_connection.

```curl
curl "https://www.zohoapis.com/crm/v8/settings/territories?include_inner_details=manager.zuid,manager.status"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X GET
```

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

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

### Get Organization Photo with curl and Deluge

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

Sample requests to retrieve the organization photo or logo using the GET /org/photo endpoint. The curl example uses the Zoho-oauthtoken header, while the Deluge example uses the invokeurl function with a connection named crm_oauth_connection.

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

```deluge
response = invokeurl
[
	url: "https://www.zohoapis.com/crm/v8/org/photo"
	type: GET
	connection:"crm_oauth_connection"
];
info response;
```

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

### Sample Response: Blueprints Usage Configurations

Source: https://www.zoho.com/crm/developer/docs/api/v8/blueprints-usage-configurations.html

Example JSON response showing the configuration details for Blueprints, including timebox periods, process name rules, and other configuration keys. The response contains a 'blueprints' array with objects for timebox, process, and other settings.

```json
{
    "blueprints": [
        {
            "timebox": {
                "period": [
                    {
                        "name": "hours",
                        "display_name": "Hour(s)"
                    },
                    {
                        "name": "minutes",
                        "display_name": "Minute(s)"
                    },
                    {
                        "name": "days",
                        "display_name": "Day(s)"
                    },
                    {
                        "name": "b_hours",
                        "display_name": "Business Hour(s)"
                    },
                    {
                        "name": "b_days",
                        "display_name": "Business Day(s)"
                    }
                ],
                "minimum_values": {
                    "unit": 15,
                    "period": "minutes"
                }
            },
            "process": {
                "name": {
                    "unsupported_characters": [
                        "`",
                        "~",
                        "!",
                        "#",
                        "^",
                        "*",
                        "["
                    ]
                }
            }
        }
    ]
}
```

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

### Fetch a file with GET /files

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

Sample requests to fetch a file from Zoho CRM using its encrypted ID. The curl example uses a GET request with an OAuth token in the Authorization header. The Deluge example uses the invokeurl function with a CRM OAuth connection.

```curl
curl "https://www.zohoapis.com/crm/v8/files?id=2cceafa194dxxxxxxxx4a20ed2"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
```

```deluge
response = invokeurl
[
	url: "https://www.zohoapis.com/crm/v8/files?id=2cceafa194dxxxxxxxx4a20ed2"
	type: GET
	connection:"crm_oauth_connection"
];
info response;
```

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

### Sample Response: Lead Conversion Options

Source: https://www.zoho.com/crm/developer/docs/api/v8/lead-conversion-options.html

JSON response showing matching Accounts, Contacts, and module preferences. Includes fields like module_preference, preference_field_matched_value, and modules_with_multiple_layouts.

```json
{
    "__conversion_options": {
        "module_preference": {
            "api_name": "Accounts",
            "id": "3652397000000002177"
        },
        "Contacts": null,
        "preference_field_matched_value": {
            "Contacts": null,
            "Accounts": [
                {
                    "field": {
                        "api_name": "Account_Name",
                        "id": "3652397000000002425"
                    },
                    "matched_lead_value": "Zylker"
                }
            ]
        },
        "Accounts": [
            {
                "Layout": {
                    "name": "Standard",
                    "id": "3652397000000091029"
                },
                "Phone": "555555555",
                "Account_Type": "Analyst",
                "Website": null,
                "Account_Name": "Zylker",
                "$editable": true,
                "id": "3652397000000624046"
            }
        ],
        "modules_with_multiple_layouts": [
            {
                "api_name": "Accounts",
                "id": "3652397000000002177"
            }
        ]
    }
}
```

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

### Get Mass Update Status - Sample Requests (curl and Deluge)

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

Sample requests to get the status of a mass update job using the job_id. The curl example uses the Zoho CRM REST API v8 endpoint for Accounts, while the Deluge example uses the invokeurl function with a crm_oauth_connection. Both use the GET method and require an OAuth token with the ZohoCRM.mass_update.READ scope.

```curl
curl "https://www.zohoapis.com/crm/v8/Accounts/actions/mass_update?job_id=554023000000506003"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
```

```deluge
response = invokeurl
[
	url: "https://www.zohoapis.com/crm/v8/Accounts/actions/mass_update?job_id= 554023000000506003s"
	type: GET
	connection:"crm_oauth_connection"
];
info response;
```

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

### GET /__apis Sample Request

Source: https://www.zoho.com/crm/developer/docs/api/v8/list-available-rest-apis.html

Sample request to retrieve the list of supported APIs for version 8. Uses the GET method and requires an OAuth token in the Authorization header. The response is not shown in the source.

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

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

### Sample Response: Create Portal

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

JSON response indicating successful portal creation.

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

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

### Get list of attachments with curl and Deluge

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

Sample request to get the list of attachments for a record. The curl example uses the Authorization header with a Zoho OAuth token, and the Deluge example uses the invokeurl function with a connection named crm_oauth_connection. Both target the same endpoint and fields parameter.

```curl
curl "https://www.zohoapis.com/crm/v8/Leads/4876876000000376008/Attachments?fields=id,Owner,File_Name,Created_Time,Parent_Id"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
```

```deluge
response = invokeurl
[
	url: "https://www.zohoapis.com/crm/v8/Leads/4876876000000376008/Attachments?fields=id,Owner,File_Name,Created_Time,Parent_Id"
	type: GET
	connection:"crm_oauth_connection"
];
info response;
```

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

### Get Services - Sample Request (curl)

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

Sample curl command to fetch services data with specified fields. Uses the GET method and requires an OAuth token in the Authorization header.

```bash
curl "https://www.zohoapis.com/crm/v8/Services__s?fields=Service_Name,Location,Job_Sheet_Required"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
```

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

### Get Variables API Sample Requests (curl and Deluge)

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

Sample requests to retrieve all variables from the Zoho CRM Variables API. The curl example uses a GET request with an Authorization header; the Deluge example uses invokeurl with a crm_oauth_connection. Both target the same endpoint and require the ZohoCRM.settings.variables.READ scope.

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

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

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

### Get Deleted Records - Sample Request (curl and Deluge)

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

Sample request to retrieve all deleted records from the Leads module. The curl example uses a GET request with an OAuth token header, while the Deluge example uses the invokeurl function with a crm_oauth_connection. Both target the same endpoint and type parameter.

```curl
curl "https://www.zohoapis.com/crm/v8/Leads/deleted?type=all"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
```

```deluge
response = invokeurl
[
	url: "https://www.zohoapis.com/crm/v8/Leads/deleted?type=all"
	type: GET
	connection:"crm_oauth_connection"
];
info response;
```

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

### Create Kiosk GetRecords - Sample Response JSON

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

Sample response for a successful GetRecords configuration creation. Returns a success code, the new configuration ID, and a success message.

```json
{
    "get_records": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "5725767000010201002"
            },
            "message": "Get record created successfully",
            "status": "success"
        }
    ]
}
```

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

### Sample Request: List Function Runtimes

Source: https://www.zoho.com/crm/developer/docs/api/v8/list-function-runtimes.html

Use this curl command to retrieve the list of supported runtimes. It requires an OAuth token with the ZohoCRM.settings.functions.READ, ZohoCRM.settings.functions.ALL, or ZohoCRM.settings.ALL scope.

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

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

### GET /settings/fiscal_year

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

Retrieves the fiscal year settings of your organization. This endpoint returns the display basis (start or end month) and the start month of the fiscal year.

```APIDOC
## GET /settings/fiscal_year

### Description
Retrieves the fiscal year settings of your organization. This endpoint returns the display basis (start or end month) and the start month of the fiscal year.

### Method
GET

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

### Parameters
#### Header
- **Authorization** (string) - Required - Zoho OAuth token. Example: `Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`
- **scope** (string) - Required - OAuth scope. Must be `ZohoCRM.settings.fiscal_year.READ`

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

### Response
#### Success Response (200)
- **fiscal_year** (object) - Contains fiscal year settings.
  - **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.
  - **id** (string) - Unique identifier of the fiscal year setting.

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

### Possible Errors
- **INVALID_URL_PATTERN** (HTTP 404) - The request URL is incorrect. Provide a valid request URL.
- **OAUTH_SCOPE_MISMATCH** (HTTP 401) - Unauthorized. Client does not have the required scope.
- **NO_PERMISSION** (HTTP 403) - Permission denied. User lacks permission to read fiscal year settings.
- **INTERNAL_ERROR** (HTTP 500) - Internal server error.
- **INVALID_REQUEST_METHOD** (HTTP 400) - Invalid HTTP method used.
- **AUTHORIZATION_FAILED** (HTTP 400) - User does not have sufficient privilege.
```

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

### Get Roles - Sample Response

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

Example JSON response for the Get Roles API, showing a role object with fields like display_label, share_with_peers, and reporting_to.

```json
{
    "roles": [
        {
            "display_label": "SalesRep",
            "created_by__s": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "modified_by__s": {
                "name": "Patricia Boyle",
                "id": "3652397000000186017"
            },
            "forecast_manager": null,
            "share_with_peers": true,
            "modified_time__s": "2022-11-10T17:25:02+05:30",
            "name": "SalesRep",
            "description": null,
            "reporting_to": {
                "name": "Manager",
                "id": "3652397000000026008"
            },
            "id": "3652397000010189001",
            "created_time__s": "2022-11-10T17:25:02+05:30"
        }
    ]
}
```

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

### Sample input JSON for creating a user group

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

Example input payload with user group name, description, and sources array containing users, roles, and territories.

```json
{
    "user_groups": [
        {
            "name": "test group",
            "description": "my group",
            "sources": [
                {
                    "source": {
                        "name": "Patricia Boyle",
                        "id": "3652397000000186017"
                    },
                    "type": "users"
                },
                {
                    "source": {
                        "name": "Manager",
                        "id": "3652397000000026008"
                    },
                    "type": "roles",
                    "subordinates": true
                },
                {
                    "source": {
                        "name": "New York",
                        "id": "3652397000007622003"
                    },
                    "type": "territories",
                    "subordinates": true
                },
                {
                    "source": {
                        "name": "Deborah Gill",
                        "id": "3652397000000281001"
                    },
                    "type": "users"
                }
            ]
        }
    ]
}
```

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

### Download a record photo using curl and Deluge

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

Sample requests to download the photo of a Leads record with ID 3000000038009. The curl example uses the GET method with an OAuth token in the Authorization header. The Deluge example uses the invokeurl function with a GET request and a connection named crm_oauth_connection.

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

```deluge
response = invokeurl
[
	url: "https://www.zohoapis.com/crm/v8/Leads/3000000038009/photo"
	type: GET
	connection:"crm_oauth_connection"
];
info response;
```

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

### Sample response JSON for creating a user group

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

Example success response with the created user group's ID and a success message.

```json
{
    "user_groups": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "5725767000002350003"
            },
            "message": "User Group Created successfully",
            "status": "success"
        }
    ]
}
```

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

### Sample Response: Connected workflow configurations JSON

Source: https://www.zoho.com/crm/developer/docs/api/v8/connected-workflow-configurations.html

Example response showing the configuration limits for connected workflows, including the maximum number of workflows, modules per process, rules per module, and action limits per rule.

```json
{
    "configurations": {
        "connected_workflows_limit": 10,
        "modules_limit_per_process": 15,
        "rules": {
            "limit_per_module": 10,
            "actions": [
                {
                    "limit": 5,
                    "name": "field_updates"
                },
                {
                    "limit": 3,
                    "name": "email_notifications"
                },
                {
                    "limit": 3,
                    "name": "create_connected_record"
                }
            ]
        }
    }
}
```

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

### Create Role - Sample Response (JSON)

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

Sample response after successfully creating a role. Contains the role ID, a success message, and status.

```json
{
    "roles": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "5843104000002870001"
            },
            "message": "Role added",
            "status": "success"
        }
    ]
}
```

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

### Get Fields Metadata for Leads (curl and Deluge)

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

Retrieves metadata for fields in the Leads module. The curl example uses a Zoho OAuth token; the Deluge example uses a named connection 'crm_oauth_connection'.

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

```deluge
response = invokeurl
[
	url: "https://www.zohoapis.com/crm/v8/settings/fields?module=Leads"
	type: GET
	connection:"crm_oauth_connection"
];
info response;
```

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

### COQL subquery sequence example

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

Example request body for a COQL query that uses multiple subqueries in the WHERE clause. The subqueries are executed in a specific sequence starting from index 0, and the outer query relies on their results.

```json
{
"select_query" : "select id from Contacts where (Account_Name in (select id from Accounts where id is not null) and  Created_Time between (select Created_Time from Accounts where Account_Name like 'A%' Limit 1) and (select Created_Time from Accounts where Account_Name like 'B%' Limit 1)) and  Vendor_Name in (select id from Vendors where id in (select id from Vendors where Vendor_Name like 'V%'))"
}
                        
```

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

### Sample Request: GET /settings/fields?module=Leads

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

Sample request to retrieve field metadata for the Leads module. Uses the GET /settings/fields endpoint with the module parameter and an OAuth token in the Authorization header.

```bash
curl "https://www.zohoapis.com/crm/v8/settings/fields?module=Leads"
-X GET
-H  "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
```

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

### Sample Input - Assign Owner

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

Example JSON for an assign_owner action state, specifying module, assign_to with user resource, related_records, notify, and user_availability_based_on.

```json
{
    "states": [
        {
            "name": "Assign Owner",
            "details": {
                "type": "assign_owner",
                "assign_owner": {
                    "module": {
                        "api_name": "Contacts"
                    },
                    "assign_to": [
                        {
                            "resource": {
                                "id": "5039614000000709001",
                                "name": "Patricia Boyle"
                            },
                            "type": "user"
                        }
                    ],
                    "related_records": [
                        {
                            "api_name": "Tasks"
                        },
                        {
                            "api_name": "Deals"
                        }
                    ],
                    "notify": true,
                    "user_availability_based_on": null
                }
            }
        }
    ]
}
```

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

### Get Assignment Rule - Sample Response

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

Example response for the Get Assignment Rule request. Contains the assignment rule details including rule entries, criteria, assignee, follow-up actions, and module information.

```json
{
    "assignment_rules": [
        {
            "created_time": "2026-01-21T00:00:00+05:30",
            "rule_entries": [
                {
                    "sequence_number": 1,
                    "criteria": {
                        "comparator": "contains",
                        "field": {
                            "api_name": "Email",
                            "id": "5276164000000000563"
                        },
                        "type": "value",
                        "value": "zohocrm@mail.com"
                    },
                    "assign_to": {
                        "resource": {
                            "name": "CEO",
                            "id": "5276164000000015966"
                        },
                        "type": "role"
                    },
                    "user_availability_based_on": [
                        "online_status"
                    ],
                    "followup_actions": [
                        {
                            "resources": [
                                {
                                    "name": "Follow up - ${Leads.Last Name} for ${Leads.Company}",
                                    "id": "5725767000000416363"
                                }
                            ],
                            "type": "tasks"
                        }
                    ],
                    "id": "5276164000003551119"
                }
            ],
            "modified_time": "2026-01-21T00:00:00+05:30",
            "api_name": "Lead_Rule_with_type_role",
            "default_assignee": {
                "resource": {
                    "api_name": "${CURRENTUSER}",
                    "name": "Logged in User"
                },
                "name": "Logged in User",
                "id": "${CURRENTUSER}",
                "type": "user"
            },
            "module": {
                "api_name": "Leads",
                "name": "Leads",
                "id": "5276164000000000125"
            },
            "name": "Lead Rule with type role",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "5276164000000471001"
            },
            "description": "Assigning all Lead records",
            "id": "5276164000003551117",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "5276164000000471001"
            }
        }
    ]
}
```

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

### Sample Response for Get Layout-specific Wizard

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

This is the sample response for the GET request to fetch a layout-specific wizard. It returns a wizards array containing wizard details such as module, profiles, containers with layout and screens, and timestamps.

```json
{
    "wizards": [
        {
            "created_time": "2023-12-06T16:56:25+05:30",
            "modified_time": "2023-12-06T18:40:27+05:30",
            "portal_user_types": null,
            "module": {
                "api_name": "Leads",
                "id": "2423488000000000125"
            },
            "name": "test",
            "modified_by": {
                "name": "Patricia",
                "id": "2423488000000483001"
            },
            "profiles": [
                {
                    "display_label": "Administrator",
                    "name": "Administrator",
                    "id": "2423488000000026011"
                }
            ],
            "active": true,
            "containers": [
                {
                    "layout": {
                        "display_label": "Standard",
                        "name": "Standard",
                        "id": "2423488000000091055"
                    },
                    "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"
                        },
                        {
                            "display_label": "Screen 4",
                            "api_name": "Screen_4",
                            "id": "5725767000004742103"
                        },
                        {
                            "display_label": "Screen 5",
                            "api_name": "Screen_5",
                            "id": "5725767000004742105"
                        },
                        {
                            "display_label": "Screen 6",
                            "api_name": "Screen_6",
                            "id": "5725767000004742107"
                        }
                    ],
                    "id": "5725767000000091055"
                }
            ],
            "id": "5725767000004742095",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "5725767000000411001"
            }
        }
    ]
}
```

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

### Get Organization Data - Sample Response

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

Example response from the Organization API showing hipaa_compliance_enabled set to true.

```json
{
  "org": [
    {
      "country": "US",
      "photo_id": null,
      "city": null,
      "description": null,
      "mc_status": true,
      "gapps_enabled": false,
      "domain_name": "org55528254",
      "translation_enabled": false,
      "street": null,
      "alias": null,
      "currency": "Indian Rupee",
      "id": "111111000000033001",
      "state": null,
      "fax": null,
      "employee_count": null,
      "zip": null,
      "website": "www.zylker.com",
      "currency_symbol": "₹",
      "mobile": null,
      "currency_locale": "en_IN",
      "primary_zuid": "55528367",
      "zia_portal_id": "59075125",
      "time_zone": "Asia/Calcutta",
      "zgid": "55528254",
      "country_code": "IN",
      "license_details": {
        "paid_expiry": null,
        "users_license_purchased": 3,
        "trial_type": "professional",
        "trial_expiry": "2018-05-17T17:20:05+05:30",
        "paid": false,
        "paid_type": "free"
      },
      "phone": "7867984524",
      "company_name": "Zylker",
      "privacy_settings": true,
      "primary_email": "p.boyle@zylker.com",
      "hipaa_compliance_enabled": true,
      "iso_code": "INR"
    }
  ]
}
```

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

### Get user groups with single criteria filter

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

GET request using a single criteria in the 'filters' parameter. The filter is URL-encoded and matches groups whose name starts with 'Test'. The response shows the matching group.

```curl
curl "https://www.zohoapis.com/crm/v8/settings/user_groups?filters=%7B%22field%22%3A%20%7B%22api_name%22%3A%20%22name%22%7D%2C%22comparator%22%3A%20%22starts_with%22%2C%20%22value%22%3A%20%22Test%22%7D"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
```

```json
{
    "user_groups": [
        {
            "created_time": "2024-07-08T21:37:06+05:30",
            "modified_time": "2024-07-08T21:37:19+05:30",
            "name": "Test",
            "modified_by": {
                "name": "Patricia",
                "id": "2276164000000471001"
            },
            "description": null,
            "id": "2276164000001042069",
            "created_by": {
                "name": "Patricia",
                "id": "2276164000000471001"
            }
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}
```
Tokens:
Raw