Get Notes from a Specific Record

Purpose

To get the list of notes from a particular record of the module.

Request URL

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

module_api_name - The API name of the module

record_id - Unique ID of the record

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

Request Method

GET

Scope

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

 
Possible module namesPossible operation types
leads, accounts, contacts, deals, campaigns, tasks, events, calls, cases, events, calls, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, and customALL - Full access to notes
READ - Get note data

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v2/Leads/410888000000698006/Notes"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
CopiedZCRMRecord record = ZCRMRecord.getInstance("Leads",123456l);//module api name with record id
BulkAPIResponse response = record.getRelatedListRecords("Notes");
List<ZCRMNote> notes = (List<ZCRMNote>) response.getData();//relatedList name
Copiedtry{
$record=ZCRMRecord::getInstance("Leads",410405000001111007);
$responseIns=$record->getNotes(null,null,1,50);
$records=$responseIns->getData();
foreach ($records as $note)
{
echo "\n";
echo $note->getId();
echo $note->getTitle();
echo $note->getContent();
$parentRecord=$note->getParentRecord();
echo $parentRecord->getEntityId();
echo $note->getParentName();
echo $note->getParentId();
$createdBy=$note->getCreatedBy();
echo $createdBy->getId();
echo $createdBy->getName();
$modifiedBy=$note->getModifiedBy();
echo $modifiedBy->getId();
echo $modifiedBy->getName();
$owner=$note->getOwner();
echo $owner->getId();
echo $owner->getName();
echo $note->getCreatedTime();
echo $note->getModifiedTime();
echo $note->isVoiceNote();
echo $note->getSize();
$attchments=$note->getAttachments();
if($attchments!=null)
{
foreach ($attchments as $attchmentIns)
{
echo "\nATTACHMENTS::\n";
echo $attchmentIns->getId();
echo $attchmentIns->getFileName();
echo $attchmentIns->getFileType();
echo $attchmentIns->getSize();
echo $attchmentIns->getParentModule();
$parentRecord=$attchmentIns->getParentRecord();
echo $parentRecord->getEntityId();
echo $attchmentIns->getParentName();
echo $attchmentIns->getParentId();
$createdBy=$attchmentIns->getCreatedBy();
echo $createdBy->getId();
echo $createdBy->getName();
$modifiedBy=$attchmentIns->getModifiedBy();
echo $modifiedBy->getId();
echo $modifiedBy->getName();
$owner=$attchmentIns->getOwner();
echo $owner->getId();
echo $owner->getName();
echo $attchmentIns->getCreatedTime();
echo $attchmentIns->getModifiedTime();
}
}
}
}catch (ZCRMException $e)
{
echo $e->getCode();
echo $e->getMessage();
echo $e->getExceptionCode();
}
Copied    def get_notes(self):
        try:
            record=ZCRMRecord.get_instance('Leads',3719520000000326007) #module API Name, entityId
            resp=record.get_notes()
            print(resp.status_code)
            note_ins_arr=resp.data
            for note_ins in note_ins_arr:
                print(note_ins.id)
                print(note_ins.title)
                print(note_ins.content)
                print(note_ins.owner.id)
                print(note_ins.created_by.id)
                print(note_ins.modified_by.id)
                print(note_ins.created_time)
                print(note_ins.modified_time)
                print("\n\n")
        except ZCRMException as ex:
            print(ex.status_code)
            print(ex.error_message)
            print(ex.error_code)
            print(ex.error_details)
            print(ex.error_content)
CopiedZCRMRecord recordIns = ZCRMRecord.GetInstance("Leads", 3372164000000614001); //module api name with record id
BulkAPIResponse<ZCRMNote> response = recordIns.GetNotes();
List<ZCRMNote> notes = response.BulkData; //notes - list of ZCRMNote instance

Sample Response

