`zoho_search_records`

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

Search records in a Zoho CRM module using criteria.

Parameters

Name	Type	Required	Description
`module`	string	yes	Module name (e.g., Leads, Contacts, Deals)
`criteria`	string	yes	Search criteria (e.g., “(Last_Name:equals:Smith)“)
`per_page`	number	no	Records per page (max 200, default 20)
`page`	number	no	Page number (default 1)

Example call

Arguments

{
  "module": "Contacts",
  "criteria": "(Last_Name:equals:Smith)"
}

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_search_records","arguments":{"module":"Contacts","criteria":"(Last_Name:equals:Smith)"}}}'

TypeScript (@pipeworx/sdk)

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

const result = await pipeworx.call('zoho_search_records', {
  "module": "Contacts",
  "criteria": "(Last_Name:equals:Smith)"
});

More examples

{
  "module": "Leads",
  "criteria": "(Email:contains:example.com)",
  "per_page": 100
}

Response shape

Field	Type	Description
`error`	string	Error code if connection not available
`message`	string	Error message if connection not available
`data`	array	Array of records matching search criteria

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 matching search criteria",
      "items": {
        "type": "object",
        "description": "Record object matching the criteria"
      }
    }
  }
}

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.

zoho_search_records