Subform API

A subform is a secondary form or a table, which will enable you to include multiple line items into a primary form. They are used to associate multiple items to a single record. On a more technical perspective, subforms easily solve the need for you to establish a one-to-many relationship with data in your CRM, in which many secondary items are associated to a single primary record.

Points-to-remember

The parent Module API name can be acquired using the modules API.
The Field API names of the subform can be acquired using Fields Metadata API of the parent module.
The Field API names of the individual fields in a subform can be acquired using Fields Metadata API, with the request URL as "fields?module={Sub_form_api_name}".
The following editions support subform fields: Enterprise, Zoho One, Ultimate, and CRM Plus.
- The Enterprise and Zoho One editions support a maximum of two subform fields in a module, while the Ultimate and CRM Plus editions support five subform fields in a module. Each subform field can have a maximum of 100 subform records in a single record in a module.
A maximum of 5 aggregate custom fields are available for a subform.

Get Subform Data

Purpose

To get the subform data in a record.

Endpoints

GET /{module_api_name}/{record_id}

GET /{subform_api_name}

Request Details

Request URL

{api-domain}/crm/{version}/{module_api_name}/{record_id}
(or)
{api-domain}/crm/{version}/{subform_api_name}

Supported modules

Leads, Accounts, Contacts, Deals, Campaigns, Cases, Solutions, Products, Vendors, Quotes, Sales Orders, Purchase Orders, Invoices and Custom.

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.modules.{module_name}.{operation_type}

Possible module names

leads, accounts, contacts, deals, campaigns, cases, solutions, products, vendors, quotes, salesorders, purchaseorders, invoices and custom.

Possible operation types

ALL - Full access to a record
READ - Get records in a module

Note

You can get the API name of the subform from the Fields Metadata API.
Refer Response Structure for more details about the JSON keys, values, and their descriptions.

Sample Request

Curl Java PHP Csharp Python Node JS Ruby Deluge

Copiedcurl "https://www.zohoapis.com/crm/v2.1/Contacts/554023000000298003"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

8.0

Copiedpackage com.zoho.crm.api.sample.restapi.subform;
import javax.net.ssl.SSLContext;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.conn.ssl.NoopHostnameVerifier;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.util.EntityUtils;
public class SubformAPI 
{
	private static void getSubforms()
	{
		try
		{
			HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
			SSLContext sslContext = SSLContext.getDefault();
			SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
			CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();
			URIBuilder uriBuilder = new URIBuilder("https://www.zohoapis.com/crm/v2.1/Subform_1");
			uriBuilder.addParameter("ids", "34770617420006");
			uriBuilder.addParameter("fields", "Name1,Email");
			uriBuilder.addParameter("page", "1");
			uriBuilder.addParameter("per_page", "4");
			HttpUriRequest requestObj = new HttpGet(uriBuilder.build());
			requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
			requestObj.addHeader("If-Modified-Since", "2020-10-12T17:59:50+05:30");
			HttpResponse response = httpclient.execute(requestObj);
			HttpEntity responseEntity = response.getEntity();
			System.out.println("HTTP Status Code : " + response.getStatusLine().getStatusCode());
			if(responseEntity != null)
			{
				Object responseObject = EntityUtils.toString(responseEntity);
				String responseString = responseObject.toString();
				System.out.println(responseString);
			}
		}
		catch(Exception ex)
		{
			ex.printStackTrace();
		}
	}
	private static void getSubform()
	{
		try
		{
			HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
			SSLContext sslContext = SSLContext.getDefault();
			SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
			CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();
			URIBuilder uriBuilder = new URIBuilder("https://www.zohoapis.com/crm/v2.1/Subform_1/34770617420006");
			uriBuilder.addParameter("fields", "Name1,Email");
			HttpUriRequest requestObj = new HttpGet(uriBuilder.build());
			requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
			requestObj.addHeader("If-Modified-Since", "2019-10-12T17:59:50+05:30");
			HttpResponse response = httpclient.execute(requestObj);
			HttpEntity responseEntity = response.getEntity();
			System.out.println("HTTP Status Code : " + response.getStatusLine().getStatusCode());
			if(responseEntity != null)
			{
				Object responseObject = EntityUtils.toString(responseEntity);
				String responseString = responseObject.toString();
				System.out.println(responseString);
			}
		}
		catch(Exception ex)
		{
			ex.printStackTrace();
		}
	}
	public static void main(String[] args) 
	{
		getSubforms();
		getSubform();
	}
}

