Get Fields of Form API

Use the Fetch Component API to retrieve the list of field components available in a form with an ID.

Request URL:

https://people.zoho.com/people/api/forms/<formLinkName>/components

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Scope:

ZOHOPEOPLE.form.READ

Possible Operation Types:

READ - Read form data

Request Parameters:

PARAMETERS	VALUES ALLOWED	DEFAULT VALUE	PARAMETER DESCRIPTION	MANDATORY
formLinkName		-	Refer Appendix Point 1, to know how to get the formLinkname of the form	Yes

Error Codes and Descriptions

ERROR CODE	ERROR DESCRIPTION
7011	Form name '<formLinkName>' is invalid

Threshold Limit: 400 requests | Lock period: 5 minutes

Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.

Request

Copiedhttps://people.zoho.com/api/forms/employee/components

Sample Response

Copied{
  "response": {
    "result": [
      {
        "comptype": "Email",
        "ismandatory": true,
        "descriptionType": 0,
        "displayname": "Email address",
        "autofillvalue": "",
        "description": "",
        "formcomponentid": 759415000000036259,
        "labelname": "EmailID",
        "maxLength": 100
      },
      {
        "comptype": "Text",
        "ismandatory": true,
        "descriptionType": 0,
        "displayname": "First Name",
        "autofillvalue": "",
        "description": "",
        "formcomponentid": 759415000000036255,
        "labelname": "FirstName",
        "maxLength": 100
      },
      {
        "comptype": "Lookup",
        "Options": {
          "Option1": {
            "Value": "John Doe",
            "Id": "759415000000240001"
          }
        },
        "description": "",
        "labelname": "AddedBy",
        "ismandatory": false,
        "displayType": "Pick_List",
        "descriptionType": 0,
        "ReferedFormId": 759415000000035679,
        "isPrimary": false,
        "displayname": "Added By",
        "autofillvalue": "",
        "formcomponentid": 759415000000163179,
        "ReferedFormName": "P_Employee",
        "ReferedFieldId": 759415000000036253,
        "ReferedFieldName": "EmployeeID"
      },
      {
        "tabularSections": [
          {
            "WorkExperience": [
              {
                "comptype": "Text",
                "ismandatory": true,
                "descriptionType": 0,
                "displayname": "Company name",
                "autofillvalue": "",
                "description": "",
                "formcomponentid": 759415000000036291,
                "labelname": "Employer",
                "maxLength": 100
              }
            ],
            "sectionId": 759415000000036001
          }
        ]
      }
    ],
    "message": "Data fetched successfully",
    "uri": "/api/forms/employee/components",
    "status": 0
  }
}

Show full

Show less

Response

Java JavaScript Curl Deluge Python

CopiedOkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
Request request = new Request.Builder()
  .url("https://people.zoho.com/api/forms/employee/components")
  .get()
  .addHeader("Authorization", "••••••")
  .addHeader("Cookie", "CSRF_TOKEN=790891fd-6d6f-40fd-8381-8e81176e2d2f; _zcsr_tmp=790891fd-6d6f-40fd-8381-8e81176e2d2f; _zpsid=C9B0C2739FAE8B31975D2F7745237EFA; zalb_c7cb34e6ac=15579241ea20d8d7fa5eb5f3fb79c37a")
  .build();
Response response = client.newCall(request).execute();

Copiedconst myHeaders = new Headers();
myHeaders.append("Authorization", "••••••");
myHeaders.append("Cookie", "CSRF_TOKEN=790891fd-6d6f-40fd-8381-8e81176e2d2f; _zcsr_tmp=790891fd-6d6f-40fd-8381-8e81176e2d2f; _zpsid=C9B0C2739FAE8B31975D2F7745237EFA; zalb_c7cb34e6ac=15579241ea20d8d7fa5eb5f3fb79c37a");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("https://people.zoho.com/api/forms/employee/components", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

Copiedcurl --location 'https://people.zoho.com/api/forms/employee/components' \
--header 'Authorization: ••••••' \
--header 'Cookie: CSRF_TOKEN=790891fd-6d6f-40fd-8381-8e81176e2d2f; _zcsr_tmp=790891fd-6d6f-40fd-8381-8e81176e2d2f; _zpsid=C9B0C2739FAE8B31975D2F7745237EFA; zalb_c7cb34e6ac=15579241ea20d8d7fa5eb5f3fb79c37a'

CopiedAuthMap = Collection();
AuthMap.insert("Authorization":"••••••");

response = invokeUrl
[
 	url: "https://people.zoho.com/api/forms/employee/components"
 	type: GET
 	headers: AuthMap.toMap()
];
info response;

Copiedimport requests

url = "https://people.zoho.com/api/forms/employee/components"

payload = {}
headers = {
  'Authorization': '••••••',
  'Cookie': 'CSRF_TOKEN=790891fd-6d6f-40fd-8381-8e81176e2d2f; _zcsr_tmp=790891fd-6d6f-40fd-8381-8e81176e2d2f; _zpsid=C9B0C2739FAE8B31975D2F7745237EFA; zalb_c7cb34e6ac=15579241ea20d8d7fa5eb5f3fb79c37a'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Show full

Show less