Your use case. Our milestone. The 200th post in our "Kaizen Series: Continuous Improvement for Developer Experience" is coming up. Share Now

X
Skip to product menu
close
EXPLORE ALL PRODUCTS

Sales

CRM

Comprehensive CRM platform for customer-facing teams.

CRM
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
Forms

Build online forms for every business need.

Forms
Bigin

Simple CRM for small businesses moving from spreadsheets.

Bigin
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Bookings

Appointment scheduling app for consultations with customers.

Bookings
RouteIQ

Comprehensive sales map visualization and optimal route planning solution.

RouteIQ
Thrive

Complete loyalty and affiliate management platform.

Thrive
Suites
CRM Plus

Unified platform to deliver top-notch customer experience.

CRM Plus

Marketing

Campaigns

Create, send, and track targeted email campaigns that drive sales.

Campaigns
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
Forms

Build online forms for every business need.

Forms
Social

All-in-one social media management software.

Social
Survey

Design surveys to reach and interact with your audience.

Survey
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Sites

Online website builder with extensive customisation options.

Sites
Backstage

End-to-end event management software.

Backstage
PageSense

Website conversion optimization and personalisation platform.

PageSense
Marketing Automation

All-in-one marketing automation software.

Marketing Automation
LandingPage

Smart landing page builder to increase conversion rates

LandingPage
Webinar

Webinar platform for webcasting online webinars.

Webinar
NEW
LeadChain

Sync, manage, and convert leads across channels seamlessly.

LeadChain
NEW
Domains

Easy domain registration, transfer, and secured DNS management.

Domains
NEW
CommunitySpaces

Online community platform for individuals and businesses to grow their network and brand.

CommunitySpaces
Thrive

Complete loyalty and affiliate management platform.

Thrive
Publish

Manage all your local business listings on a single platform.

Publish
Suites
Marketing Plus

Unified marketing platform for marketing teams.

Marketing Plus

Commerce and POS

Commerce

eCommerce platform to manage and market your online store.

Commerce

Service

Desk

Helpdesk software to deliver great customer support.

Desk
Assist

Remote support and unattended remote access software.

Assist
Voice

Cloud Contact Center Software for businesses.

Voice
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Bookings

Appointment scheduling app for consultations with customers.

Bookings
FSM

End-to-end field service management platform for service businesses.

FSM
Lens

Interactive remote assistance software with augmented reality.

Lens
Solo

The all-in-one toolkit for solopreneurs.

Solo
Suites
Service Plus

Unified platform for customer service and support teams.

Service Plus

Finance

Books

Powerful accounting platform for growing businesses.

Books
Expense

Effortless expense reporting platform.

Expense
Sign

Digital signature app for businesses.

Sign
Inventory

Powerful stock management and inventory control software.

Inventory
FREE
Invoice

100% Free invoicing solution.

Invoice
Billing

End-to-end billing solution for your business.

Billing
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
Commerce

eCommerce platform to manage and market your online store.

Commerce
Checkout

Collect payments online with custom branded pages.

Checkout
Practice

Practice management software for accounting firms.

Practice
Solo

The all-in-one toolkit for solopreneurs.

Solo
NEW
Payments

Unified payment solution built for all businesses.

Payments
Suites
Finance Plus

All-in-one suite to manage your operations and finances.

Finance Plus

Email, Storage, and Collaboration

Mail

Secure email service for teams of all sizes.

Mail
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
WorkDrive

Online file management for teams.

WorkDrive
Bookings

Appointment scheduling app for consultations with customers.

Bookings
Cliq

Stay in touch with teams no matter where you are.

Cliq
Notebook

Beautiful home for all your notes.

Notebook
Meeting

Online meeting software for all your video conferencing & webinar needs.

Meeting
Connect

Employee experience platform to communicate, engage, and build positive employee relations.

Connect
Learn

Knowledge and learning management platform.

Learn
Office Integrator

Built in document editors for web apps.

Office Integrator
Writer

Word processor for focused writing and discussions.

Writer
TeamInbox

Shared inboxes for teams.

TeamInbox
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
Show

