Get Fields

Overview
Request Details
Fields' Type Value
Possible Errors

Overview

This API fetches the meta information of all the fields present in a form of a Zoho Creator application.

Request Details

Request URL

https://<base_url>/creator/v2.1/meta/<account_owner_name>/<app_link_name>/form/<form_link_name>/fields

Request method

GET

Header

Key

Value

Description

Authorization

Zoho-oauthtoken

1000.8cb99dxxxxx

xxxxxxxx9be93.9b

8xxxxxxxxxxxxxxxf

An authentication token (authtoken) allows users to access apps and APIs without having to enter their login credentials each time.

environment

development/stage

Refers to the environment stage.

Note: By default, production value will be considered for the environment header.

OAuth scope

scope=ZohoCreator.meta.form.READ

where,

base_url	the base URL of your Creator account For example, it's www.zohoapis.com if your account belongs to Zoho's US DC, and is www.zohoapis.eu if it belongs to Zoho's EU DC.
account_owner_name	the username of the Creator account's owner
app_link_name	the link name of the target application
form_link_name	the link name of the target form

Fields' Type Value

The type value in the response identifies the field's type.

Field	Its "type" value	Comments
Single Line	1	-
Multi Line	2	-
Email	3	-
Rich Text	4	-
Number	5	-
Decimal	6	-
Percent	7	-
Currency	8	-
Auto Number	9	-
Date	10	-
Date-time	11	-
Drop Down	12	A field with 12 as its type value can also be a lookup field, which has its Display type set as Dropdown.
Radio	13	A field with 13 as its type value can also be a lookup field, which has its Display type set as Radio Button.
Multi Select	14	A field with 14 as its type value can also be a lookup field, which has its Display type set as Multi Select.
Checkbox	15	A field with 15 as its type value can also be a lookup field, which has its Display type set as Checkbox.
Lookup	12 / 13 / 14 / 15	The value depends on the lookup field's Display type. For example, the value will be 12 if its Display type is Dropdown, 13 if Radio Button.
Decision Box	16	-
URL	17	-
Image	18	-
File Upload	19	-
Formula	20	-
Subform	21	-
Zoho CRM	22	This field stores the display value of the selected record (that's in Zoho CRM). This field is applicable only for accounts that were created before Creator 5's release.
Zoho CRM Link	23	This field stores the ID of the selected record (that's in Zoho CRM). This field is applicable only for accounts that were created before Creator 5's release.
Add Notes	24	-
Signature	25	-
Users	26	-
Phone	27	-
Section	28	-
Name	29	-
Address	30	-
Integration	31	-
Audio	32	-
Video	33	-
Time	34	-
OCR	35	-
Object Detection	36	-
Keyword Extraction	37	-
Sentiment Analysis	38	-
Prediction	39	-

Possible Errors

Refer to this page for the list of error codes and messages.

Sample Request for Production environment (for C6 users)

Curl Deluge Java JavaScript Python

Copiedcurl "https://www.zohoapis.com/creator/v2.1/meta/jason18/zylker-store/form/Orders/fields"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Copiedresult = invokeUrl
[
    url: "https://www.zohoapis.com/creator/v2.1/meta/jason18/zylker-store/form/Orders/fields"
	type: GET
	connection: "zoho-creator"
];
info result ;

Copiedpackage main.java.org.example;

import okhttp3.HttpUrl;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import org.json.JSONException;
import org.json.JSONObject;

public class FieldsApi
{
    public static void main(String[] args) throws JSONException
    {
        OkHttpClient client = new OkHttpClient();

        HttpUrl.Builder urlBuilder = HttpUrl.parse("https://www.zohoapis.com/creator/v2.1/meta/jason18/zylker-store/form/Orders/fields").newBuilder();
        Request request = new Request.Builder()
                .url(urlBuilder.toString())
                .method("GET", null)
                .addHeader("Authorization", "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf")
                .build();
        try
        {
            JSONObject response = new JSONObject(client.newCall(request).execute().body().string());
        }
        catch (Exception e)
        {
            System.out.println("Exception while making the API request.");
        }
    }
}

Copiedlet api_headers = {
    "Authorization": "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}

try {
    let response = fetch("https://www.zohoapis.com/creator/v2.1/meta/jason18/zylker-store/form/Orders/fields", {
        method: "GET",
        headers: api_headers
    })
}
catch (exception) {
    console.error(exception)
}

Copiedimport requests

api_headers = {
    "Authorization": "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}
try:
    response = requests.get("https://www.zohoapis.com/creator/v2.1/meta/jason18/zylker-store/form/Orders/fields", headers=api_headers)
except:
    print("Exception while making the API request.")

This sample request will fetch the meta information of all the fields present in the Orders form of the Zylker Store application.

Sample Request for Development/ Stage environments (for C6 users)

Copiedcurl "https://www.zohoapis.com/creator/v2.1/meta/jason18/zylker-store/form/Orders/fields"
-X GET 
-H 'Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf'  
-H 'environment: development'

Sample Response

Copied{
  "code": 3000,
  "fields": [
    {
      "subfields": [
        {
          "is_hidden": false,
          "column_name": "prefix",
          "display_name": "Prefix",
          "link_name": "prefix",
          "choices": [
            {
              "value": "Mr.",
              "key": "Mr."
            },
            {
              "value": "Mrs.",
              "key": "Mrs."
            },
            {
              "value": "Ms.",
              "key": "Ms."
            }
          ]
        },
        {
          "is_hidden": false,
          "column_name": "first_name",
          "display_name": "First Name",
          "link_name": "first_name"
        },
        {
          "is_hidden": false,
          "column_name": "last_name",
          "display_name": "Last Name",
          "link_name": "last_name"
        },
        {
          "is_hidden": false,
          "column_name": "suffix",
          "display_name": "Suffix",
          "link_name": "suffix"
        }
      ],
      "unique": false,
      "display_name": "Name",
      "link_name": "Name",
      "type": 29,
      "mandatory": false
    },
    {
      "unique": false,
      "max_char": 255,
      "display_name": "Email",
      "link_name": "Email",
      "type": 3,
      "mandatory": false
    },
    {
      "subfields": [
        {
          "is_hidden": false,
          "column_name": "address_line_1",
          "display_name": "Address Line 1",
          "link_name": "address_line_1"
        },
        {
          "is_hidden": false,
          "column_name": "address_line_2",
          "display_name": "Address Line 2",
          "link_name": "address_line_2"
        },
        {
          "is_hidden": false,
          "column_name": "district_city",
          "display_name": "City / District",
          "link_name": "district_city"
        },
        {
          "is_hidden": false,
          "column_name": "state_province",
          "display_name": "State / Province",
          "link_name": "state_province"
        },
        {
          "is_hidden": false,
          "column_name": "postal_code",
          "display_name": "Postal Code",
          "link_name": "postal_code"
        },
        {
          "is_hidden": false,
          "column_name": "country",
          "display_name": "Country",
          "link_name": "country"
        },
        {
          "is_hidden": true,
          "column_name": "latitude",
          "display_name": "latitude",
          "link_name": "latitude"
        },
        {
          "is_hidden": true,
          "column_name": "longitude",
          "display_name": "longitude",
          "link_name": "longitude"
        }
      ],
      "unique": false,
      "display_name": "Address",
      "link_name": "Address",
      "type": 30,
      "mandatory": false
    },
    {
      "unique": false,
      "allowed_countries": "",
      "display_name": "Phone",
      "link_name": "Phone_Number",
      "type": 27,
      "mandatory": false,
      "default_country": "us"
    },
    {
      "unique": false,
      "max_char": 255,
      "display_name": "Single Line",
      "link_name": "Single_Line",
      "type": 1,
      "mandatory": false
    },
    {
      "unique": false,
      "max_char": 200,
      "display_name": "Multi Line",
      "link_name": "Multi_Line",
      "type": 2,
      "mandatory": false
    },
    {
      "unique": false,
      "display_name": "Rich Text",
      "link_name": "Rich_Text",
      "type": 4,
      "mandatory": false
    },
    {
      "decimal_length": 0,
      "unique": false,
      "max_char": 10,
      "display_name": "Number",
      "link_name": "Number",
      "type": 5,
      "mandatory": false
    },
    {
      "decimal_length": 2,
      "unique": false,
      "max_char": 10,
      "display_name": "Decimal",
      "link_name": "Decimal",
      "type": 6,
      "mandatory": false
    },
    {
      "decimal_length": 2,
      "unique": false,
      "max_char": 10,
      "display_name": "Percent",
      "link_name": "Percent",
      "type": 7,
      "mandatory": false
    },
    {
      "decimal_length": 2,
      "currency_name": "United States Dollars",
      "currency_type": 202,
      "currency_symbol": "$",
      "unique": false,
      "currency_display": "USD",
      "max_char": 10,
      "display_name": "Currency",
      "link_name": "Currency",
      "type": 8,
      "mandatory": false,
      "number_format": 1
    },
    {
      "unique": false,
      "display_name": "Date",
      "link_name": "Date_field",
      "type": 10,
      "allowed_days": "0,1,2,3,4,5,6",
      "mandatory": false
    },
    {
      "allowed_hours": [],
      "time_display_options": "hh:mm:ss",
      "unique": false,
      "display_name": "Time",
      "link_name": "Time",
      "type": 34,
      "mins_display_interval": 1,
      "mandatory": false
    },
    {
      "allowed_hours": [],
      "time_display_options": "hh:mm:ss",
      "unique": false,
      "display_name": "Date-Time",
      "link_name": "Date_Time",
      "type": 11,
      "allowed_days": "0,1,2,3,4,5,6",
      "mins_display_interval": 1,
      "mandatory": false
    },
    {
      "unique": false,
      "display_name": "Radio",
      "link_name": "Radio",
      "type": 13,
      "choices": [
        {
          "value": "Choice 1",
          "key": "Choice 1"
        },
        {
          "value": "Choice 2",
          "key": "Choice 2"
        },
        {
          "value": "Choice 3",
          "key": "Choice 3"
        }
      ],
      "mandatory": false
    },
    {
      "unique": false,
      "display_name": "Drop Down",
      "link_name": "Dropdown",
      "type": 12,
      "choices": [
        {
          "value": "Choice 1",
          "key": "Choice 1"
        },
        {
          "value": "Choice 2",
          "key": "Choice 2"
        },
        {
          "value": "Choice 3",
          "key": "Choice 3"
        }
      ],
      "mandatory": false
    },
    {
      "unique": false,
      "display_name": "Checkbox",
      "link_name": "Checkbox",
      "type": 15,
      "choices": [
        {
          "value": "Choice 1",
          "key": "Choice 1"
        },
        {
          "value": "Choice 2",
          "key": "Choice 2"
        },
        {
          "value": "Choice 3",
          "key": "Choice 3"
        }
      ],
      "mandatory": false
    },
    {
      "unique": false,
      "display_name": "Multi Select",
      "link_name": "Multi_Select",
      "type": 14,
      "choices": [
        {
          "value": "Choice 1",
          "key": "Choice 1"
        },
        {
          "value": "Choice 2",
          "key": "Choice 2"
        },
        {
          "value": "Choice 3",
          "key": "Choice 3"
        }
      ],
      "mandatory": false
    },
    {
      "unique": false,
      "display_name": "Decision box",
      "link_name": "Decision_box",
      "type": 16,
      "mandatory": false
    },
    {
      "unique": false,
      "display_name": "Image",
      "link_name": "Image",
      "type": 18,
      "mandatory": false
    },
    {
      "unique": false,
      "display_name": "File upload",
      "link_name": "File_upload",
      "type": 19,
      "mandatory": false
    },
    {
      "unique": false,
      "display_name": "Audio",
      "link_name": "Audio",
      "type": 32,
      "mandatory": false
    },
    {
      "unique": false,
      "display_name": "Video",
      "link_name": "Video",
      "type": 33,
      "mandatory": false
    },
    {
      "unique": false,
      "display_name": "Signature",
      "link_name": "Signature",
      "type": 25,
      "mandatory": false
    },
    {
      "unique": false,
      "link_name_required": true,
      "display_name": "Url",
      "link_name": "Url",
      "type": 17,
      "mandatory": false,
      "target": 1
    },
    {
      "is_lookup_field": true,
      "unique": false,
      "display_name": "Lookup",
      "link_name": "Lookup",
      "type": 12,
      "mandatory": false
    },
    {
      "unique": false,
      "display_name": "Auto Number",
      "link_name": "Auto_Number",
      "type": 9,
      "mandatory": false
    },
    {
      "visibility": true,
      "unique": false,
      "display_name": "Formula",
      "link_name": "Formula",
      "type": 20,
      "mandatory": false
    },
    {
      "unique": false,
      "text": "Add your Note here ...",
      "display_name": "",
      "link_name": "Add_Notes",
      "type": 24,
      "mandatory": false
    },
    {
      "unique": false,
      "display_name": "Users",
      "link_name": "users",
      "type": 26,
      "mandatory": false,
      "field_select_type": 100
    },
    {
      "is_integration": true,
      "unique": false,
      "display_name": "Integration",
      "link_name": "Integration",
      "type": 31,
      "mandatory": false
    },
    {
      "decimal_length": 0,
      "zia_base_field_type": 5,
      "unique": false,
      "max_char": 10,
      "display_name": "Prediction",
      "link_name": "Prediction",
      "type": 39,
      "mandatory": false
    },
    {
      "zia_base_field_type": 2,
      "unique": false,
      "max_char": 200,
      "display_name": "Keyword",
      "link_name": "Keyword",
      "type": 37,
      "mandatory": false
    },
    {
      "zia_base_field_type": 12,
      "unique": false,
      "display_name": "Sentiment",
      "link_name": "Sentiment",
      "type": 38,
      "choices": [
        {
          "value": "Negative",
          "key": "Negative"
        },
        {
          "value": "Neutral",
          "key": "Neutral"
        },
        {
          "value": "Positive",
          "key": "Positive"
        }
      ],
      "mandatory": false
    },
    {
      "zia_base_field_type": 2,
      "unique": false,
      "max_char": 200,
      "display_name": "OCR",
      "link_name": "OCR",
      "type": 35,
      "mandatory": false
    },
    {
      "zia_base_field_type": 2,
      "unique": false,
      "max_char": 200,
      "display_name": "Object Detection",
      "link_name": "Object_Detection",
      "type": 36,
      "mandatory": false
    },
    {
      "ref_form": "ZC_SUBFORM_68",
      "unique": false,
      "display_name": "Inline SubForm",
      "link_name": "Inline_SubForm",
      "type": 21,
      "fields": [
        {
          "subfields": [
            {
              "is_hidden": true,
              "column_name": "prefix",
              "display_name": "Prefix",
              "link_name": "prefix",
              "choices": [
                {
                  "value": "Mr.",
                  "key": "Mr."
                },
                {
                  "value": "Mrs.",
                  "key": "Mrs."
                },
                {
                  "value": "Ms.",
                  "key": "Ms."
                }
              ]
            },
            {
              "is_hidden": false,
              "column_name": "first_name",
              "display_name": "First Name",
              "link_name": "first_name"
            },
            {
              "is_hidden": false,
              "column_name": "last_name",
              "display_name": "Last Name",
              "link_name": "last_name"
            },
            {
              "is_hidden": true,
              "column_name": "suffix",
              "display_name": "Suffix",
              "link_name": "suffix"
            }
          ],
          "unique": false,
          "display_name": "Name",
          "link_name": "Name",
          "type": 29,
          "mandatory": false
        },
        {
          "unique": false,
          "max_char": 255,
          "display_name": "Email",
          "link_name": "Email",
          "type": 3,
          "mandatory": false
        },
        {
          "unique": false,
          "max_char": 255,
          "display_name": "Single Line",
          "link_name": "Single_Line",
          "type": 1,
          "mandatory": false
        }
      ],
      "mandatory": false,
      "ref_application": "test-file-upload"
    },
    {
      "ref_form": "SubForm",
      "unique": false,
      "display_name": "SubForm",
      "link_name": "SubForm",
      "type": 21,
      "fields": [
        {
          "subfields": [
            {
              "is_hidden": true,
              "column_name": "prefix",
              "display_name": "Prefix",
              "link_name": "prefix",
              "choices": [
                {
                  "value": "Mr.",
                  "key": "Mr."
                },
                {
                  "value": "Mrs.",
                  "key": "Mrs."
                },
                {
                  "value": "Ms.",
                  "key": "Ms."
                }
              ]
            },
            {
              "is_hidden": false,
              "column_name": "first_name",
              "display_name": "First Name",
              "link_name": "first_name"
            },
            {
              "is_hidden": false,
              "column_name": "last_name",
              "display_name": "Last Name",
              "link_name": "last_name"
            },
            {
              "is_hidden": true,
              "column_name": "suffix",
              "display_name": "Suffix",
              "link_name": "suffix"
            }
          ],
          "unique": false,
          "display_name": "Name",
          "link_name": "Name",
          "type": 29,
          "mandatory": false
        },
        {
          "unique": false,
          "max_char": 255,
          "display_name": "Email",
          "link_name": "Email",
          "type": 3,
          "mandatory": false
        },
        {
          "unique": false,
          "max_char": 255,
          "display_name": "Single Line",
          "link_name": "Single_Line",
          "type": 1,
          "mandatory": false
        }
      ],
      "mandatory": false,
      "ref_application": "zylker-store"
    }
  ]
}