View as Markdown
Zoho CRM icon

Zoho CRM ACTION

List Objects

Gets the list of available records from a module.
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Zoho CRM account once, then configure and run List Objects from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "zoho_crm-list-objects",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    zoho_crm: { authProvisionId: "apn_xxxxxxx" },
    module: "Module",
    fields: "Fields",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Objects inputs
Property Type Description
module Module string
Module where the record will be created. Use the List Modules action to get the list of available modules.
Required Dynamic
fields Fields string
To retrieve specific field values. Comma separated field API names.
Optional
ids IDs string
To retrieve specific records based on their unique ID.
Optional
sortOrder Sort Order string
To sort the list of records in either ascending or descending order.
Optional
sortBy Sort By string
Specify the API name of the field based on which the records must be sorted.
Optional
converted Converted string
To retrieve the list of converted records.
Optional
approved Approved string
To retrieve the list of approved records.
Optional
page Page string
To get the list of records from the respective pages.
Optional
perPage Per Page string
To get the list of records available per page.
Optional
cvId Custom View ID string
To get the list of records in a custom view.
Optional
territoryId Territory ID string
To get the list of records in a territory.
Optional
includeChild Include Child boolean
To include records from the child territories
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
zoho_crm-list-objects
Version
0.2.3
App
Zoho CRM
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes