Your use case. Our milestone. The 200th post in our "Kaizen Series: Continuous Improvement for Developer Experience" is coming up. Share Now

X
Skip to product menu
close
  • Recent Launches
    Press Space or Enter to display list of options
EXPLORE ALL PRODUCTS

Recent Launches

New

Easy domain registration, transfer, and secured DNS management.

Try now
New

Payroll software with automated tax payments and filing.

Try now
New

Low-code IoT platform and solutions for connected businesses.

Try now
New

Business formation service to launch and grow your businesses.

Try now
New

Unified payment solution built for all businesses.

Try now
New

Comprehensive email security and archiving for every business.

Try now
Suites

Cloud-based qualitative data analysis tool.

Try now
New

Online community platform for individuals and businesses to grow their network and brand.

Try now
New

Modern retail POS to sell better, manage your entire business, and join the digital revolution.

Try now
SuitesNew

Unified project management platform for intelligent, data-driven work.

Try now
Suites

Unified platform for customer service and support teams.

Try now

Sales

CRM

Comprehensive CRM platform for customer-facing teams.

CRM
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
Forms

Build online forms for every business need.

Forms
Bigin

Simple CRM for small businesses moving from spreadsheets.

Bigin
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Bookings

Appointment scheduling app for consultations with customers.

Bookings
RouteIQ

Comprehensive sales map visualization and optimal route planning solution.

RouteIQ
Thrive

Complete loyalty and affiliate management platform.

Thrive
Suites
CRM Plus

Unified platform to deliver top-notch customer experience.

CRM Plus

Marketing

Campaigns

Create, send, and track targeted email campaigns that drive sales.

Campaigns
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
Forms

Build online forms for every business need.

Forms
Social

All-in-one social media management software.

Social
Survey

Design surveys to reach and interact with your audience.

Survey
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Sites

Online website builder with extensive customisation options.

Sites
Backstage

End-to-end event management software.

Backstage
PageSense

Website conversion optimization and personalisation platform.

PageSense
Marketing Automation

All-in-one marketing automation software.

Marketing Automation
LandingPage

Smart landing page builder to increase conversion rates

LandingPage
Webinar

Webinar platform for webcasting online webinars.

Webinar
NEW
LeadChain

Sync, manage, and convert leads across channels seamlessly.

LeadChain
NEW
Domains

Easy domain registration, transfer, and secured DNS management.

Domains
NEW
CommunitySpaces

Online community platform for individuals and businesses to grow their network and brand.

CommunitySpaces
Thrive

Complete loyalty and affiliate management platform.

Thrive
Publish

Manage all your local business listings on a single platform.

Publish
Suites
Marketing Plus

Unified marketing platform for marketing teams.

Marketing Plus

Commerce and POS

Commerce

eCommerce platform to manage and market your online store.

Commerce

Service

Desk

Helpdesk software to deliver great customer support.

Desk
Assist

Remote support and unattended remote access software.

Assist
Voice

Cloud Contact Center Software for businesses.

Voice
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Bookings

Appointment scheduling app for consultations with customers.

Bookings
FSM

End-to-end field service management platform for service businesses.

FSM
Lens

Interactive remote assistance software with augmented reality.

Lens
Solo

The all-in-one toolkit for solopreneurs.

Solo
Suites
Service Plus

Unified platform for customer service and support teams.

Service Plus

Finance

Books

Powerful accounting platform for growing businesses.

Books
Expense

Effortless expense reporting platform.

Expense
Sign

Digital signature app for businesses.

Sign
Inventory

Powerful stock management and inventory control software.

Inventory
FREE
Invoice

100% Free invoicing solution.

Invoice
Billing

End-to-end billing solution for your business.

Billing
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
Commerce

eCommerce platform to manage and market your online store.

Commerce
Checkout

Collect payments online with custom branded pages.

Checkout
Practice

Practice management software for accounting firms.

Practice
Solo

The all-in-one toolkit for solopreneurs.

Solo
NEW
Payments

Unified payment solution built for all businesses.

Payments
Suites
Finance Plus

All-in-one suite to manage your operations and finances.

Finance Plus

Email, Storage, and Collaboration

Mail

Secure email service for teams of all sizes.

Mail
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
WorkDrive

Online file management for teams.

WorkDrive
Bookings

Appointment scheduling app for consultations with customers.

Bookings
Cliq

Stay in touch with teams no matter where you are.

Cliq
Notebook

Beautiful home for all your notes.

Notebook
Meeting

Online meeting software for all your video conferencing & webinar needs.

Meeting
Connect

Employee experience platform to communicate, engage, and build positive employee relations.

Connect
Learn

Knowledge and learning management platform.

Learn
Office Integrator

Built in document editors for web apps.

Office Integrator
Writer

Word processor for focused writing and discussions.

Writer
TeamInbox

Shared inboxes for teams.

TeamInbox
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
Show

Create, edit, and share slides with a sleek presentation app.

Show
Tables

