← Zoho CRM

List Objects with Zoho CRM API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
List Objects with the Zoho CRM API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to List Objects 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 Objects action
    1. Connect your Zoho CRM account
    2. Select a Module
    3. Optional- Configure Fields
    4. Optional- Configure IDs
    5. Optional- Select a Sort Order
    6. Optional- Configure Sort By
    7. Optional- Select a Converted
    8. Optional- Select a Approved
    9. Optional- Configure Page
    10. Optional- Configure Per Page
    11. Optional- Configure Custom View ID
    12. Optional- Configure Territory ID
    13. Optional- Configure Include Child
  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

Integrations

List Objects with Zoho CRM API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Zoho CRM
 
Try it
List Objects with Zoho CRM API on New Item in Feed from RSS API
RSS + Zoho CRM
 
Try it
List Objects with Zoho CRM API on New Message from Discord API
Discord + Zoho CRM
 
Try it
List Objects with Zoho CRM API on New Message In Channels from Slack API
Slack + Zoho CRM
 
Try it
List Objects with Zoho CRM API on New Message in Channel from Discord Bot API
Discord Bot + Zoho CRM
 
Try it

Details

This is a pre-built, source-available 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 Objects on Zoho CRM
Description:Gets the list of available records from a module.
Version:0.2.1
Key:zoho_crm-list-objects

Code

import zohoCrm from "../../zoho_crm.app.mjs";

export default {
  key: "zoho_crm-list-objects",
  name: "List Objects",
  description: "Gets the list of available records from a module.",
  version: "0.2.1",
  type: "action",
  props: {
    zohoCrm,
    module: {
      propDefinition: [
        zohoCrm,
        "module",
      ],
    },
    fields: {
      type: "string",
      label: "Fields",
      description: "To retrieve specific field values. Comma separated field API names.",
      optional: true,
    },
    ids: {
      type: "string",
      label: "IDs",
      description: "To retrieve specific records based on their unique ID.",
      optional: true,
    },
    sortOrder: {
      type: "string",
      label: "Sort Order",
      description: "To sort the list of records in either ascending or descending order.",
      optional: true,
      options: [
        "asc",
        "desc",
      ],
    },
    sortBy: {
      type: "string",
      label: "Sort By",
      description: "Specify the API name of the field based on which the records must be sorted.",
      optional: true,
    },
    converted: {
      type: "string",
      label: "Converted",
      description: "To retrieve the list of converted records.",
      optional: true,
      options: [
        "false",
        "true",
        "both",
      ],
    },
    approved: {
      type: "string",
      label: "Approved",
      description: "To retrieve the list of approved records.",
      optional: true,
      options: [
        "false",
        "true",
        "both",
      ],
    },
    page: {
      type: "string",
      label: "Page",
      description: "To get the list of records from the respective pages.",
      optional: true,
    },
    perPage: {
      type: "string",
      label: "Per Page",
      description: "To get the list of records available per page.",
      optional: true,
    },
    cvId: {
      type: "string",
      label: "Custom View ID",
      description: "To get the list of records in a custom view.",
      optional: true,
    },
    territoryId: {
      type: "string",
      label: "Territory ID",
      description: "To get the list of records in a territory.",
      optional: true,
    },
    includeChild: {
      type: "boolean",
      label: "Include Child",
      description: "To include records from the child territories",
      optional: true,
    },
  },
  async run({ $ }) {
    const params = {
      fields: this.fields,
      ids: this.ids,
      sort_order: this.sortOrder,
      sort_by: this.sortBy,
      converted: this.converted,
      approved: this.approved,
      page: this.page,
      per_page: this.perPage,
      cvid: this.cvId,
      territory_id: this.territoryId,
      include_child: this.includeChild,
    };
    const response = await this.zohoCrm.listRecords(this.module, this.page, params, $);
    $.export("$summary", "Successfully listed objects");
    return response;
  },
};

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 CRMzohoCrmappThis component uses the Zoho CRM app.
ModulemodulestringSelect a value from the drop down menu.
Fieldsfieldsstring

To retrieve specific field values. Comma separated field API names.

IDsidsstring

To retrieve specific records based on their unique ID.

Sort OrdersortOrderstringSelect a value from the drop down menu:ascdesc
Sort BysortBystring

Specify the API name of the field based on which the records must be sorted.

ConvertedconvertedstringSelect a value from the drop down menu:falsetrueboth
ApprovedapprovedstringSelect a value from the drop down menu:falsetrueboth
Pagepagestring

To get the list of records from the respective pages.

Per PageperPagestring

To get the list of records available per page.

Custom View IDcvIdstring

To get the list of records in a custom view.

Territory IDterritoryIdstring

To get the list of records in a territory.

Include ChildincludeChildboolean

To include records from the child territories

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

Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.

More Ways to Use Zoho CRM

Triggers

New Contact (Instant) from the Zoho CRM API

Emits an event each time a new contact is created in Zoho CRM

 
Try it
New Event (Instant) from the Zoho CRM API

Emit new custom events from Zoho CRM

 
Try it
New Lead (Instant) from the Zoho CRM API

Emits an event each time a new lead is created in Zoho CRM

 
Try it
New Module Entry (Instant) from the Zoho CRM API

Emit new events each time a new module/record is created in Zoho CRM

 
Try it
New or Updated Contact (Instant) from the Zoho CRM API

Emits an event each time a new contact is created or updated in Zoho CRM

 
Try it

Actions

Convert Lead with the Zoho CRM API

Converts a Lead into a Contact or an Account. See the documentation

 
Try it
Create Object with the Zoho CRM API

Create a new object/module entry. See the documentation

 
Try it
Download Attachment with the Zoho CRM API

Downloads an attachment file from Zoho CRM, saves it in the temporary file system and exports the file path for use in a future step.

 
Try it
Get Object with the Zoho CRM API

Gets record data given its id.

 
Try it
List Fields with the Zoho CRM API

Gets the field metadata for the specified module

 
Try it

Explore Other Apps

1
-
24
of
2,400+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.