← Zoho CRM

List Fields with Zoho CRM API

Pipedream makes it easy to connect APIs for Zoho CRM and 800+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
List Fields with the Zoho CRM API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Create a workflow to List Fields with the Zoho CRM API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the List Fields action
    1. Connect your Zoho CRM account
    2. Select a module
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

List Fields on Zoho CRM
Description:Gets the field metadata for the specified module
Version:0.1.2
Key:zoho_crm-list-fields

Code

// legacy_hash_id: a_poizYA
import { axios } from "@pipedream/platform";

export default {
  key: "zoho_crm-list-fields",
  name: "List Fields",
  description: "Gets the field metadata for the specified module",
  version: "0.1.2",
  type: "action",
  props: {
    zoho_crm: {
      type: "app",
      app: "zoho_crm",
    },
    module: {
      type: "string",
      description: "Module name to get the field metadata for.",
      options: [
        "Leads",
        "Accounts",
        "Contacts",
        "Deals",
        "Campaigns",
        "Tasks",
        "Cases",
        "Events",
        "Calls",
        "Solutions",
        "Products",
        "Vendors",
        "Quotes",
        "Price_Books",
        "Quotes",
        "Sales_Orders",
        "Purchase_Orders",
        "Invoices",
        "Custom",
        "Activities",
      ],
    },
  },
  async run({ $ }) {
  //See Zoho CRM API docs at: https://www.zoho.com/crm/developer/docs/api/v2/field-meta.html

    if (!this.module) {
      throw new Error("Must provide module parameter.");
    }

    return await axios($, {
      url: `${this.zoho_crm.$auth.api_domain}/crm/v2/settings/fields`,
      params: {
        module: this.module,
      },
      headers: {
        "Authorization": `Zoho-oauthtoken ${this.zoho_crm.$auth.oauth_access_token}`,
      },
    });
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
Zoho CRMzoho_crmappThis component uses the Zoho CRM app.
modulestringSelect a value from the drop down menu:LeadsAccountsContactsDealsCampaignsTasksCasesEventsCallsSolutionsProductsVendorsQuotesPrice_BooksQuotesSales_OrdersPurchase_OrdersInvoicesCustomActivities

Authentication

Zoho CRM uses OAuth authentication. When you connect your Zoho CRM account, Pipedream will open a popup window where you can sign into Zoho CRM and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Zoho CRM API.

Pipedream requests the following authorization scopes when you connect your account:

ZohoCRM.settings.allZohoCRM.users.allZohoCRM.org.allZohoCRM.modules.allZohoCRM.bulk.allZohoCRM.notifications.readZohoCRM.notifications.createZohoCRM.notifications.updateZohoCRM.notifications.deleteZohoCRM.coql.READZohoCRM.functions.execute.READZohoCRM.functions.execute.CREATEZohoCRM.templates.email.READZohoCRM.templates.inventory.READ

About Zoho CRM

Customer Relationship Management