Work management tool to connect people, processes, and information.

Tables
Sheet

Spreadsheet software for collaborative teams.

Sheet
Office Suite

Powerful collaborative work platform for teams.

Office Suite
Calendar

Online business calendar to manage events and schedule appointments.

Calendar
ToDo

Collaborative task management for individuals and teams.

ToDo
FREE
PDF Editor

Collaborative online PDF editing tool.

PDF Editor
Suites
Workplace

Application suite built to improve team productivity and collaboration.

Workplace

Human Resources

Expense

Effortless expense reporting platform.

Expense
Recruit

Intuitive recruiting platform built to provide hiring solutions.

Recruit
People

Organize, automate, and simplify your HR processes.

People
Sign

Digital signature app for businesses.

Sign
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
Shifts

Employee scheduling and time tracking app.

Shifts
Workerly

Manage temporary staffing with an employee scheduling solution.

Workerly
Suites
People Plus

Comprehensive HR platform for seamless employee experiences.

People Plus

Security and IT Management

Creator

Build custom apps to simplify business processes.

Creator
Assist

Remote support and unattended remote access software.

Assist
Vault

Online password manager for teams.

Vault
Directory

Workforce identity and access management solution for cloud businesses.

Directory
Lens

Interactive remote assistance software with augmented reality.

Lens
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
NEW
eProtect

Comprehensive email security and archiving for every business.

eProtect
FREE
OneAuth

Secure multi-factor authenticator (MFA) for all your online accounts.

OneAuth
Toolkit

Complete resource for any admin-related lookup queries.

Toolkit

BI and Analytics

Analytics

Modern self-service BI and analytics platform.

Analytics
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
NEW
IoT

Harnessing IoT analytics for real-time operational intelligence.

IoT
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI

Project Management

Projects

Manage, track, and collaborate on projects with teams.

Projects
Sprints

Planning and tracking tool for scrum teams.

Sprints
BugTracker

Automatic bug tracking software for managing bugs.

BugTracker
Solo

The all-in-one toolkit for solopreneurs.

Solo
Suites
Projects Plus

Unified project management platform for intelligent, data-driven work.

Projects Plus

Developer Platforms

Creator

Build custom apps to simplify business processes.

Creator
Flow

Automate business workflows by creating smart integrations.

Flow
Office Integrator

Built in document editors for web apps.

Office Integrator
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
Tables

Work management tool to connect people, processes, and information.

Tables
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
NEW
IoT

Build, deploy, and scale IoT solutions for connected businesses.

IoT
Apptics

Application analytics for all apps.

Apptics
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI

IoT

NEW
IoT

Low-code IoT platform and solutions for connected businesses.

IoT

Search Result

CRM Plus

Unified platform to deliver top-notch customer experience.

Try now
CRM Plus
Service Plus

Unified platform for customer service and support teams.

Try now
Service Plus
Finance Plus

All-in-one suite to manage your operations and finances.

Try now
Finance Plus
People Plus

Comprehensive HR platform for seamless employee experiences.

Try now
People Plus
Workplace

Application suite built to improve team productivity and collaboration.

Try now
Workplace
Marketing Plus

Unified marketing platform for marketing teams.

Try now
Marketing Plus
Projects Plus

Unified project management platform for intelligent, data-driven work.

Try now
Projects Plus
All-in-one suite

Zoho One

The Operating System for Business

Run your entire business on Zoho with our unified cloud software, designed to help you break down silos between departments and increase organizational efficiency.

TRY ZOHO ONE
Zoho Marketplace

With over 2000 ready-to-use extensions across 40+ categories, connect your favorite business tools with the Zoho products you already use.

EXPLORE MARKETPLACE
Skip to main content

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.
  • The Full_Name field contains the concatenated values of the First_Name and Last_Name fields. This is a read-only field available only in the Leads and Contacts modules.

Request JSON

  • select_queryJSON key, mandatory

    Represents that the input is a select query.

Sample Request

Copied
Copied

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

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

Show full

Show less

  • 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

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

Show full

Show less

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

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

Show full

Show less

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

Response JSON Keys

  • OwnerJSON object

    Represents the unique ID of the record owner.

Sample Response

Copied
  • 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

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.

Sample Response

Copied
  • Boolean

    =

Sample Request

Copied

Response JSON Keys

  • Email_Opt_OutBoolean

    Represents the email preference of the contact.

Sample Response

Copied

Sample query with multiple conditions in where clause

To prevent ambiguity, the criteria listed in the WHERE clause must be properly enclosed in brackets. If WHERE has more than two criteria such as A, B, and C, use them as either of the following:

  • (A and (B and C))
  • ((A and B) and C)
  • A and (B and C)
  • (A and B) and C.

 

Sample Input

Copied
  • 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

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
  • 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

Sample Response

Copied

Show full

Show less

  • 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

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

Show full

Show less

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

    Only admin users have read permission for this module
    Resolution: Contact your admin.

  • 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.