Create, edit, and share slides with a sleek presentation app.

Show
Tables

Work management tool to connect people, processes, and information.

Tables
Sheet

Spreadsheet software for collaborative teams.

Sheet
Office Suite

Powerful collaborative work platform for teams.

Office Suite
Calendar

Online business calendar to manage events and schedule appointments.

Calendar
ToDo

Collaborative task management for individuals and teams.

ToDo
FREE
PDF Editor

Collaborative online PDF editing tool.

PDF Editor
Suites
Workplace

Application suite built to improve team productivity and collaboration.

Workplace

Human Resources

Expense

Effortless expense reporting platform.

Expense
Recruit

Intuitive recruiting platform built to provide hiring solutions.

Recruit
People

Organize, automate, and simplify your HR processes.

People
Sign

Digital signature app for businesses.

Sign
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
Shifts

Employee scheduling and time tracking app.

Shifts
Workerly

Manage temporary staffing with an employee scheduling solution.

Workerly
Suites
People Plus

Comprehensive HR platform for seamless employee experiences.

People Plus

Security and IT Management

Creator

Build custom apps to simplify business processes.

Creator
Assist

Remote support and unattended remote access software.

Assist
Vault

Online password manager for teams.

Vault
Directory

Workforce identity and access management solution for cloud businesses.

Directory
Lens

Interactive remote assistance software with augmented reality.

Lens
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
NEW
eProtect

Comprehensive email security and archiving for every business.

eProtect
FREE
OneAuth

Secure multi-factor authenticator (MFA) for all your online accounts.

OneAuth
Toolkit

Complete resource for any admin-related lookup queries.

Toolkit

BI and Analytics

Analytics

Modern self-service BI and analytics platform.

Analytics
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
NEW
IoT

Harnessing IoT analytics for real-time operational intelligence.

IoT
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI

Project Management

Projects

Manage, track, and collaborate on projects with teams.

Projects
Sprints

Planning and tracking tool for scrum teams.

Sprints
BugTracker

Automatic bug tracking software for managing bugs.

BugTracker
Solo

The all-in-one toolkit for solopreneurs.

Solo
Suites
Projects Plus

Unified project management platform for intelligent, data-driven work.

Projects Plus

Developer Platforms

Creator

Build custom apps to simplify business processes.

Creator
Flow

Automate business workflows by creating smart integrations.

Flow
Office Integrator

Built in document editors for web apps.

Office Integrator
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
Tables

Work management tool to connect people, processes, and information.

Tables
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
NEW
IoT

Build, deploy, and scale IoT solutions for connected businesses.

IoT
Apptics

Application analytics for all apps.

Apptics
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI

IoT

NEW
IoT

Low-code IoT platform and solutions for connected businesses.

IoT
CRM Plus

Unified platform to deliver top-notch customer experience.

Try now
CRM Plus
Service Plus

Unified platform for customer service and support teams.

Try now
Service Plus
Finance Plus

All-in-one suite to manage your operations and finances.

Try now
Finance Plus
People Plus

Comprehensive HR platform for seamless employee experiences.

Try now
People Plus
Workplace

Application suite built to improve team productivity and collaboration.

Try now
Workplace
Marketing Plus

Unified marketing platform for marketing teams.

Try now
Marketing Plus
Projects Plus

Unified project management platform for intelligent, data-driven work.

Try now
Projects Plus
All-in-one suite

Zoho One

The Operating System for Business

Run your entire business on Zoho with our unified cloud software, designed to help you break down silos between departments and increase organizational efficiency.

TRY ZOHO ONE
Zoho Marketplace

With over 2000 ready-to-use extensions across 40+ categories, connect your favorite business tools with the Zoho products you already use.

EXPLORE MARKETPLACE
Skip to main content

Fields Meta Data

Purpose

To get the field metadata for the specified module including standard module, custom module, subform module, and linking module in you Zoho CRM account. The fields displayed are from all layouts for the module. The response does not contain layout-specific fields like mandatory fields or picklist values.

Endpoints

  • GET /settings/fields?module={module_API_name}
  • GET /settings/fields/{field_unique_ID}?module={module_API_name}
  • {module_API_name} : API name of the module whose fields metadata you want to retrieve.
  • {field_unique_ID} : The unique ID of the field you want to fetch.

Request Details

Request URL

{api-domain}/crm/{version}/settings/fields

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.settings.fields.READ  (or) 
ZohoCRM.settings.fields.ALL  (or) 
ZohoCRM.settings.ALL

Parameters

  • modulestring, mandatory

    This parameter specifies the API name of the module for which you want to retrieve field metadata. Use the GET - Modules Metadata API to retrieve all available module API names.

    Supported modules: Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Custom, Appointments, and Service.

  • typestring, optional

    Represents whether to fetch only unused fields or both used and unused fields in the module. By default, the system fetches all the used fields.

    Possibe values:

    • all : Fetches both used and unused fields in the module.
    • unused : Fetches all the unused fields in the module.
  • includestring, optional

    It specifies whether to include the allowed_permissions JSON object in the response.

    Possible value: 

    allowed_permissions_to_update : It represents the details on details on default permissions enabled for a field. It returns the allowed_permissions JSON object in the response. 

    Note: If this parameter is not included in the request, the allowed_permissions object will be skipped from the response.

Note

  • Use the api_name of the fields in all API inputs instead of field labels. This ensures that the label name changes in custom modules or fields won't affect your existing integrations.
  • Fields with Don't Show permissions will still be included in the API response.
  • The "full_name" field contains the concatenated values of the First Name and Last Name fields. 
    This is a read-only field available only in the Leads, Contacts, and Users modules.

Sample Request

Copied

