zoho_list_records

Pack: zoho_crm · Endpoint: https://gateway.pipeworx.io/zoho_crm/mcp

List records from a Zoho CRM module (e.g., Leads, Contacts, Deals).

Parameters

NameTypeRequiredDescription
modulestringyesModule name (e.g., Leads, Contacts, Deals, Accounts)
fieldsstringnoComma-separated field names to return (e.g., “Last_Name,Email,Phone”). Defaults to common fields.
per_pagenumbernoRecords per page (max 200, default 20)
pagenumbernoPage number (default 1)

Example call

Arguments

{
  "module": "Leads"
}

curl

curl -X POST https://gateway.pipeworx.io/zoho_crm/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"zoho_list_records","arguments":{"module":"Leads"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('zoho_list_records', {
  "module": "Leads"
});

More examples

{
  "module": "Contacts",
  "fields": "Last_Name,Email,Phone",
  "per_page": 50,
  "page": 1
}

Response shape

FieldTypeDescription
errorstringError code if connection not available
messagestringError message if connection not available
dataarrayArray of records from the module
Full JSON Schema
{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Error code if connection not available"
    },
    "message": {
      "type": "string",
      "description": "Error message if connection not available"
    },
    "data": {
      "type": "array",
      "description": "Array of records from the module",
      "items": {
        "type": "object",
        "description": "Record object with requested fields"
      }
    }
  }
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "zoho_crm": {
      "url": "https://gateway.pipeworx.io/zoho_crm/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

Regenerated from source · build May 9, 2026