younifyd
Menu

List fields metadata

List fields metadata

GET/settings/fields

Use it in a workflow

  1. Add a step and choose the Zoho CRM connector.
  2. Pick the List fields metadata action (under Metadata).
  3. Fill in the fields below, then reference the result from later steps as {{listFieldsMetadata.response.data}}.

Request

Query parameters

modulestringrequired

Specify the API name of the module for which you want to retrieve field data. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.

includestring

Specify whether to include the **allowed_permissions** JSON object in the response. Possible values: allowed_permissions_to_update - Includes the allowed_permissions JSON object with details about the default permissions for each field.

One ofallowed_permissions_to_update

typestring

Specify the usage type of the fields to retrieve. Possible values: all - Retrieves both used and unused fields in the module. unused - Retrieves only fields that are not in use. used - Retrieves only fields that are currently in use.

One ofallunusedused

Response

Returns 200 with an object. Read it in later steps with {{listFieldsMetadata.response.data.<field>}}.

fieldsarray<object>

Represents the list of field metadata objects retrieved for the specified module.

mask_detailsoneOf
associated_moduleoneOf
webhookbooleanrequired

Indicates whether webhook is enabled for the field.

operation_typeobjectrequired4 fields

Represents the operation types allowed for the field.

colour_code_enabled_by_systembooleanrequired

Indicates whether colour coding is enabled for this field by the system.

field_labelstringrequired

Represents the display name of the field in the user's preferred language.

tooltiponeOf
display_format_propertiesoneOf
typestringrequired

Represents the type of the field used or unused.

field_read_onlybooleanrequired

Indicates whether the field is always read-only and cannot be edited under any circumstances.

customizable_propertiesoneOf
display_labelstringrequired

Represents the display label of the field.

read_onlybooleanrequired

Indicates whether the field is read-only for the current user.

association_detailsoneOfrequired
businesscard_supportedbooleanrequired

Indicates whether the field can be added to the business card section.

multi_module_lookuponeOfrequired
idstring (int64)required

Id of the resource.

created_timeoneOf
filterablebooleanrequired

Indicates if the field is filterable.

visiblebooleanrequired

Indicates if the field is visible.

profilesarray<object>required3 fields

Represents the list of profiles associated with the field.

view_typeobjectrequired4 fields

Represents the view type details of the field.

separatorbooleanrequired

Indicates if the field is a separator.

searchablebooleanrequired

Indicates if the field is searchable.

history_tracking_enabledbooleanrequired

Indicates if history tracking is enabled for the field.

externaloneOfrequired
api_namestringrequired

API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores.

parent_fieldoneOf
uniqueobjectrequired1 fields

Represents the uniqueness details of the field.

enable_colour_codebooleanrequired

Indicates if colour code is enabled for the field.

child_fieldsoneOf
reference_idstring

Represents the temporary identifier used to reference a screen within the same wizard request payload.

pick_list_valuesoneOfrequired
enable_record_categoryboolean

Indicates if the record category feature is enabled for this picklist field. Only returned when the record category feature is available.

record_category_tracking_fieldoneOf

Reference to the field used to track record category changes over time in the timeline view. Only present when enable_record_category is true and a tracking field is configured.

enable_transition_for_record_categoryboolean

Indicates if transitions between record categories are enabled. Only returned when enable_record_category is true.

record_category_valuesarray<object>4 fields

List of record category values defined for this picklist field. Only returned when enable_record_category is true.

system_mandatorybooleanrequired

Indicates if the field is system mandatory.

privateoneOf
virtual_fieldbooleanrequired

Indicates if the field is a virtual field.

json
{
  "fields": [
    {
      "webhook": false,
      "operation_type": {
        "web_update": false,
        "api_create": false,
        "web_create": false,
        "api_update": false
      },
      "colour_code_enabled_by_system": false,
      "field_label": "Last Name",
      "type": "user",
      "field_read_only": false,
      "display_label": "Last Name",
      "read_only": false,
      "association_details": null,
      "businesscard_supported": false,
      "multi_module_lookup": null,
      "id": "1385208000000973001"
    }
  ]
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

List fields metadata — Zoho CRM — Documentation