Get Custom Fields

Overview
Syntax
Scope
Example
Response Format

Note:

This task is applicable to all services except Zoho Creator.
Each time the zoho.one.getCustomFields integration task is executed, it triggers an API request in the back-end. This call is deducted from the external calls limit available for the service from which the task is executed, based on your pricing plan.
Only actual executions that receive a response (whether success or failure) are counted, not the number of times the task appears in the script. For example, if zoho.one.getCustomFields integration task is placed inside a for each task that iterates five times, the number of external calls consumed will be five, even though the task appears only once in the script.

Overview

The zoho.one.getCustomFields task is used to fetch all the custom fields from the specified organization.

Syntax

<response> = zoho.one.getCustomFields(<orgID>, <connection>);

Scope

ZohoOne.Orgs.READ

where:

Parameter	Description	Data type
response	is the variable which will hold the details of the custom fields fetched from the organization.	KEY-VALUE
<orgID>	is the ID of the organization from which the custom fields need to be fetched.	NUMBER
<connectionName>	is the name of the Zoho One connection.	TEXT

Example

The following script fetches all the custom fields from Zoho One organization with ID - 72XXXXXXX:

response = zoho.one.getCustomFields(72XXXXXXX, "zoho_one_connection");

where:

response

This is the KEY-VALUE response returned by Zoho One.

72XXXXXXX

This is the NUMBER that represents the organization ID of Zoho One account from which all the custom fields need to be fetched.

zoho_one_connection

This is the TEXT that represents the link name of the connection.

Response format

{
  "status_code": 200,
  "has_more": false,
  "resource_name": "fields",
  "fields": [
     {
          "field_id": "79*************",
          "is_mandatory": false,
          "is_phi_enabled": false,
          "max_allowed_chars": 9,
          "tooltip_text": "To********************",
          "is_custom_field": true,
          "field_name": "Bl**********",
          "tooltip_type": -1,
          "is_encrypt": false,
          "is_enabled": true,
          "field_type": "number",
          "user_editable": false
     },
     {
          "field_id": "14***************",
          "default_value": "1494300************",
          "is_mandatory": false,
          "is_phi_enabled": false,
          "max_allowed_chars": 0,
          "is_custom_field": true,
          "field_name": "P*******",
          "tooltip_type": -1,
          "is_encrypt": false,
          "is_enabled": false,
          "picklist_options": [
              {
                  "picklist_id": "1594300************",
                  "picklist_order": 1,
                  "picklist_value": "item1"
              },
              {
                  "picklist_id": "1494300************",
                  "picklist_order": 2,
                  "picklist_value": "item2"
              },
              {
                  "picklist_id": "1694300************",
                  "picklist_order": 3,
                  "picklist_value": "item3"
              }
          ],
          "field_type": "picklist",
          "user_editable": false
     }
  ]
}