Copied{
    "data": [
       {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "$se_module": "Leads",
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false
            },
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Modified_Time": "2016-09-15T18:03:09+05:30",
            "Created_Time": "2016-09-15T18:03:09+05:30",
            "$followed": false,
            "Parent_Id": {
                "name": null,
                "id": "410888000000698006"
            },
            "id": "410888000000734003",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Note_Title": "",
            "Note_Content": "Demo scheduled for this Lead"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}
Copied{
    "data": [
       {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "$se_module": "Leads",
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false
            },
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Modified_Time": "2016-09-15T18:03:09+05:30",
            "Created_Time": "2016-09-15T18:03:09+05:30",
            "$followed": false,
            "Parent_Id": {
                "name": null,
                "id": "410888000000698006"
            },
            "id": "410888000000734003",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Note_Title": "",
            "Note_Content": "Demo scheduled for this Lead"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}
Copied{
    "data": [
       {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "$se_module": "Leads",
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false
            },
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Modified_Time": "2016-09-15T18:03:09+05:30",
            "Created_Time": "2016-09-15T18:03:09+05:30",
            "$followed": false,
            "Parent_Id": {
                "name": null,
                "id": "410888000000698006"
            },
            "id": "410888000000734003",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Note_Title": "",
            "Note_Content": "Demo scheduled for this Lead"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}
Copied{
    "data": [
       {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "$se_module": "Leads",
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false
            },
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Modified_Time": "2016-09-15T18:03:09+05:30",
            "Created_Time": "2016-09-15T18:03:09+05:30",
            "$followed": false,
            "Parent_Id": {
                "name": null,
                "id": "410888000000698006"
            },
            "id": "410888000000734003",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Note_Title": "",
            "Note_Content": "Demo scheduled for this Lead"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}
Copied{
    "data": [
       {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "$se_module": "Leads",
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false
            },
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Modified_Time": "2016-09-15T18:03:09+05:30",
            "Created_Time": "2016-09-15T18:03:09+05:30",
            "$followed": false,
            "Parent_Id": {
                "name": null,
                "id": "410888000000698006"
            },
            "id": "410888000000734003",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Note_Title": "",
            "Note_Content": "Demo scheduled for this Lead"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}

Sample Response

Copied{
    "data": [
       {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "$se_module": "Leads",
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false
            },
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Modified_Time": "2016-09-15T18:03:09+05:30",
            "Created_Time": "2016-09-15T18:03:09+05:30",
            "$followed": false,
            "Parent_Id": {
                "name": null,
                "id": "410888000000698006"
            },
            "id": "410888000000734003",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Note_Title": "",
            "Note_Content": "Demo scheduled for this Lead"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}
Copied{
    "data": [
       {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "$se_module": "Leads",
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false
            },
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Modified_Time": "2016-09-15T18:03:09+05:30",
            "Created_Time": "2016-09-15T18:03:09+05:30",
            "$followed": false,
            "Parent_Id": {
                "name": null,
                "id": "410888000000698006"
            },
            "id": "410888000000734003",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Note_Title": "",
            "Note_Content": "Demo scheduled for this Lead"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}
Copied{
    "data": [
       {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "$se_module": "Leads",
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false
            },
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Modified_Time": "2016-09-15T18:03:09+05:30",
            "Created_Time": "2016-09-15T18:03:09+05:30",
            "$followed": false,
            "Parent_Id": {
                "name": null,
                "id": "410888000000698006"
            },
            "id": "410888000000734003",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Note_Title": "",
            "Note_Content": "Demo scheduled for this Lead"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}
Copied{
    "data": [
       {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "$se_module": "Leads",
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false
            },
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Modified_Time": "2016-09-15T18:03:09+05:30",
            "Created_Time": "2016-09-15T18:03:09+05:30",
            "$followed": false,
            "Parent_Id": {
                "name": null,
                "id": "410888000000698006"
            },
            "id": "410888000000734003",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Note_Title": "",
            "Note_Content": "Demo scheduled for this Lead"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}
Copied{
    "data": [
       {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "$se_module": "Leads",
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false
            },
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Modified_Time": "2016-09-15T18:03:09+05:30",
            "Created_Time": "2016-09-15T18:03:09+05:30",
            "$followed": false,
            "Parent_Id": {
                "name": null,
                "id": "410888000000698006"
            },
            "id": "410888000000734003",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Note_Title": "",
            "Note_Content": "Demo scheduled for this Lead"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}

Sample Response

Copied{
    "data": [
       {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "$se_module": "Leads",
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false
            },
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Modified_Time": "2016-09-15T18:03:09+05:30",
            "Created_Time": "2016-09-15T18:03:09+05:30",
            "$followed": false,
            "Parent_Id": {
                "name": null,
                "id": "410888000000698006"
            },
            "id": "410888000000734003",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Note_Title": "",
            "Note_Content": "Demo scheduled for this Lead"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}
Copied{
    "data": [
       {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "$se_module": "Leads",
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false
            },
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Modified_Time": "2016-09-15T18:03:09+05:30",
            "Created_Time": "2016-09-15T18:03:09+05:30",
            "$followed": false,
            "Parent_Id": {
                "name": null,
                "id": "410888000000698006"
            },
            "id": "410888000000734003",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Note_Title": "",
            "Note_Content": "Demo scheduled for this Lead"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}
Copied{
    "data": [
       {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "$se_module": "Leads",
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false
            },
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Modified_Time": "2016-09-15T18:03:09+05:30",
            "Created_Time": "2016-09-15T18:03:09+05:30",
            "$followed": false,
            "Parent_Id": {
                "name": null,
                "id": "410888000000698006"
            },
            "id": "410888000000734003",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Note_Title": "",
            "Note_Content": "Demo scheduled for this Lead"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}
Copied{
    "data": [
       {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "$se_module": "Leads",
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false
            },
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Modified_Time": "2016-09-15T18:03:09+05:30",
            "Created_Time": "2016-09-15T18:03:09+05:30",
            "$followed": false,
            "Parent_Id": {
                "name": null,
                "id": "410888000000698006"
            },
            "id": "410888000000734003",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Note_Title": "",
            "Note_Content": "Demo scheduled for this Lead"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}
Copied{
    "data": [
       {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "$se_module": "Leads",
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false
            },
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Modified_Time": "2016-09-15T18:03:09+05:30",
            "Created_Time": "2016-09-15T18:03:09+05:30",
            "$followed": false,
            "Parent_Id": {
                "name": null,
                "id": "410888000000698006"
            },
            "id": "410888000000734003",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Note_Title": "",
            "Note_Content": "Demo scheduled for this Lead"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}

Sample Response

Copied{
    "data": [
       {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "$se_module": "Leads",
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false
            },
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Modified_Time": "2016-09-15T18:03:09+05:30",
            "Created_Time": "2016-09-15T18:03:09+05:30",
            "$followed": false,
            "Parent_Id": {
                "name": null,
                "id": "410888000000698006"
            },
            "id": "410888000000734003",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Note_Title": "",
            "Note_Content": "Demo scheduled for this Lead"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}
Copied{
    "data": [
       {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "$se_module": "Leads",
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false
            },
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Modified_Time": "2016-09-15T18:03:09+05:30",
            "Created_Time": "2016-09-15T18:03:09+05:30",
            "$followed": false,
            "Parent_Id": {
                "name": null,
                "id": "410888000000698006"
            },
            "id": "410888000000734003",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Note_Title": "",
            "Note_Content": "Demo scheduled for this Lead"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}
Copied{
    "data": [
       {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "$se_module": "Leads",
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false
            },
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Modified_Time": "2016-09-15T18:03:09+05:30",
            "Created_Time": "2016-09-15T18:03:09+05:30",
            "$followed": false,
            "Parent_Id": {
                "name": null,
                "id": "410888000000698006"
            },
            "id": "410888000000734003",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Note_Title": "",
            "Note_Content": "Demo scheduled for this Lead"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}
Copied{
    "data": [
       {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "$se_module": "Leads",
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false
            },
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Modified_Time": "2016-09-15T18:03:09+05:30",
            "Created_Time": "2016-09-15T18:03:09+05:30",
            "$followed": false,
            "Parent_Id": {
                "name": null,
                "id": "410888000000698006"
            },
            "id": "410888000000734003",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Note_Title": "",
            "Note_Content": "Demo scheduled for this Lead"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}
Copied{
    "data": [
       {
            "Owner": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "$se_module": "Leads",
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false
            },
            "Modified_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Modified_Time": "2016-09-15T18:03:09+05:30",
            "Created_Time": "2016-09-15T18:03:09+05:30",
            "$followed": false,
            "Parent_Id": {
                "name": null,
                "id": "410888000000698006"
            },
            "id": "410888000000734003",
            "Created_By": {
                "name": "Patricia Boyle",
                "id": "410888000000086001"
            },
            "Note_Title": "",
            "Note_Content": "Demo scheduled for this Lead"
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    }
}