Get Records through a COQL Query

Purpose

To get the records from the module through a COQL query.

Endpoints

Request Details

Request URL

{api-domain}/crm/{version}/coql

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.coql.READ
(and)
scope=ZohoCRM.modules.{operation_type}
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}

Possible module names

leads, accounts, contacts, users, deals, campaigns, tasks, cases, events, calls, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, and custom

Possible operation types

ALL - Full data access
READ - Get module data

Note

  • Although you "get" records from the module, the HTTP method is POST as you "post" the query. Refer to Query API - An Overview to learn how to construct a COQL query.
  • When you use a module's API name in the query, prefix an ! to differentiate between a module's and field's API name. For example, !Leads.Owner.role.id.

Request JSON

  • select_queryJSON key, mandatory

    Represents that the input is a select query.

Sample Request

CurlDeluge
Copiedcurl "https://www.zohoapis.com/crm/v7/coql"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"
-X POST
CopiedqueryMap = Map();
queryMap.put("select_query", "select Last_Name, First_Name, Full_Name from Contacts where Last_Name = 'Boyle' and First_Name is not null limit 2");
response = invokeurl
[
	url :"https://www.zohoapis.com/crm/v7/coql"
	type :POST
	parameters: queryMap.toString()
	connection:"crm_oauth_connection"
];
info response;

In the request, "@input.json" contains the sample input data.

Field Types and their Comparators

The following sections describe the field types and their allowed comparators in the COQL query with an example each.

  • Text, Picklist

    =, !=, like(used for starts_with, ends_with, contains), not like(used for not_contains), in, not in, is null, is not null.

Note

The % wildcard can be used with the like operator to achieve functionalities similar to the contains, starts_with, and ends_with operators. For instance, '%tech' queries for field values ending with 'tech', 'C%' queries for values starting with 'C', and '%tech%' translates to contains 'tech'.

Please note that for the Not Like operator, it only works if you give '%' at both ends (not contains). Using '%' only at the beginning (not starting with) or at the end (not ending with) doesn't work.

The valid cases are:

  • like "%tech" - ends with 'tech'
  • like "%tech%" - contains 'tech'
  • like "tech%" - starts with 'tech'
  • not like "%tech%" - does not contain 'tech'

Sample Input

Copied{
 "select_query" : "select Last_Name, First_Name, Full_Name, Lead_Source, Languages_Known
                  from Contacts 
                 where (((Last_Name = 'Boyle') and (Lead_Source = Advertisement)) and Languages_Known = 'English;German') limit 2"
}

Response JSON Keys

  • First_Namestring

    Represents the first name of the contact.

  • Last_Namestring

    Represents the last name of the contact.

  • Full_Namestring

    Represents the full name of the contact.

  • idstring

    Represents the unique ID of the contact.

  • Languages_KnownJSON array

    Represents the values selected in the multi-select picklist.

  • Lead_Sourcestring

    Represents the value selected in the picklist.

Sample Response

Copied{
  "data": [
    {
      "First_Name": "Patricia",
      "Full_Name": "Patricia Boyle",
      "Last_Name": "Boyle",
      "Languages_Known": [
        "English",
        "German"
      ],
      "Lead_Source": "Advertisement",
      "id": "554023000000310003"
    },
    {
      "First_Name": "Steve",
      "Full_Name": "Steve Boyle",
      "Last_Name": "Boyle",
      "Languages_Known": [
        "English",
        "German"
      ],
      "Lead_Source": "Advertisement",
      "id": "554023000000310012"
    }
  ],
  "info": {
    "count": 2,
    "more_records": false
  }
}

  • Lookup

    =, !=, in, not in, is null, is not null.

    Note: When you query a lookup field, the response only contains the ID of the field. To get the name of the field, you must include the field_API_name in the query.

Sample Input

Copied{
    "select_query": "select Last_Name, First_Name, Full_Name, Account_Name 
    from Contacts 
    where 
    ((Last_Name = 'Boyle') and (First_Name is not null)) and (Account_Name.Account_Name = 'Zylker')
    limit 2"
}

In this query, the join is established through the lookup field Account_Name in the Contacts module.

Response JSON Keys

  • Account_Name.Account_Namestring

    Here, Account_Name returns the ID of the account and Account_Name.Account_Name returns the account name of the account that the contact is associated with.

Note

  • Encrypted numeric fields support =, !=, is null and is not null.
  • Encrypted fields are supported in the SELECT column and in the WHERE clause.
  • Encrypted non-numeric fields support only is null and is not null.

Sample Response

Copied{
    "data": [
        {
            "First_Name": "Patricia",
            "Full_Name": "Patricia Boyle",
            "Vendor_Name": {
                "id": "554023000000310037"
            },
            "Last_Name": "Boyle",
            "Account_Name.Account_Name": "Zylker",
            "Account_Name": {
                "id": "554023000000238116"
            },
            "id": "554023000000310003"
        }
    ],
    "info": {
        "count": 1,
        "more_records": true
    }
}

Sample query With two relations (joins)

select Last_Name, Account_Name.Parent_Account, Account_Name.Parent_Account.Account_Name from Contacts where Last_Name is not null and Account_Name.Parent_Account.Account_Name is not null

In this query, two joins are established using the lookup field Account_Name in the Contacts module and another lookup field Parent_Account in the Accounts module.

Sample Input

Copied{
 "select_query" : "select Last_Name, Account_Name.Parent_Account, Account_Name.Parent_Account.Account_Name
                  from Contacts
                  where Last_Name is not null and Account_Name.Parent_Account.Account_Name is not null"
}

Response JSON Keys

  • Account_Name.Parent_Account.Account_Namestring

    Here, the relation Account_Name.Parent_Account returns the ID of the parent account of the account associated with the contact. The relation Account_Name.Parent_Account.Account_Name returns the name of the parent account of the account associated with the contact.

Sample Response

Copied{
    "data": [
        {
            "Account_Name.Parent_Account.Account_Name": "Zylker",
            "Last_Name": "Boyle",
            "Account_Name.Parent_Account": {
                "id": "554023000000238121"
            },
            "id": "554023000000310003"
        },
        {
            "Account_Name.Parent_Account.Account_Name": "Zylker",
            "Last_Name": "Patricia",
            "Account_Name.Parent_Account": {
                "id": "554023000000238121"
            },
            "id": "554023000000310012"
        }
    ],
    "info": {
        "count": 2,
        "more_records": false
    }
}

Sample query with User/Owner Lookup Field

select Last_Name, First_Name, Full_Name, Owner from Contacts where Last_Name = 'Boyle' and Owner = '554023000000235011' limit 3

In this query, Owner is the lookup field in the Contacts module. This query fetches records from the contacts module with the specified last name and whose owner id is 554023000000235011.

Sample Input

Copied{
 "select_query" : "select Last_Name, First_Name, Full_Name, Owner
                  from Contacts
                  where Last_Name = 'Boyle' and Owner = '554023000000235011'
                  limit 3"
}

Response JSON Keys

  • OwnerJSON object

    Represents the unique ID of the record owner.

Sample Response

Copied{
    "data": [
        {
            "First_Name": "Patricia",
            "Full_Name": "Patricia Boyle",
            "Owner": {
                "id": "554023000000235011"
            },
            "Last_Name": "Boyle",
            "id": "554023000000310003"
        }
    ],
    "info": {
        "count": 1,
        "more_records": false
    }
}

  • Date, DateTime, Number

    =, !=, >=, >, <=, <, between, not between, in, not in, is null, is not null.

    Note

    Using the DateTime field, you can filter records based on any timezones.

Sample Input

Copied{
    "select_query": "select Last_Name,Days_Visited, Created_Time, Date_of_Birth, Modified_Time from Contacts where (((Created_Time between '2023-05-28T04:25:36-07:00' and '2025-05-28T04:25:36-07:00') and Date_of_Birth between '2022-03-04' and '2025-07-11') and (Modified_Time in('2024-06-05T02:04:09-07:00','2024-07-03T00:00:01+05:30') and Days_Visited is null)) limit 1"
}

