Skip to main content
close
  • Sales
    Press Space or Enter to display list of options
EXPLORE ALL PRODUCTS

Sales

 
CRM

Comprehensive CRM platform for customer-facing teams.

CRM
 
Bigin

Simple CRM for small businesses moving from spreadsheets.

Bigin
 
Forms

Build online forms for every business need.

Forms
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Sign

Digital signature app for businesses.

Sign
 
RouteIQ

Comprehensive sales map visualization and optimal route planning solution.

RouteIQ
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
Suites
CRM Plus

Unified platform to deliver top-notch customer experience.

CRM Plus

Marketing

 
Social

All-in-one social media management software.

Social
 
Campaigns

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

Campaigns
 
Forms

Build online forms for every business need.

Forms
 
Survey

Design surveys to reach and interact with your audience.

Survey
 
Sites

Online website builder with extensive customisation options.

Sites
 
PageSense

Website conversion optimization and personalisation platform.

PageSense
 
Backstage

End-to-end event management software.

Backstage
 
Webinar

Webinar platform for webcasting online webinars.

Webinar
 
Marketing Automation

All-in-one marketing automation software.

Marketing Automation
 
LandingPage

Smart landing page builder to increase conversion rates

LandingPage
 
Publish

Manage all your local business listings on a single platform.

Publish
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Sign

Digital signature app for businesses.

Sign
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
LeadChain

Sync, manage, and convert leads across channels seamlessly.

LeadChain
 
NEW
CommunitySpaces

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

CommunitySpaces
 
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
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
FSM

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

FSM
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Suites
Service Plus

Unified platform for customer service and support teams.

Service Plus

Finance

 
Books

Powerful accounting platform for growing businesses.

Books
 
FREE
Invoice

100% Free invoicing solution.

Invoice
 
Expense

Effortless expense reporting platform.

Expense
 
Inventory

Powerful stock management and inventory control software.

Inventory
 
Billing

End-to-end billing solution for your business.

Billing
 
Checkout

Collect payments online with custom branded pages.

Checkout
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Practice

Practice management software for accounting firms.

Practice
 
Sign

Digital signature app for businesses.

Sign
 
Commerce

eCommerce platform to manage and market your online store.

Commerce
 
Suites
Finance Plus

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

Finance Plus

Email and Collaboration

 
Mail

Secure email service for teams of all sizes.

Mail
 
Meeting

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

Meeting
 
Writer

Word processor for focused writing and discussions.

Writer
 
Sheet

Spreadsheet software for collaborative teams.

Sheet
 
Show

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

Show
 
Notebook

Beautiful home for all your notes.

Notebook
 
Cliq

Stay in touch with teams no matter where you are.

Cliq
 
Connect

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

Connect
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
TeamInbox

Shared inboxes for teams.

TeamInbox
 
WorkDrive

Online file management for teams.

WorkDrive
 
Sign

Digital signature app for businesses.

Sign
 
Office Suite

Powerful collaborative work platform for teams.

Office Suite
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
Calendar

Online business calendar to manage events and schedule appointments.

Calendar
 
Learn

Knowledge and learning management platform.

Learn
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
ToDo

Collaborative task management for individuals and teams.

ToDo
 
Tables

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

Tables
 
FREE
PDF Editor

Collaborative online PDF editing tool.

PDF Editor
 
Suites
Workplace

Application suite built to improve team productivity and collaboration.

Workplace

Human Resources

 
People

Organize, automate, and simplify your HR processes.

People
 
Recruit

Intuitive recruiting platform built to provide hiring solutions.

Recruit
 
Expense

Effortless expense reporting platform.

Expense
 
Workerly

Manage temporary staffing with an employee scheduling solution.

Workerly
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
Shifts

Employee scheduling and time tracking app.

Shifts
 
Sign

Digital signature app for businesses.

Sign
 
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
 
Directory

Workforce identity and access management solution for cloud businesses.

Directory
 
FREE
OneAuth

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

OneAuth
 
Vault

Online password manager for teams.

Vault
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Toolkit

Complete resource for any admin-related lookup queries.

Toolkit
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
Assist

Remote support and unattended remote access software.

Assist
 
