Zoho: List fields metadata

← Fields operations · Get started

Operation zoho.getfields

Provider route: GET /crm/v8/settings/fields. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["fields"]["getFields"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.fields.getFields(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.fields.get_fields(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.module	string	Required within parent	The API name of the module to which the field belongs. Maximum length: 30
query.include	string	Optional	To include additional information about the field’s permissions to update. One of: allowed_permissions_to_update Maximum length: 50
query.type	string	Optional	One of: all, unused, used Maximum length: 10

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Represents the response body for the field metadata request, containing an array of field configuration objects. Additional keys: not allowed
$ (anyOf 1).fields	array	Required within parent	Represents the list of field metadata objects retrieved for the specified module. Maximum items: 100
$ (anyOf 1).fields[]	Model	Each item	Expand Get field metadata by ID — response body — fields item
$ (anyOf 2)	null	Alternative

Referenced models: Get field metadata by ID — response body — fields item

Schemas

24 more schemas are linked from the tables above, on the schema pages.

Get field metadata by ID — response body — fields item association details lookup field, related field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the association details of the lookup field, including the related field and the lookup field configuration in the connected module. Additional keys: not allowed
lookup_field	object	Required within parent	Represents the details of the lookup field. Additional keys: not allowed
lookup_field.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
lookup_field.id	string	Required within parent	Id of the resource. Format: int64
related_field	object	Required within parent	Represents the details of the related field. Additional keys: not allowed
related_field.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
related_field.id	string	Required within parent	Id of the resource. Format: int64

Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list connected details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the connected details for the multi-module lookup. Additional keys: not allowed
field	Model	Required within parent	Expand Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list connected details field
layouts	array	Required within parent	Represents the list of layouts associated with the multi-module lookup. Maximum items: 100
layouts[]	object	Each item	Represents the layout details for the multi-module lookup. Additional keys: not allowed
layouts[].api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
layouts[].id	string	Required within parent	Id of the resource. Format: int64
module	Model	Required within parent	Expand Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list connected details module

Referenced models: Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list connected details field, Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list connected details module

Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list linking details connected lookup field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the connected lookup field details for the multi-module lookup. Additional keys: not allowed
api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
field_label	string	Required within parent	Represents the field label of the connected lookup field. Maximum length: 100
id	string	Required within parent	Id of the resource. Format: int64

Get field metadata by ID — response body — fields item convert mapping

Field	Type	Presence	Description and constraints
$	object	Root	Represents the convert mapping details of the field. Additional keys: not allowed
Accounts	JSON	Optional
Accounts (anyOf 1)	string	Alternative	Represents the mapping details for Contacts field name. Maximum length: 100
Accounts (anyOf 2)	null	Alternative	Represents the null if no information is available.
Contacts	JSON	Optional
Contacts (anyOf 1)	string	Alternative	Represents the mapping details for Contacts field name. Maximum length: 100
Contacts (anyOf 2)	null	Alternative	Represents the null if no information is available.
Deals	JSON	Optional
Deals (anyOf 1)	string	Alternative	Represents the mapping details for Contacts field name. Maximum length: 100
Deals (anyOf 2)	null	Alternative	Represents the null if no information is available.
Invoices	JSON	Optional
Invoices (anyOf 1)	string	Alternative	Represents the mapping details for Invoices field name. Maximum length: 100
Invoices (anyOf 2)	null	Alternative	Represents the null if no information is available.
Sales_Orders	JSON	Optional
Sales_Orders (anyOf 1)	string	Alternative	Represents the mapping details for Sales Orders field name. Maximum length: 100
Sales_Orders (anyOf 2)	null	Alternative	Represents the null if no information is available.

Get field metadata by ID — response body — fields item child fields array item field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details of the child Address field. Additional keys: not allowed
api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Id of the resource. Format: int64
name	string	Required within parent	Represents the name of the child Address field. Maximum length: 100

Get field metadata by ID — response body — fields item formula Represents the formula details of the field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the formula details of the field. Additional keys: not allowed
assume_default	boolean	Optional	Indicates if the formula should assume default values.
dynamic	boolean	Optional	Indicates if the formula is dynamic.
return_type	string	Optional	Represents the return type of the formula. Maximum length: 50
stop_compute_conditionally	boolean	Optional	Indicates if the formula computation should stop conditionally.
sub_return_type	string	Optional	Represents the sub-type of the formula return value, such as the specific string subtype when the return type is a string. Maximum length: 50

Get field metadata by ID — response body — fields item global picklist api name, id

Field	Type	Presence	Description and constraints
$	object	Root	Represents the global picklist details linked to the field, identified by its API name and unique ID. Additional keys: not allowed
api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Id of the resource. Format: int64

Get field metadata by ID — response body — fields item history tracking duration configuration, duration configured field, followed fields, module, related list name

Field	Type	Presence	Description and constraints
$	object	Root	Represents the history tracking details of the field. Additional keys: not allowed
duration_configuration	string	Required within parent	Represents the duration configuration for history tracking. Maximum length: 120
duration_configured_field	object	Required within parent	Represents the duration configured field details for history tracking. Additional keys: not allowed
duration_configured_field.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
duration_configured_field.id	string	Required within parent	Id of the resource. Format: int64
followed_fields	array	Required within parent	Represents the list of fields being followed for history tracking. Maximum items: 100
followed_fields[]	object	Each item	Represents the details of a followed field. Additional keys: not allowed
followed_fields[].api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
followed_fields[].id	string	Required within parent	Id of the resource. Format: int64
module	object	Required within parent	Represents the module details for history tracking. Additional keys: not allowed
module.api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
module.id	string	Required within parent	Id of the resource. Format: int64
related_list_name	string	Required within parent	Represents the name of the related list for history tracking. Maximum length: 100

Get field metadata by ID — response body — fields item multiselectlookup connected details, linking details, related list linking details lookup field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the lookup field details for the multi-module lookup. Additional keys: not allowed
api_name	string	Required within parent	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
field_label	string	Required within parent	Represents the field label of the lookup field. Maximum length: 100
id	string	Required within parent	Id of the resource. Format: int64

Policy, approvals and errors

SDK function policy ID: zoho.getfields. Catalog operation: getFields. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

No-content response statuses: [204]

Official provider source