Response JSON Keys

  • Created_TimeDate Time in ISO 8601 format

    Represents the date and time at which the record was created.

  • Modified_TimeDate Time in ISO 8601 format 

    Represents the date and time at which the record was modified.

  • Days_VisitedNumber

    Number of days the lead or contact visited your customer's website.

  • Annual_RevenueCurrency

    Represents the last name of the record.

Sample Response

Copied{
    "data": [
        {
            "Modified_Time": "2024-06-05T02:04:09-07:00",
            "Date_of_Birth": "2024-06-05",
            "Days_Visited": null,
            "Last_Name": "Boyle",
            "Created_Time": "2024-05-28T04:25:36-07:00",
            "id": "5725767000002889886"
        }
    ],
    "info": {
        "count": 1,
        "more_records": false
    }
}
  • Boolean

    =

Sample Request

Copied{
 "select_query" : "select Last_Name, First_Name, Full_Name, Email_Opt_Out
                  from Contacts
                  where Email_Opt_Out = 'true'
                  limit 2"
}

Response JSON Keys

  • Email_Opt_OutBoolean

    Represents the email preference of the contact.

Sample Response

Copied{
    "data": [
        {
            "First_Name": "Patricia",
            "Full_Name": "Patricia Boyle",
            "Email_Opt_Out": true,
            "Last_Name": "Boyle",
            "id": "554023000000310003"
        }
    ],
    "info": {
        "count": 1,
        "more_records": false
    }
}

  • What_Id support

    =, !=, in, not in, is null, is not null.

    The What_Id support is applicable only for Tasks, Calls, and Events. While using What_Id to retrieve records in COQL, the associated record may be one of several different types of records. For example, the What_Id field of a Task may be a Lead or a Contact.

Sample Input

Copied{
    "select_query": "select 'What_Id->Leads.Last_Name' from Tasks where 'What_Id->Leads.id' = '4150868000004479013'"
}

Response JSON Keys

  • What_Id->Leads.Last_NameString

    Represents last name of the Lead for whom the activity (Task, Call, Event) was created.

Sample Response

Copied{
    "data": [
        {
            "What_Id->Leads.Last_Name": "Patricia Boyle",
            "id": "4150868000004920001"
        }
    ],
    "info": {
        "count": 1,
        "more_records": false
    }
}

  • Roles and Profiles support

    =, !=, in, not in, is null, is not null.

    You can fetch the details of the owner's profile such as ID, name, created_by, modified_by, description, created_time, modified_time and the details of the owner's role such as ID, name, reporting_to, share_data_with_peers, description from a module.

Sample Input

Copied{
    "select_query": "select Owner.profile.id,Owner.profile.name,Owner.profile.created_by,Owner.profile.modified_by,Owner.profile.description,Owner.profile.created_time,Owner.profile.modified_time from Contacts where Last_Name is not null limit 2"
}

Sample Response

Copied{
    "data": [
        {
            "Owner.profile.id": "3652397000000026011",
            "Owner.profile.modified_by": null,
            "Owner.profile.description": "crm.security.profile.admin.desc",
            "Owner.profile.created_by": null,
            "Owner.profile.modified_time": null,
            "Owner.profile.created_time": null,
            "id": "3652397000000190181",
            "Owner.profile.name": "Administrator"
        },
        {
            "Owner.profile.id": "3652397000000026011",
            "Owner.profile.modified_by": null,
            "Owner.profile.description": "crm.security.profile.admin.desc",
            "Owner.profile.created_by": null,
            "Owner.profile.modified_time": null,
            "Owner.profile.created_time": null,
            "id": "3652397000000190182",
            "Owner.profile.name": "Administrator"
        }
    ],
    "info": {
        "count": 2,
        "more_records": true
    }
}

  • Alias support

    =, !=, in, not in, is null, is not null.

    You can now fetch the details of a record through the alias "as" in the select query. For example, in the Contacts module, 'Account_Name' AS 'Account id' in the select query fetches the ID of the Account the contact is associated with in the field "Account id" in the response. Refer to the sample input section for more such aliases.
    Note that you can only use alias in the select columns and the "order_by" clause.

