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

    Search Records

    Purpose

    To retrieve the records that match your search criteria.

    Request Details

    Request URL

    https://www.zohoapis.com/crm/v2/{module_api_name}/search

    Supported module names

    Leads, Accounts, Contacts, Users, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Custom, Notes, and Activities.

    Header

    Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

    Scope

    scope=ZohoCRM.modules.ALL
    (or)
    scope=ZohoCRM.modules.{module_name}.{operation_type}
    (and)
    scope=ZohoSearch.securesearch.READ

    Possible module names

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

    Possible operation types

    ALL - Full access to the record
    READ - Get records from the module

    Request Details: criteria

    Request URL:https://www.zohoapis.com/crm/v2/{module_api_name}/search?criteria={{criteria_here}}
    Parameters
    • criteriastring
      • Performs search by following the shown criteria. (({api_name}:{starts_with|equals}:{value})and/or({api_name}:{starts_with|equals}:{value}))
      • You can search for a maximum of 10 criteria (with same or different columns) with equals and starts_with conditions.
      • The only operator supported for encrypted fields is equals.
      • The "in" operator checks if a value is in a list. If you provide multiple values, the response includes records that match any of them.
        For example, (Full_Name:in:Patricia,Boyle,Kate).
      • When you use "equals" for multiple conditions, and if one of your conditions is (Company:equals:ABC), the response will contain records with ABC as well as ABC Inc in their Company fields.
        When you use "equals" with a single condition and search for a field (mentioned in point #3 of the Note on this page), like Campaign_Name:equals:CRM, the response will contain only those records whose Campaign_Name is "CRM" and not records with "Best CRM" or "Latest CRM" in their Campaign_Name fields.
      • When a single-line field value contains characters such as "{", "}", "[", "]", "^", ":", "-", "/", "!", "?", "*", "_", "@", space, the Search API returns records with similar-looking values, even if the characters are not an exact match.
        • For example, if Record A has the field value sales-team@zoho.com and Record B has sales_team@zoho.com, a search using equals:sales-team@zoho.com may return both records.
      • When you use parentheses or comma in the value for a criteria, you must escape them using a backslash. Further, you must encode the value.
        • Example:
          Consider the search term: ((Last_Name:equals:Burns,B)and(First_Name:starts_with:M))
          After escaping comma and parenthesis in the value: ((Last_Name:equals:Burns\,B)and(First_Name:starts_with:M))
          After encoding the value: ((Last_Name:equals:Burns%5C%2CB)and(First_Name:starts_with:M))
      • When you use backslash as the last character in the value for a criteria, you must escape it using another backslash. Further, you must encode the value.
        • Example:
          Consider the search term: (Last_Name:equals:K\)
          After escaping backslash in the value: (Last_Name:equals:K\\)
          After encoding the value: (Last_Name:equals:K%5C%5C)
      • To search for Date, DateTime, Lookup, Number, Currency, Boolean fields, you need comparators other than starts_with and equals. Refer to the Query API to search for fields of these data types.
      • The supported data types are
        • picklist
        • owner_lookup
        • user_lookup
        • lookup
        • phone
        • email
        • date
        • datetime
        • text
        • textarea
        • integer
        • currency
        • decimal
        • multiselectpicklist
        • bigint
        • percent
        • formula
        • website
        • boolean
        • double
      • The supported operators are

        • equals
        • starts_with
        • in

        Refer to the following "Note" section to learn about the supported operator for each field type.

      Note

      The following section gives you the field types and the operators you can use in the criteria parameter

      • Date, DateTime : equals, in.
      • Integer, Currency, Decimal : equals, in.
      • Boolean : equals
      • textarea : equals, starts_with.
      • Lookup(user/owner) : equals, starts_with, in.
      • Picklist, Autonumber : equals, starts_with, in.
      • Text, Email, Phone, Website : equals, starts_with, in.
      • multiselectpicklist : equals, in, starts_with.
      • bigint: equals, in.
      • percent : equals, in.
      • formula: Operators depend on the formula's return type. Check the corresponding datatype's supported operators.

    Sample Request to Search Records

    Copied
    3.0.08.0
    Copied
    Copied
    3.0.07.x
    Copied
    Copied
    3.0.08.x
    Copied
    Copied
    3.0.03.x.x
    Copied
    Copied
    1.0.010.x
    Copied
    Copied
    2.02.x.x
    Copied
    Copied
    1.0.0ES6
    Copied
    Copied
    Copied

    Show full

    Show less

    Sample Response

    Copied

    Show full

    Show less

    Request Details: email

    Request URL:https://www.zohoapis.com/crm/v2/{module_api_name}/search?email={{email_here}}
    Attributes
    • emailstring

      Performs module search by email. All the email fields of a particular module will be searched and listed.

    Sample Request to Search by email

    Copied
    Copied
    Copied
    Copied
    Copied

    Show full

    Show less

    Sample Response

    Copied

    Show full

    Show less

    Request Details: phone

    Request URL:https://www.zohoapis.com/crm/v2/{module_api_name}/search?phone={{phone_number_here}}
    Attributes
    • phonestring

      Performs module search by phone number. All the phone fields of a particular module will be searched and listed.

    Sample Request to Search by Phone

    Copied
    Copied
    Copied
    Copied
    Copied

    Show full

    Show less

    Sample Response

    Copied

    Show full

    Show less

    Request Details: word

    Request URL:https://www.zohoapis.com/crm/v2/{module_api_name}/search?word={{search_word_here}}
    Attributes
    • wordstring

      Performs global search by word.

    Sample Request to Search by word

    Copied
    Copied
    Copied
    Copied
    Copied

    Show full

    Show less

    Sample Response

    Copied

    Show full

    Show less

    Other optional parameters

    • convertedstring

      To get the list of converted records. Default value is false.

      • true - get only converted records
      • false - get only non-converted records
      • both - get all records
    • approvedstring

      To get the list of approved records. Default value is true.

      • true - get only approved records
      • false - get only records which are not approved
      • both - get all records
    • pageinteger

      To get the list of records from the respective pages. Default value for page is 1.

    • per_pageinteger

      To get the list of records available per page. The default and the maximum possible value is 200.

    • typestring

      To get a specific user type from the Users module. Please note that this parameter is supported only for Users module.

      The possible values are:

      • AllUsers
      • ActiveUsers
      • DeactiveUsers
      • ConfirmedUsers
      • ConfirmedReportingUsers
      • NotConfirmedUsers
      • DeletedUsers
      • ActiveConfirmedUsers
      • AdminUsers
      • ActiveConfirmedAdmins
      • CurrentUser

    Sample Request: To Search with a Single Criterion

    Copied

    Note

    • Only one of the mandatory parameters (criteria, email, phone, word) would work at one point of time. Furthermore, if two parameters are given simultaneously, preference will be given in the order criteria, email, phone, and word, and only one of them would work.
    • The page and per_page parameter is used to fetch records according to their position in the CRM. Let's assume that the user has to fetch 400 records. The maximum number of records that one can get for an API call is 200. So, for records above the 200th position, they cannot be fetched. By changing the values of the page (1, 2) and per_page (200) parameters, the user can fetch all 400 records using 2 API calls.
    • Usually, there is a delay in fetching the result of a search action. However, in a module-specific search, if you use one of the below mentioned fields (of the data type "string") in the criteria, you will get the response without any delay.
      Leads/Contacts - "Email" field
      Accounts - "Account_Name" field
      Potentials/Deals - "Deal_Name" field
      Campaigns - "Campaign_Name" field
      Cases - "Subject" field
      Solutions - "Solution_Title" field
      Products - "Product_Name" field
      Vendors - "Vendor_Name" field
      PriceBooks - "Price_Book_Name" field
      Quotes - "Subject" field
      SalesOrders - "Subject" field
      PurchaseOrders - "Subject" field
      Invoices - "Subject" field
      CustomModule - "Name" field
    • The value of the fields with sensitive health data will be retrieved only when Restrict Data access through API option in the compliance settings is disabled. If the option is enabled, the value will be null. Refer to HIPAA compliance for more details.
    • The "in" operator supports upto 100 values.
    • 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, Contacts, and Users modules.

    Possible Errors

    • MANDATORY_NOT_FOUNDHTTP 400

      mandatory param missing
      Resolution: Specify any of the mandatory parameters (criteria/email/phone/word) in your request.

    • INVALID_QUERYHTTP 400

      invalid query formed
      Resolution: The operators/field API names in your search query is invalid (or) The field specified is not available in the search module. Specify a valid search query.

    • INVALID_DATAHTTP 400

      provide atleast 2 letters for search
      Resolution: You have specified special characters in your search query. Specify a valid search query.

    • NOT_SUPPORTEDHTTP 400

      module not supported for search
      Resolution: The module you have specified is not supported for search operation. Refer to possible modules section above and specify a valid module API name.

    • INVALID_URL_PATTERNHTTP 404

      Please check if the URL trying to access is a correct one
      Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.

    • OAUTH_SCOPE_MISMATCHHTTP 401

      Unauthorized
      Resolution: Client does not have ZohoSearch.securesearch.READ scope. Create a new client with valid scope. Refer to scope section above.

    • NO_PERMISSIONHTTP 403

      Permission denied to read
      Resolution: The user does not have permission to read records. Contact your system administrator.

    • INTERNAL_ERRORHTTP 500

      Internal Server Error
      Resolution: Unexpected and unhandled exception in the 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.

    • AUTHORIZATION_FAILEDHTTP 400

      User does not have sufficient privilege to read module details.
      Resolution: The user does not have the permission to retrieve module details. Contact your system administrator.

    • INVALID_QUERYHTTP 400

      Cannot use the restricted field
      Resolution: You cannot add a restricted field in the search criteria. Refer to HIPAA compliance for more details.

    Sample Response

    Copied