Response JSON 

  • associated_moduleJSON object

    Represents the module of the fields associated with the parent modules.

    • module(string)- Represents the module created for the subform or image upload or file upload fields.
    • id(string)- Represents the unique ID of the module.
  • operation_typeJSON object

    Represents the possible source of data for the field.

    Possible values:

    • web_update(Boolean) : Represents whether the field can be updated through web.
    • api_create(Boolean) : Represents whether the field can be created through api.
    • web_created(Boolean) : Represents whether the field can be created through web.
    • api_update(Boolean) : Represents whether the field can be updated through api.
  • system_mandatoryBoolean

    Represents if current field is a system-mandatory field.
    Possible values:

    • true : The field is a system-mandatory field.
    • false : The field is not a system-mandatory field.
  • privateJSON object

    Represents the details of compliance settings in your organization. 

    Example:

    "private": {
    "restricted": true,
    "type": "Low",
    "export": true
    }

    • restricted(Boolean) : Represents if normal or sensitive data has restricted access when accessed via API.
    • export(Boolean) : Represents if normal or sensitive data has restricted access when exported.
    • type(string) : Specifies the restriction level based on field configuration in the layout
      • Possible values:Low and High.
  • webhookBoolean

    Represents if the field is supported in webhook.

  • virtual_fieldBoolean

    Virtual fields are reference-only fields that contain metadata but do not hold actual values. It is used for subforms, multi-select lookups, multi-user lookups, and system-generated fields like Full_Name

  • json_typestring

    Represents the JSON type of the field. For example, JSON object, string, etc,.

  • textareaJSON object

    Contains the details of the multiline field.

    • typestring 

      Represents the type of multiline field.
      Possible values : 

      • small supports up to 2000 characters.
      • large supports up to 32000 characters.
      • rich_text supports up to 50000 characters.
  • cryptJSON object

    Represents the status of the encryption. 

    Example: 

    "crypt": {
    "mode": "encryption",
    "status": 1
    }
    The possible values for the "mode" key are: encryption and decryption.
    The possible values for the "status" key are:

    • 1 - Represents that the field is encrypted.
    • 2- Represents that the encryption/decryption for the field is in progress.

    The "null" value represents that the key is decrypted.

  • tooltipJSON object

    Represents the details of the tooltip (name and value), if the field has one.

  • created_sourcestring

    Represents the source from which the field was created. This key helps identify whether the field was created by default, through an extension, or via an integration.

    Possible values: 

    • default: Represents that the field was created by default within the Zoho CRM system.
    • extension: Represents that the field was created through an extension.
    • integration: Represents that the field was created via an integration with another system or application.
  • display_labelstring

    Represents the display name of the field as it appears in the user interface. This label is not translated to the user's preferred language and remains consistent regardless of the user's language settings.

    Example: "Lead Owner", "Phone", "Email". The value "Phone", meaning the field will be displayed with the label "Phone" in the user interface. This label remains the same regardless of the user's language preferences.
    For Events, all display labels are renamed to Meetings.

  • field_labelstring

    The display name of the field in the user's preferred language. This label is translated according to the user's language settings i.e., if the user's language preference is set to a different language, the label will be translated accordingly.

    For Events, all display labels are renamed to Meetings.

  • field_read_onlyBoolean

    Represents whether the field is always read-only. This means that the field cannot be edited under any circumstances.
    Possible values :

    • true: The field is always read-only and cannot be edited.
    • false:  The field is not always read-only and can be edited under certain conditions.
  • allowed_permissions_to_updateJSON Object
    • Represents the default permissions for the field, indicating whether the user can read, edit, or if the field is hidden.
      • read-only (Boolean) : "true" means the user can only view the field.
      • read-write (Boolean) : "true" means the user can edit the field.
      • hidden (Boolean) : "true" means the field is hidden from the user.
         
  • read_onlyBoolean

    Represents if the field is read-only for the current user.
    Possible values : 

    • true: The field read-only for the current user.
    • false: The field is not read-only for the current user.
  • display_fieldBoolean

    Represents the display label of the current field. For instance, Last Name.

  • quick_sequence_numberinteger

    Represents the position of the field in the CRM module's layout.

    Example: "quick_sequence_number" : 5, shows the field appears in the fifth position in the CRM module's layout. This helps determine the order of fields as they are displayed to the user.

  • businesscard_supportedBoolean

    Represents if the current field can be added to business card section.
    Possible values : 

    • true : The field can be added to the business card section.
    • false : The field cannot be added to the business card section.
  • sharing_propertiesJSON object

     Represents the access permissions related to a lookup field. It indicates whether the user has access to the records that the field looks up to.

  • idstring

    Represents the unique ID of the current field.

  • custom_fieldBoolean

    Represents if the current field is a custom field.
    Possible values :

    • true : The field is a custom field.
    • false : The current field is a default field.
  • lookupJSON object

    Represents the details of the lookup that the field is related to. For example, for the "Parent_Id" field in the inventory line item subform "Quoted_Items", the lookup key contains the API name and ID of the module that the field is related to.
    In inventory line item subforms, for fields where the user selects a record from a list such as the Product name, the "lookup" key contains a JSON array "show_fields". This indicates the field that is displayed when a record is selected for that lookup. For example, for the "Product_Name" lookup, the users select a product. So, the show_fields key contains the fields that are displayed while you select the product.

  • visibleBoolean

    Represents if the current field is visible to the user.
    Possible values : 

    true: The field is visible to the user.
    false: The current field is not visible to the user.

  • profilesJSON array

    Represents the different profiles that have access to the field and the type of access permission each profile has. This key helps in understanding which user profiles can view or edit the field.

    • permission_type (string): Represents the type of permission the profile has for the field.
      • Possible values :
        • read_write: Users with this profile can view and edit the field.
        • read_only: Users with this profile can only view the field and cannot edit it.
    • name (string): Represents the name of the profile.
    • id (string): Represents the unique ID of the profile.
       

      The value null represents that the user does not have the Module Customization permission.

  • display_typeinteger

    Represents how the field is displayed based on its type.
    Possible values :

    • -1: The field is a normal field.
    • 2: The field is "select only," meaning users can only select from predefined options and cannot enter custom values.
  • enable_colour_codeBoolean

    Represents whether you can use color coding for that field.

  • history_tracking_enabledBoolean

    Represents whether history tracking feature is enabled for the picklist field.

    Possible values:

    • false (default) : History tracking for the picklist is not enabled.
    • true : History tracking for the picklist is enabled.
  • history_trackingJSON object 

    Contains the configuration details for tracking the history of the picklist field.

    • related_list_namestring

      The picklist field's history can be viewed as a related list in the record detail view. The related_list_name key represents the name of the related list.

    • moduleJSON object

      A separate module will be created for a picklist field you select to track history. The module key contains the created module's API name and its unique ID.

    • duration_configurationstring

      Specify the unit of time (e.g., days or time) for tracking history.

      Possible values:

      • days (default) - History is tracked by days.
      • time - History is tracked by time.
    • duration_configured_fieldJSON object

      Contains the API name and ID of the field (days or time) you configured in the duration_configuration.

    • followed_fieldsJSON array

      The followed_fields array allows you to track changes to additional fields to track along with the main picklist field for comprehensive change tracking of related fields. Each JSON object in the followed_fields key represents the API name and its unique ID of the followed fields you have selected during history tracking configuration.

      For instance, if a sales team tracks the Property Status picklist to monitor how long a property stays in each stage, they can add User Assigned to followed_fields to track which user handled the property at each stage.
       

  • wizardbigint

    Represents that the field is a wizard.

  • multiselectlookupJSON object

    Represents the details such as linking module, connected module, lookup API name etc, of a multi-select lookup field.

  • multiuserlookupJSON object

    Represents the details such as linking module, connected module, lookup API name etc, of a multi-select user lookup field.

  • pick_list_values_sorted_lexicallyBoolean

    Represents whether the values of the picklist are sorted alphabetically.
    Possible values : 

    • true : The picklist values are sorted alphabetically.
    • false : The picklist values are not sorted alphabetically and may appear in a custom order.
       
  • subformJSON object

    Represents the details of the line items in the inventory modules.

  • searchableBoolean

    Represents whether the field is supported in a search.

  • lengthinteger

    Represents the size of the current field.

  • sortableBoolean

    Represents whether the field is sortable.

  • api_namestring

    Represents API name of the current field.

  • data_typestring

    Represents CRM field type of the current field. For instance, lookup.

  • formulaJSON object

    Represents the formula details, if the current field is a formula field.

  • decimal_placeinteger

    Represents the number of decimal places allowed for the field. This key is typically used for fields that store numerical values, such as currency or decimal fields.

  • mass_updateBoolean

    Represents if the field supports mass updates, which can be useful for making changes to multiple records at once.
    Possible values :

    • true: The current field can be mass updated.
    • false: The current field cannot be mass updated.
  • enable_colour_codeBoolean

    Represents if the field can be color-coded.

  • pick_list_valuesJSON array

    Represents the list of all the picklist values, if the field is either a picklist or multi-select picklist field.
    The value for the key type in each picklist option represents if that option is used or not.
    The key id represents the unique ID of every picklist option.
    colour_code represents the hex code for the color for that picklist value.
    The response contains both used and unused picklist values.

    The pick_list_values array contains all available options for fields of type Picklist or Multi-Select Picklist.

    • type (String) : Represents whether the picklist option is used or not.
    • id (String) : Represents the unique identifier for each picklist option.
    • colour_code (String) : Represents the hex code representing the color assigned to the picklist value.
  • auto_numberJSON object

    Auto-number fields automatically generate a unique number for each record based on a specified format. This is useful for creating unique identifiers for records, such as invoice numbers or order IDs.

  • rollup_summaryJSON object

    Represents details of a roll up summary field. Roll up summary fields are used to summarize or aggregate values from a related list.

    • return_type

      Specifies the type of the rollup summary field.

    • expression JSON Object

      Represents the expression used for the rollup summary calculation.

      • function_parameters JSON Array

        Specifies the function parameters used in the expression.

        • api_name

          Specifies the API name of the fields used in expression

      • criteria JSON Object

        Specifies the criteria for rollup summary calculation.

        • group_operator

          Specifies the group operator used in the criteria (e.g., AND, OR).

        • group JSON Array

          Represents the group of criteria for the rollup summary calculation.

          • comparator

            Represents the comparison operator used in the criterion (e.g., not_equal).

          • field JSON Object

            Represents the field details for the criterion.

            • api_name

              Specifies the API name of the field.

            • id

              Specifies the ID of the field.

          • value

            Specifies the value used in the criterion (e.g., ${NOTEMPTY}).

      • function

        Specifies the function used for the rollup summary calculation (e.g., AVERAGE).

    • based_on_module JSON Object

      Specifies the module on which the rollup summary is based.

      • api_name

        Specifies the API name for the module.

      • id

        Specifies the ID of the module.

    • related_list

      Specifies the related list on which the rollup summary is based.

      • api_name

        Specifies the API name for the related list.

      • id

        Specifies the ID of the related list.

    • rollup_based_on string

      Specifies the basis of the rollup summary calculation. It could be module or layout.

  • multiselectlookupJSON object

    Contains the linking details between the current module (the module specified in the URL parameter) and another module.

    • linking_detailsJSON object

      Contains the details of the linking module. 

      When creating a multi-select lookup field, the system creates a separate module commonly for both connected modules to store their common details.

      • moduleJSON object

        Represents the linking module details.

        • plural_labelstring

          Represents the display label of the linking module visible in the UI.

        • api_namestring

          Represents the API name of the linking module.

        • idstring

          Represents the unique ID of the linking module.

      • lookup_fieldJSON object

        Contains the lookup field details of the current module specified in the URL, created in the linking module.

        • api_namestring

          Represents the API name of the current module's lookup field in the linking module.

        • field_labelstring

          Represents the display name of the current module's lookup field in the linking module visible in the UI.

        • idstring

          Represents the current module lookup field's unique ID in the linking module.

      • connected_lookup_fieldJSON object

        Contains the lookup field details of the connected module (the module connected to the current module) created in the linking module.

        • api_namestring

          Represents the API name of the connected module's lookup field in the linking module.

        • field_labelstring

          Represents the display label of the connected module's lookup field in the linking module.

        • idstring

          Represents the unique ID of the connected module's lookup field in the linking module.

    • connected_detailsJSON object

      Specify the linking details between the current module and the connected module.

      • fieldJSON object

        Contains the details of the current module's lookup field in the connected module.

        • api_namestring

          Represents the API name of the current module's lookup field in the connected module.

        • field_labelstring

          Represents the display name of the current module's lookup field in the connected module.

        • idstring

          Represents the unique ID of the current module's lookup field in the connected module.

      • moduleJSON object

        Contains the details of the connected module.

        • plural_labelstring

          Represents the plural label of the connected module.

        • api_namestring

          Represents the API name of the connected module.

        • idstring

          Represents the unique ID of the connected module.

      • layoutsJSON array

        Contains details of the layout in which the current module's lookup field is associated with the connected module.

    • related_listJSON object

      Contains the details of the connected module's lookup field in the current module.

      • display_labelstring

        Represents the display label of the lookup field in the current module.

      • api_namestring

        Represents the API name of the lookup field in the current module.

      • idstring

        Represents the unique ID of the lookup field in the current module.

  • multiuserlookupJSON object

    Contains the linking details between the current module (specified in the URL) and the Users module.

    • linking_detailsJSON object

      Contains the details of the linking module created for the current module and the Users module.

      Note: When a multi-user lookup field is created, the system automatically generates a linking module to store common details for both modules.

      • moduleJSON object

        Represents the details of the linking module.

        • plural_labelstring

          Represents the plural label of the linking module.

        • api_namestring

          Represents the API name of the linking module.

        • idstring

          Represents the unique ID of the linking module.

      • lookup_fieldJSON object

        Contains details of the lookup field created for the current module in the linking module.

        • api_namestring

          Represents the API name of the current module's lookup field in the linking module.

        • field_labelstring

          Represents the field label of the current module's lookup field in the linking module.

        • idstring

          Represents the unique ID of the current module's lookup field in the linking module.

      • connected_lookup_fieldJSON object

        Contains details of the lookup field created for the Users module in the linking module.

        • api_namestring

          Represents the API name of the Users module's lookup field in the linking module.

        • field_labelstring

          Represents the field label of the Users module's lookup field in the linking module.

        • idstring

          Represents the unique ID of the Users module's lookup field in the linking module.

Sample Response

Copied

Show full

Show less