Sample Input

Copied{
    "select_query":"select 'Account_Name' AS 'Account id','Account_Name.Account_Name' as 'Account Name','Account_Name.Parent_Account' as 'Parent Account id','Account_Name.Parent_Account.Account_Name' As 'Parent Account Name' from Contacts where (Account_Name.Account_Name ='Zylker') order by Account_Name desc limit 2"
}

Response JSON Keys

  • Account idJSON Object

    Represents the ID of the Account the contact is associated with.

  • Account NameString

    Represents the name of the Account the contact is associated with.

  • Parent Account idJSON Object

    Represents the ID of the parent account the contact's account is associated with.

  • idString

    Represents the ID of the contact.

Sample Response

Copied{
    "data": [
        {
            "Account id": {
                "id": "3652397000000624046"
            },
            "Account Name": "Zylker",
            "Parent Account id": {
                "id": "3652397000000190102"
            },
            "Parent Account Name": "King",
            "id": "3652397000000269089"
        },
        {
            "Account id": {
                "id": "3652397000000624046"
            },
            "Account Name": "Zylker",
            "Parent Account id": {
                "id": "3652397000000190102"
            },
            "Parent Account Name": "King",
            "id": "3652397000000649013"
        }
    ],
    "info": {
        "count": 2,
        "more_records": true
    }
}

  • Sample Query using External ID

    You can use the external field of a module in the select query and the "where" clause. In this example, External_Account_ID is the API name of the external field in the Accounts module.

Sample Input

Copied{
    "select_query":"select Account_Name, External_Account_ID, Parent_Account.Account_Name, Parent_Account.External_Account_ID from Accounts where Parent_Account.External_Account_ID = 'ZylkerExternal'"
}

Sample Response

Copied{
    "data": [
        {
            "Parent_Account.Account_Name": "Zylker",
            "Parent_Account.External_Account_ID": "ZylkerExternal",
            "Account_Name": "Account 2",
            "id": "3652397000000714002",
            "External_Account_ID": null
        },
        {
            "Parent_Account.Account_Name": "Zylker",
            "Parent_Account.External_Account_ID": "ZylkerExternal",
            "Account_Name": "ExtAccounttest",
            "id": "3652397000010110022",
            "External_Account_ID": "externalaccount1"
        }
    ],
    "info": {
        "count": 2,
        "more_records": false
    }
}

Aggregate Function

You can now use the aggregate functions SUM, MIN, MAX, AVG, and COUNT in the select query. The following sections give an example for each of the supported aggregate functions. Note that aggregate functions are case-sensitive.

  • SUM

    Use this function to sum up the values of an aggregate field in a module. This sample query fetches the total annual revenue generated from the leads whose individual annual revenue is greater than 1000.

Sample Query

Copied{
    "select_query":"select SUM(Annual_Revenue), Company, Last_Name from Leads where Annual_Revenue >= 1000 Group by Company, Last_Name"
}

Sample Response

Copied{
    "data": [
        {
            "Company": "abc",
            "Last_Name": "Lead_changed",
            "SUM(Annual_Revenue)": 100000
        },
        {
            "Company": "Creative Business Inc",
            "Last_Name": "Kitzman",
            "SUM(Annual_Revenue)": 100000
        },
        {
            "Company": "Dal Tile Corporation",
            "Last_Name": "Frey",
            "SUM(Annual_Revenue)": 200000
        },
        {
            "Company": "Grayson",
            "Last_Name": "Tjepkema",
            "SUM(Annual_Revenue)": 170000
        },
        {
            "Company": "Kwik Kopy Printing",
            "Last_Name": "Merced",
            "SUM(Annual_Revenue)": 700000
        },
        {
            "Company": "Morlong Associates",
            "Last_Name": "Sweely",
            "SUM(Annual_Revenue)": 190000
        }
    ],
    "info": {
        "count": 6,
        "more_records": false
    }
}

  • MAX

    This function gives the maximum value of an aggregate field. The sample query uses this function to fetch the maximum annual revenue of leads that belong to the Company "ABC".