QEngine

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

QEngine
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA

BI and Analytics

 
Analytics

Modern self-service BI and analytics platform.

Analytics
 
Embedded BI

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

Embedded BI
 
DataPrep

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

DataPrep
 
NEW
IoT

Harnessing IoT analytics for real-time operational intelligence.

IoT

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

Developer Platforms

 
Creator

Build custom apps to simplify business processes.

Creator
 
Flow

Automate business workflows by creating smart integrations.

Flow
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
QEngine

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

QEngine
 
Tables

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

Tables
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
 
NEW
Apptics

Application analytics for all apps.

Apptics
 
Embedded BI

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

Embedded BI
 
NEW
IoT

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

IoT
 
DataPrep

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

DataPrep

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

Notes APIs

Notes are to provide some additional information about a contact, account, deal or task. You can find the notes section in most of the modules. Hence, with Notes API, you can create, delete, or update notes. You can perform actions on single or multiple notes.

Get Notes

Purpose

To get the list of notes.

Request Details

Request URL

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

To get a specific note:
{api-domain}/crm/{version}/Notes/{note_id}

To get notes from a specific record:
{api-domain}/crm/{version}/{module_api_name}/{record_id}/Notes

Supported modules

Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Appointments, Services and Custom

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.modules.ALL
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}
(and)
scope=ZohoCRM.modules.notes.{operation_type}

Possible module names

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

Possible operation types

ALL - Full access to notes
READ - Get note data

Parameters

  • pagenumber, optional

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

  • per_pagenumber, optional

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

  • fieldsstring, mandatory

    Specify the API names of the fields whose details you want to receive in the response.

Note

  • You can fetch a maximum of 200 records per API call. Use the page and per_page parameters to paginate and fetch the remaining records in subsequent calls.
  • By default, the notes are sorted and displayed chronologically in the API response, i.e, the oldest note is displayed first. However, if you choose "Recent First" in CRM's web UI, sorting happens based on the newest note first. Note that the option you choose in the web UI is user-specific, and applies to all the modules that have Notes as a related list.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v6/Notes?fields=Parent_Id,Owner,Created_Time,Note_Title"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/crm/v6/Notes?fields=Owner,Created_Time,Note_Title"
	type: GET
	connection:"crm_oauth_connection"
];
info response;

Response JSON Keys

  • OwnerJSON object

    Represents the name, ID, and email of the record owner.

  • Modified_Timestring

    Represents the date and time at which the current note was last modified.

  • $attachmentsJSON array

    Represents the details of the attachment, if the current note has any.

  • Created_Timestring

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

  • Parent_Idstring

    Represents the display name and unique ID of the parent record, as well as the API name and ID of the parent module

  • $editableboolean

    Represents if the user can edit the current note.
    true: The user can edit the current note.
    false: The user cannot edit the current note.

  • Modified_ByJSON object

    Represents the name, ID, and email of the user who last modified the note.

  • idstring

    Represents the unique ID of the current note.

  • Created_ByJSON object

    Represents the name, ID, and email of the user who created the current note.

  • Note_Titlestring

    Represents the title of the current note.

  • Note_Contentstring

    Represents the content of the current note.

  • $is_shared_to_clientboolean

    Represents if the note is shared with a client portal user.

  • sizeinteger

    Represents the size of the voice note in bytes, if any.

  • $voice_noteboolean

    Represents if the current note has a voice note attached.

Possible Errors

  • INVALID_MODULEHTTP 400

    The module name given seems to be invalid
    Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name.

  • INVALID_MODULEHTTP 400

    The given module is not supported in API
    Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). 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 ZohoCRM.modules.notes.READ scope. Create a new client with valid scope. Refer to scope section above.

  • NO_PERMISSIONHTTP 403

    Permission denied to read notes details
    Resolution: The user does not have permission to retrieve notes data. Contact your system administrator.

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

  • AUTHORIZATION_FAILEDHTTP 400

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

  • REQUIRED_PARAM_MISSINGHTTP 400

    One of the expected parameter is missing
    Resolution: Specify the mandatory parameters. Refer to the Parameters section above for more details.

Sample Response