7.x

Copied<?php
class GetSubform{
    
    public function execute(){
        $curl_pointer = curl_init();
        
        $curl_options = array();
        $url = "https://www.zohoapis.com/crm/v2.1/Subform_1?";
        $parameters = array();
        $parameters["page"]="1";
        
        foreach ($parameters as $key=>$value){
            $url =$url.$key."=".$value."&";
        }
        $curl_options[CURLOPT_URL] = $url;
        $curl_options[CURLOPT_RETURNTRANSFER] = true;
        $curl_options[CURLOPT_HEADER] = 1;
        $curl_options[CURLOPT_CUSTOMREQUEST] = "GET";
        $headersArray = array();
        $headersArray[]= "If-Modified-Since".":"."2020-10-12T17:59:50+05:30";
        $headersArray[] = "Authorization". ":" . "Zoho-oauthtoken " ."1000.30f3a589XXXXXXXXXXXXXXXXXXX4077.dc5XXXXXXXXXXXXXXXXXXXee9e7c171c";
        $curl_options[CURLOPT_HTTPHEADER]=$headersArray;
        
        curl_setopt_array($curl_pointer, $curl_options);
        
        $result = curl_exec($curl_pointer);
        $responseInfo = curl_getinfo($curl_pointer);
        curl_close($curl_pointer);
        list ($headers, $content) = explode("\r\n\r\n", $result, 2);
        if(strpos($headers," 100 Continue")!==false){
            list( $headers, $content) = explode( "\r\n\r\n", $content , 2);
        }
        $headerArray = (explode("\r\n", $headers, 50));
        $headerMap = array();
        foreach ($headerArray as $key) {
            if (strpos($key, ":") != false) {
                $firstHalf = substr($key, 0, strpos($key, ":"));
                $secondHalf = substr($key, strpos($key, ":") + 1);
                $headerMap[$firstHalf] = trim($secondHalf);
            }
        }
        $jsonResponse = json_decode($content, true);
        if ($jsonResponse == null && $responseInfo['http_code'] != 204) {
            list ($headers, $content) = explode("\r\n\r\n", $content, 2);
            $jsonResponse = json_decode($content, true);
        }
        var_dump($headerMap);
        var_dump($jsonResponse);
        var_dump($responseInfo['http_code']);
        
    }
    
}
(new GetSubform())->execute();

8.x

Copiedusing System;
using System.IO;
using System.Net;
using System.Xml;
using Newtonsoft.Json;
namespace Com.Zoho.Crm.API.Sample.RestAPI.Subform
{
    public class SubformAPI
    {
        public static void GetSubforms()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2.1/Subform_1?ids=34770617420006");
            request.Method = "GET";
            request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
            string IfModifiedSince = JsonConvert.SerializeObject("2020-05-15T12:00:00+05:30");
            IfModifiedSince = IfModifiedSince.Replace("\\", "");
            IfModifiedSince = IfModifiedSince.Replace("\"", "");
            DateTime dateConversion = XmlConvert.ToDateTime(IfModifiedSince, XmlDateTimeSerializationMode.Utc);
            request.IfModifiedSince = dateConversion;
            request.KeepAlive = true;
            HttpWebResponse response;
            try
            {
                response = (HttpWebResponse)request.GetResponse();
            }
            catch (WebException e)
            {
                if (e.Response == null) { throw; }
                response = (HttpWebResponse)e.Response;
            }
            HttpWebResponse responseEntity = response;
            Console.WriteLine("HTTP Status Code : " + (int)response.StatusCode);
            string responsestring = new StreamReader(responseEntity.GetResponseStream()).ReadToEnd();
            responseEntity.Close();
            Console.WriteLine(responsestring);
        }
        public static void GetSubform()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2.1/Subform_1/34770617420006?fields=Name1,Email");
            request.Method = "GET";
            request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
            string IfModifiedSince = JsonConvert.SerializeObject("2020-05-15T12:00:00+05:30");
            IfModifiedSince = IfModifiedSince.Replace("\\", "");
            IfModifiedSince = IfModifiedSince.Replace("\"", "");
            DateTime dateConversion = XmlConvert.ToDateTime(IfModifiedSince, XmlDateTimeSerializationMode.Utc);
            request.IfModifiedSince = dateConversion;
            request.KeepAlive = true;
            HttpWebResponse response;
            try
            {
                response = (HttpWebResponse)request.GetResponse();
            }
            catch (WebException e)
            {
                if (e.Response == null) { throw; }
                response = (HttpWebResponse)e.Response;
            }
            HttpWebResponse responseEntity = response;
            Console.WriteLine("HTTP Status Code : " + (int)response.StatusCode);
            string responsestring = new StreamReader(responseEntity.GetResponseStream()).ReadToEnd();
            responseEntity.Close();
            Console.WriteLine(responsestring);
        }
    }
}

3.x.x

Copieddef get_subforms():
    import requests

    url = 'https://www.zohoapis.com/crm/v2.1/Subform_2'

    headers = {
        'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268',
        'If-Modified-Since': '2020-03-19T17:59:50+05:30'
    }

    parameters = {
        'ids': '3409643000002804510,3409643000002804209',
        'fields': 'Last_Name,Email',
        'page': '1',
        'per_page': '10'
    }

    response = requests.get(url=url, headers=headers, params=parameters)

    if response is not None:
        print("HTTP Status Code : " + str(response.status_code))

        print(response.json())

get_subforms()


def get_subform():
    import requests

    url = 'https://www.zohoapis.com/crm/v2.1/Subform_2/3409643000002804510'

    headers = {
        'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268',
        'If-Modified-Since': '2020-03-19T17:59:50+05:30'
    }

    parameters = {
        'fields': 'Last_Name,Email'
    }

    response = requests.get(url=url, headers=headers, params=parameters)

    if response is not None:
        print("HTTP Status Code : " + str(response.status_code))

        print(response.json())

get_subform()

10.x

Copiedasync function getSubforms() {
    const got = require("got");

    let url = 'https://www.zohoapis.com/crm/v2.1/Subform_1'

    let headers = {
        Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf",
        'If-Modified-Since': '2020-03-19T17:59:50+05:30'
    }

    let parameters = {
        'ids': '3409643000002804510,3409643000002804209',
        'fields': 'Name1,Email',
        'page': '1',
        'per_page': '10'
    }

    let requestDetails = {
        method : "GET",
        headers : headers,
        searchParams : parameters,
        throwHttpErrors : false
    }
    
    let response = await got(url, requestDetails)
    
    if(response != null) {
        console.log(response.statusCode);
        console.log(response.body);
    }
}

getSubforms()

async function getSubform() {
    const got = require("got");

    let url = 'https://www.zohoapis.com/crm/v2.1/Subform_1/3409643000002804510'

    let headers = {
        Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf",
        'If-Modified-Since': '2020-03-19T17:59:50+05:30'
    }

    let parameters = {
        'fields': 'Name1,Email'
    }

    let requestDetails = {
        method : "GET",
        headers : headers,
        searchParams : parameters,
        throwHttpErrors : false
    }
    
    let response = await got(url, requestDetails)
    
    if(response != null) {
        console.log(response.statusCode);
        console.log(response.body);
    }
}
getSubform()

Copiedrequire 'net/http'
require 'json'