Sample Query

Copied{
    "select_query": "select MAX(Annual_Revenue), Last_Name, Company from Leads where Annual_Revenue > 1000 Group by Last_Name, Company"
}

Sample Response

Copied{
    "data": [
        {
            "Company": "Dal Tile Corporation",
            "Last_Name": "Frey",
            "MAX(Annual_Revenue)": 200000
        },
        {
            "Company": "Creative Business Inc",
            "Last_Name": "Kitzman",
            "MAX(Annual_Revenue)": 100000
        },
        {
            "Company": "abc",
            "Last_Name": "Lead_changed",
            "MAX(Annual_Revenue)": 100000
        },
        {
            "Company": "Kwik Kopy Printing",
            "Last_Name": "Merced",
            "MAX(Annual_Revenue)": 700000
        },
        {
            "Company": "Morlong Associates",
            "Last_Name": "Sweely",
            "MAX(Annual_Revenue)": 190000
        },
        {
            "Company": "Grayson",
            "Last_Name": "Tjepkema",
            "MAX(Annual_Revenue)": 170000
        }
    ],
    "info": {
        "count": 6,
        "more_records": false
    }
}

  • MIN

    This function gives the minimum value of an aggregate field. The sample query uses this function to fetch the minimum annual revenue of leads that belong to the Company "ABC".

Sample Query

Copied{
    "select_query":"select MIN(Annual_Revenue) from Leads where Annual_Revenue != 0"
}

Sample Response

Copied{
    "data": [
        {
            "MIN(Annual_Revenue)": 100000
        }
    ],
    "info": {
        "count": 1,
        "more_records": false
    }
}

  • AVG

    Use this function to get the average value of the values of a field. This sample query fetches the average annual revenue generated from the leads.

Sample Query

Copied{
    "select_query":"select AVG(Annual_Revenue) from Leads where Annual_Revenue != 0"
}

Sample Response

Copied{
    "data": [
        {
            "AVG(Annual_Revenue)": 243333.33333333334
        }
    ],
    "info": {
        "count": 1,
        "more_records": false
    }
}

  • COUNT

    Use the COUNT function to get the number of records that satisfy the criteria in the select query.

    The sample query retrieves the count of lead records with annual revenue over 25,000. The records are grouped based on the lead source using the group by clause. For example, you can see that there are two records with annual revenue over 25,000 whose lead source is "Online Store". Similarly, for the lead source "Advertisement", there are two records with annual revenue greater than 25,000.
    Note that you can use this aggregate function only for number, lookup, and picklist fields.

Possible Errors

  • SYNTAX_ERRORHTTP 400

    The query does not contain either proper criteria, base table, or the where clause.
    Resolution: Form a query with proper criteria, base table, and the where clause.

  • SYNTAX_ERRORHTTP 400

    The query does not contain the from clause.
    Resolution: Form a query with the from clause.

  • SYNTAX_ERRORHTTP 400

    The request contains a query other than select.
    Example: ""select_query" : "update Leads set Last_Name = 'Last' where id = 12356".
    Resolution: You can only use the Select statement in your select query.

  • SYNTAX_ERRORHTTP 400

    Parsing is happening for so long for the given query. please validate the query.
    Resolution: The given query is either too complex or has unbalanced parentheses. Please specify a valid and optimized query.

  • LIMIT_EXCEEDEDHTTP 400

    The value of limit clause or the select column (field API names) has exceeded the maximum limit of 200 and 50, respectively.
    Resolution: You can fetch only a maximum of 200 records and 50 fields in a single API call.

  • LIMIT_EXCEEDEDHTTP 400

    The query has more than two joins.
    Example: ""select_query" : "select Account_Name.Account_Name, Account_Name.Parent_Account.Account_Name, Vendor_Name.Vendor_Name from Contacts where Lead_Source = Advertisement"
    Resolution: You can only have a maximum of two joins in a select query.

  • LIMIT_EXCEEDEDHTTP 400

    You have specified more than 50 values for the "in" or "not in" comparators of the select query.
    Resolution: You can specify only a maximum of 50 values for the "in" or "not in" comparators.

  • LIMIT_EXCEEDEDHTTP 400

    Max records limit exceeded
    Resolution: You can use pagination and fetch only up to 10,000 records using a COQL query.

  • INVALID_QUERYHTTP 400

    The query contains an invalid column name (field_API_name).
    Example: "select Last_Name, Testing from Leads where Last_Name is not null"
    Resolution: Provide a valid field API name.

  • INVALID_QUERYHTTP 400

    The query contains unsupported data type.
    Example: "select Last_Name, Contacts from Leads where Last_Name is not null"
    Here, Contacts is a multi-select lookup field and not supported in COQL.
    Resolution: Provide field API names with valid data type.

  • INVALID_QUERYHTTP 400

    The data type of the value of the select column is invalid.
    Example: "select_query" : "select Last_Name from Leads where Last_Name is not null and No_of_Employees = 'adfkahfd'"
    Here, the expected data type for No_of_Employees is a number, whereas the value given is a string.
    Resolution: Provide the values of the select column corresponding to its data type.

  • INVALID_QUERYHTTP 400

    What_Id references should refer the single module in the query.
    Example: "select_query" : "select_query":"select 'What_Id->Contacts.Last_Name' from Tasks/Calls/Events where 'What_Id->Leads.id' = '111111000000048055'"; Resolution: Ensure that you refer to a single module with What_Id.

  • INVALID_QUERYHTTP 400

    The query contains an invalid operator.
    Example: "select_query" : "select Last_Name from Leads where Last_Name is not null and Last_Name >= 'adfkahfd'" Resolution: Use only those operators that are accepted by the respective fields.

  • INVALID_ALIASHTTP 400

    The alias name cannot be an empty string
    Example: "select Account_Name 'Account_as','Account_Name.Account_Name' \" \"
    Resolution: Provide a valid alias.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    User does not have the required scope to access the module.
    Resolution: Contact your administrator to obtain the required permission.

  • DUPLICATE_DATAHTTP 401

    The query contains duplicate select columns (field_API_names). Example: "select_query" : "select Last_Name, First_Name, Full_Name, Created_Time, Full_Name from Contacts where Lead_Source = Advertisement limit 2"
    Here, the query contains Full_Name twice.
    Resolution: Ensure that there are no duplicate select columns in the query.

  • DUPLICATE_ALIASHTTP 400

    The same alias cannot refer to more than one select column
    Resolution: Ensure that you use unique alias for each select column .

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in Server. Contact support team.

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.

Sample Query

Copied{
"select_query": "select COUNT(Annual_Revenue), Lead_Source from Leads where Annual_Revenue >25000 group by Lead_Source"
}

Sample Response

Copied{
    "data": [
        {
            "COUNT(Annual_Revenue)": 3,
            "Lead_Source": null
        },
        {
            "COUNT(Annual_Revenue)": 1,
            "Lead_Source": "Seminar Partner"
        },
        {
            "COUNT(Annual_Revenue)": 2,
            "Lead_Source": "Online Store"
        },
        {
            "COUNT(Annual_Revenue)": 1,
            "Lead_Source": "Partner"
        },
        {
            "COUNT(Annual_Revenue)": 1,
            "Lead_Source": "External Referral"
        },
        {
            "COUNT(Annual_Revenue)": 1,
            "Lead_Source": "Web Download"
        },
        {
            "COUNT(Annual_Revenue)": 2,
            "Lead_Source": "Advertisement"
        },
        {
            "COUNT(Annual_Revenue)": 1,
            "Lead_Source": "Cold Call"
        }
    ],
    "info": {
        "count": 8,
        "more_records": false
    }
}