Zoho CRM: Coql Execute Coqlquery

Query Zoho CRM records with a SQL-like COQL select statement and get the matching rows.

Tool ID: zoho_crm_coql_execute_coqlquery

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_coql_execute_coqlquery',
  {
    "select_query": "software companies hiring engineers"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute zoho_crm_coql_execute_coqlquery --input '{
  "select_query": "software companies hiring engineers"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "data": [
      {}
    ],
    "info": {
      "count": 123,
      "more_records": true
    }
  }
}

Use deepline describe zoho_crm_coql_execute_coqlquery --json for the latest machine-readable contract.

Input reference

Request Body to get records data using COQL

Name	Type	Required	Default	Details
`payload.select_query`	`string`	Yes	—	COQL select query to fetch records data Maximum length: 2147483647.
`payload.include_meta`	`array`	No	—	List of metadata to include in the response. Currently only supports ‘fields’ to get field metadata for select columns. Minimum items: 1. Maximum items: 1.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Response containing matching records and pagination info
`result.data.data`	`array`	Yes	—	Root key containing list of records Minimum items: 1. Maximum items: 200.
`result.data.info`	`object`	Yes	—	Pagination and count information
`result.data.info.count`	`integer`	Yes	—	Number of records returned Format: `int32`.
`result.data.info.more_records`	`boolean`	Yes	—	Indicates if there are more records available
`result.data.fields`	`record`	No	—	Field metadata for the select columns. Keys are field API names and values are field metadata objects.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

This output schema is too large for an inline display. Read the complete live contract with deepline describe zoho_crm_coql_execute_coqlquery --json.

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation