REST API - List Form Fields

URL

To list all fields in a Form:

https://creator.zoho.com/api/<format>/<applicationName>/<formName>/fields

where,

<applicationName> and <formName>These are the link names of your application and form, respectively. These can be referred here.
<format>This is the type of response format as listed below.

Formats

xml, json

HTTP Method

GET

Parameters

Parameter NameUsageDescription
authtokenRequiredA valid API authtoken. Refer this page to generate authtoken.
scopeRequiredSpecify the value as creatorapi
zc_ownernameRequiredThe owner of the application.

Prerequisites

Notes

  • Only the owner can see the list of fields in a form.

Sample Request

<form method="GET" action="https://creator.zoho.com/api/xml/sample/Employee/fields">
<input type="hidden" name ="authtoken" value="************">
<input type="hidden" name ="scope" id="scope" value="creatorapi">
<input type="submit" value="List Forms and Views in Application">
</form>

Sample Response

XML response

<?xml version="1.0" encoding="UTF-8" ?>
<result>
<DisplayName>Employee</DisplayName>
<Fields>
<DisplayName>Name</DisplayName>
<Type>1</Type>
<MaxChar>255</MaxChar>
<Initial/>
<FieldName>Name</FieldName>
<Reqd>true</Reqd>
</Fields>
<Fields>
<DisplayName>DOB</DisplayName>
<Type>10</Type>
<Initial/>
<FieldName>DOB</FieldName>
<Reqd>false</Reqd>
</Fields>
<Fields>
<DisplayName>Address</DisplayName>
<Type>3</Type>
<FieldName>Address</FieldName>
<Reqd>false</Reqd>
</Fields>
<Fields>
<DisplayName>Basic</DisplayName>
<Type>5</Type>
<MaxChar>10</MaxChar>
<Initial/>
<FieldName>Basic</FieldName>
<Reqd>false</Reqd>
</Fields>
</result>

JSON response

{"application-name":["sample",{"form-name":["Employee",{"DisplayName":"Employee","Fields":[{"DisplayName":"Name","Type":1,"MaxChar":255,"Initial":"","FieldName":"Name","Reqd":false},{"DisplayName":"DOB","Type":10,"Initial":"","FieldName":"DOB","Reqd":false},{"DisplayName":"Address","Type":3,"FieldName":"Address","Reqd":false},{"DisplayName":"Basic","Type":5,"MaxChar":10,"Initial":"","FieldName":"Basic","Reqd":false}]}]}]}

Error Codes

If there is an error in the request format, the corresponding error code with error message will be displayed. Please refer to the topic Error codes and descriptions to know about them. If the operation is successful, the response message will be displayed with status as "Success".