Notes APIs

Notes are to provide some additional information about a contact, candidate, interview, or task. You can find the notes section in most of the modules. You can perform actions on single or multiple notes.

Get Notes

Purpose

To get the list of notes.

Request URL

https://recruit.zoho.com/recruit/v2/Notes

Possible module names
Candidates, Applications, Job Openings, Interviews, Clients, Contacts, Departments, Tasks, Events, Vendors, Campaigns, Referrals and all Custom Modules

Request Method

GET

Scope

scope=ZohoRecruit.modules.notes.{operation_type}

Possible operation types
ALL - Full access to notes READ - Get note data

Parameters

Parameter Name	Data Type	Description
page (optional)	Integer	To get the list of records from the respective pages. The default value is 1.
per_page (optional)	Integer	To get the list of records available per page. The default value is 200.

Note:

The page and per_page parameter is used to fetch records according to their position in Zoho Recruit. 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 using the page (1, 2, 3, and 4) and per_page (100) parameter, the user can fetch all 400 records using 4 API calls.

Sample Request

Copiedcurl "https://recruit.zoho.com/recruit/v2/Notes"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Sample Response

Copied{
    "data": [
        {
            "Modified_Time": "2020-08-24T06:56:50+05:30",
            "$attachments": null,
            "Created_Time": "2020-08-24T06:56:50+05:30",
            "Parent_Id": {
                "name": null,
                "id": "486812000001660091"
            },
            "$editable": true,
            "$se_module": "Candidates",
            "Note_Owner": {
                "name": "Thomas Shelby",
                "id": "486812000000216003"
            },
            "Modified_By": {
                "name": "Thomas Shelby",
                "id": "486812000000216003"
            },
            "$size": null,
            "$voice_note": false,
            "id": "486812000001659087",
            "Created_By": {
                "name": "Thomas Shelby",
                "id": "486812000000216003"
            },
            "Note_Title": "Notes",
            "Note_Content": "Excellent Performer."
        },
        {
            "Modified_Time": "2019-04-12T11:17:08+05:30",
            "$attachments": null,
            "Created_Time": "2019-04-12T11:17:08+05:30",
            "Parent_Id": {
                "name": null,
                "id": "486812000000645085"
            },
            "$editable": true,
            "$se_module": "zohosign.ZohoSign_Documents",
            "Note_Owner": {
                "name": "Thomas Shelby",
                "id": "486812000000216003"
            },
            "Modified_By": {
                "name": "Thomas Shelby",
                "id": "486812000000216003"
            },
            "$size": null,
            "$voice_note": false,
            "id": "486812000000648001",
            "Created_By": {
                "name": "Thomas Shelby",
                "id": "486812000000216003"
            },
            "Note_Title": "Sign Request",
            "Note_Content": "download.png has been sent to (yyyyyy@zohoxxxx.com) for signature."
        }
    ],
    "info": {
        "per_page": 200,
        "count": 2,
        "page": 1,
        "more_records": false
    }
}