Copied{
    "data": [
        {
            "Owner": {
                "name": "Patricia",
                "id": "2423488000000483001",
                "email": "aaa@zoho.com"
            },
            "Created_Time": "2023-10-24T15:32:55+05:30",
            "Parent_Id": {
                "module": {
                    "api_name": "Contacts",
                    "id": "2423488000000000129"
                },
                "name": "John Butt",
                "id": "2423488000000495515"
            },
            "id": "2423488000000496148",
            "Note_Title": "Follow up call"
        },
        {
            "Owner": {
                "name": "Patricia",
                "id": "2423488000000483001",
                "email": "aaa@zoho.com"
            },
            "Created_Time": "2023-10-24T15:32:55+05:30",
            "Parent_Id": {
                "module": {
                    "api_name": "Contacts",
                    "id": "2423488000000000129"
                },
                "name": "Josephine Darakjy",
                "id": "2423488000000495516"
            },
            "id": "2423488000000496149",
            "Note_Title": "Call scheduled"
        },
        {
            "Owner": {
                "name": "Patricia",
                "id": "2423488000000483001",
                "email": "aaa@zoho.com"
            },
            "Created_Time": "2023-10-24T15:32:55+05:30",
            "Parent_Id": {
                "module": {
                    "api_name": "Contacts",
                    "id": "2423488000000000129"
                },
                "name": "James Venere",
                "id": "2423488000000495517"
            },
            "id": "2423488000000496150",
            "Note_Title": "Call notes"
        },
        {
            "Owner": {
                "name": "Patricia",
                "id": "2423488000000483001",
                "email": "aaa@zoho.com"
            },
            "Created_Time": "2023-10-24T15:32:55+05:30",
            "Parent_Id": {
                "module": {
                    "api_name": "Contacts",
                    "id": "2423488000000000129"
                },
                "name": "Capla Paprocki",
                "id": "2423488000000495518"
            },
            "id": "2423488000000496151",
            "Note_Title": "Info"
        },
        {
            "Owner": {
                "name": "Patricia",
                "id": "2423488000000483001",
                "email": "aaa@zoho.com"
            },
            "Created_Time": "2023-10-24T15:32:55+05:30",
            "Parent_Id": {
                "module": {
                    "api_name": "Contacts",
                    "id": "2423488000000000129"
                },
                "name": "Donette Foller",
                "id": "2423488000000495519"
            },
            "id": "2423488000000496152",
            "Note_Title": "Deal details"
        },
        {
            "Owner": {
                "name": "Patricia",
                "id": "2423488000000483001",
                "email": "aaa@zoho.com"
            },
            "Created_Time": "2023-10-30T21:38:28+05:30",
            "Parent_Id": {
                "module": {
                    "api_name": "Leads",
                    "id": "2423488000000000125"
                },
                "name": "Chau Kitzman  ",
                "id": "2423488000000495872"
            },
            "id": "2423488000000551003",
            "Note_Title": null
        },
        {
            "Owner": {
                "name": "Patricia",
                "id": "2423488000000483001",
                "email": "aaa@zoho.com"
            },
            "Created_Time": "2023-10-30T21:38:39+05:30",
            "Parent_Id": {
                "module": {
                    "api_name": "Leads",
                    "id": "2423488000000000125"
                },
                "name": "Chau Kitzman  ",
                "id": "2423488000000495872"
            },
            "id": "2423488000000551008",
            "Note_Title": null
        },
        {
            "Owner": {
                "name": "Patricia",
                "id": "2423488000000483001",
                "email": "aaa@zoho.com"
            },
            "Created_Time": "2023-10-30T21:38:59+05:30",
            "Parent_Id": {
                "module": {
                    "api_name": "Leads",
                    "id": "2423488000000000125"
                },
                "name": "Chau Kitzman  ",
                "id": "2423488000000495872"
            },
            "id": "2423488000000551013",
            "Note_Title": null
        },
        {
            "Owner": {
                "name": "Patricia",
                "id": "2423488000000483001",
                "email": "aaa@zoho.com"
            },
            "Created_Time": "2023-10-31T11:37:38+05:30",
            "Parent_Id": {
                "module": {
                    "api_name": "Leads",
                    "id": "2423488000000000125"
                },
                "name": "Theola Frey  ",
                "id": "2423488000000495873"
            },
            "id": "2423488000000556003",
            "Note_Title": null
        },
        {
            "Owner": {
                "name": "Patricia",
                "id": "2423488000000483001",
                "email": "aaa@zoho.com"
            },
            "Created_Time": "2023-11-24T12:03:14+05:30",
            "Parent_Id": {
                "module": {
                    "api_name": "Leads",
                    "id": "2423488000000000125"
                },
                "name": "testbulk4",
                "id": "2423488000000569124"
            },
            "id": "2423488000000657003",
            "Note_Title": null
        },
        {
            "Owner": {
                "name": "Patricia",
                "id": "2423488000000483001",
                "email": "aaa@zoho.com"
            },
            "Created_Time": "2023-11-24T12:05:44+05:30",
            "Parent_Id": {
                "module": {
                    "api_name": "Leads",
                    "id": "2423488000000000125"
                },
                "name": "testbulk4",
                "id": "2423488000000569124"
            },
            "id": "2423488000000657008",
            "Note_Title": null
        },
        {
            "Owner": {
                "name": "Patricia",
                "id": "2423488000000483001",
                "email": "aaa@zoho.com"
            },
            "Created_Time": "2023-12-05T08:18:57+05:30",
            "Parent_Id": {
                "module": {
                    "api_name": "Leads",
                    "id": "2423488000000000125"
                },
                "name": "testing ",
                "id": "2423488000000696016"
            },
            "id": "2423488000000699007",
            "Note_Title": null
        },
        {
            "Owner": {
                "name": "Patricia",
                "id": "2423488000000483001",
                "email": "aaa@zoho.com"
            },
            "Created_Time": "2023-12-18T18:45:43+05:30",
            "Parent_Id": {
                "module": {
                    "api_name": "Leads",
                    "id": "2423488000000000125"
                },
                "name": "jame",
                "id": "2423488000000771297"
            },
            "id": "2423488000000776001",
            "Note_Title": null
        },
        {
            "Owner": {
                "name": "Patricia",
                "id": "2423488000000483001",
                "email": "aaa@zoho.com"
            },
            "Created_Time": "2023-12-18T18:48:25+05:30",
            "Parent_Id": {
                "module": {
                    "api_name": "Leads",
                    "id": "2423488000000000125"
                },
                "name": "jame",
                "id": "2423488000000771297"
            },
            "id": "2423488000000776006",
            "Note_Title": null
        },
        {
            "Owner": {
                "name": "Patricia",
                "id": "2423488000000483001",
                "email": "aaa@zoho.com"
            },
            "Created_Time": "2023-12-18T19:23:31+05:30",
            "Parent_Id": {
                "module": {
                    "api_name": "Leads",
                    "id": "2423488000000000125"
                },
                "name": "ghj",
                "id": "2423488000000771297"
            },
            "id": "2423488000000776011",
            "Note_Title": null
        },
        {
            "Owner": {
                "name": "Patricia",
                "id": "2423488000000483001",
                "email": "patricia@mail.com"
            },
            "Created_Time": "2023-12-18T19:23:38+05:30",
            "Parent_Id": {
                "module": {
                    "api_name": "Leads",
                    "id": "2423488000000000125"
                },
                "name": "ghj",
                "id": "2423488000000771297"
            },
            "id": "2423488000000776016",
            "Note_Title": null
        },
        {
            "Owner": {
                "name": "Patricia",
                "id": "2423488000000483001",
                "email": "patricia@mail.com"
            },
            "Created_Time": "2023-12-18T19:23:47+05:30",
            "Parent_Id": {
                "module": {
                    "api_name": "Leads",
                    "id": "2423488000000000125"
                },
                "name": "James",
                "id": "2423488000000771297"
            },
            "id": "2423488000000776021",
            "Note_Title": null
        }
    ],
    "info": {
        "per_page": 200,
        "next_page_token": null,
        "count": 17,
        "sort_by": "id",
        "page": 1,
        "previous_page_token": null,
        "page_token_expiry": null,
        "sort_order": "asc",
        "more_records": false
    }
}

Show full

Show less