class GetSubform 

    def execute
        parameters ={}
        parameters["page"]="1"
        query_string = parameters.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join('&')
        url= "https://www.zohoapis.com/crm/v2.1/Subform_1"
        url += '?' + query_string if !query_string.nil? && (query_string.strip != '')
        url = URI(url)
        req = Net::HTTP::Get.new(url.request_uri)
        http = Net::HTTP.new(url.host, url.port)
        http.use_ssl = true
        headers={}
        headers["Authorization"]="Zoho-oauthtoken 1000.dfa7XXXXXXXXXXXXXXXXXX84f9665840.c176aeXXXXXXXXXXXX13f3d37a84d"
        headers&.each { |key, value| req.add_field(key, value) }
        response=http.request(req)
        status_code = response.code.to_i
        headers = response.each_header.to_h
        print status_code
        print headers
        unless response.body.nil?
            print  response.body
        end
    end
end
GetSubform.new.execute

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/crm/v2.1/Contacts/554023000000298003"
	type: GET
	connection:"crm_oauth_connection"
];
info response;

Possible Errors

INVALID_MODULEHTTP 400
The module name given seems to be invalid
Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name.
INVALID_MODULEHTTP 400
The given module is not supported in API
Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). Specify a valid module API name.
INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.
OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoCRM.modules.{module_name}.READ scope. Create a new client with valid scope. Refer to scope section above.
NO_PERMISSIONHTTP 403
Permission denied to read
Resolution: The user does not have permission to read subform records. Contact your system administrator.
INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team.
INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.
AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to read subform records
Resolution: The user does not have the permission to read subform records. Contact your system administrator.

Sample Response

Copied{
    "data": [
        {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "554023000000235011"
            },
            "Email": null,
            "$currency_symbol": "Rs.",
            "Other_Phone": null,
            "Mailing_State": null,
            "Other_State": null,
            "Languages": [
                {
                    "Proficiency": "Professional",
                    "$approval": {
                        "delegate": false,
                        "approve": false,
                        "reject": false,
                        "resubmit": false
                    },
                    "$currency_symbol": "Rs.",
                    "$process_flow": false,
                    "Languages_Known": "English",
                    "Parent_Id": {
                        "name": "Last_Name1",
                        "id": "554023000000298003"
                    },
                    "$editable": true,
                    "id": "554023000000473001",
                    "$approved": true
                },
                {
                    "Proficiency": "Native",
                    "$approval": {
                        "delegate": false,
                        "approve": false,
                        "reject": false,
                        "resubmit": false
                    },
                    "$currency_symbol": "Rs.",
                    "$process_flow": false,
                    "Languages_Known": "French",
                    "Parent_Id": {
                        "name": "Last_Name1",
                        "id": "554023000000298003"
                    },
                    "$editable": true,
                    "id": "554023000000473003",
                    "$approved": true
                }
            ],
            "Date_created": "2019-03-04",
            "Other_Country": null,
            "Last_Activity_Time": "2019-04-22T11:27:23+05:30",
            "Department": null,
            "$process_flow": false,
            "Assistant": null,
            "Mailing_Country": null,
            "id": "554023000000298003",
            "$approved": true,
            "Reporting_To": null,
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false,
                "resubmit": false
            },
            "Other_City": null,
            "Created_Time": "2019-03-04T11:51:53+05:30",
            "$editable": true,
            "No_of_Employees": null,
            "Home_Phone": null,
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "554023000000235011"
            },
            "Secondary_Email": null,
            "Description": null,
            "Vendor_Name": null,
            "Mailing_Zip": null,
            "Twitter": null,
            "Other_Zip": null,
            "Mailing_Street": null,
            "Salutation": null,
            "First_Name": null,
            "Asst_Phone": null,
            "Full_Name": "Last_Name1",
            "Record_Image": null,
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "554023000000235011"
            },
            "Skype_ID": null,
            "Phone": null,
            "Account_Name": null,
            "Email_Opt_Out": false,
            "Modified_Time": "2019-04-22T11:27:23+05:30",
            "Date_of_Birth": null,
            "Mailing_City": null,
            "Title": null,
            "Other_Street": null,
            "Mobile": null,
            "Territories": [],
            "Last_Name": "Last_Name1",
            "Lead_Source": "Advertisement",
            "Tag": [],
            "Fax": null
        }
    ]
}

In this response, "Languages" is the subform in the Contacts module with two picklist fields "Languages_Known" and "Proficiency".