Retrieve records using a COQL query

POST/coql

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Retrieve records using a COQL query action (under COQL).
Fill in the fields below, then reference the result from later steps as {{retrieveRecordsUsingACoqlQuery.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

select_querystringrequired

Specify the COQL SELECT query to retrieve records. The query must reference module and field API names.

include_metaarray<string>

Specify the list of metadata types to include in the response. Possible values: **fields** - Includes field metadata for the SELECT columns in the response.

json

{
  "select_query": "string",
  "include_meta": [
    "fields"
  ]
}

Response

Returns 200 with an object. Read it in later steps with {{retrieveRecordsUsingACoqlQuery.response.data.<field>}}.

dataarray<object>

Represents the list of records returned by the COQL query. Always returned in the response.

infoobject

Represents the pagination metadata for the query result. Always returned in the response.

countinteger (int32)required

Represents the number of records returned in the current response. Always returned in the response.

more_recordsbooleanrequired

Indicates whether additional records matching the query are available beyond the current page. Always returned in the response. Possible values: **true** - More records are available. Use LIMIT and OFFSET to paginate. **false** - All matching records are included in this response.

fieldsobject

Represents the field metadata for each column specified in the SELECT clause. Keys are field API names and values are field configuration objects. Returned only when **fields** is specified in the **include_meta** request body parameter.

json

{
  "data": [
    {}
  ],
  "info": {
    "count": 0,
    "more_records": false
  },
  "fields": {}
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?