Skip to product menu
Skip to main content

Notes APIs

Use Notes to add any additional information you might want to include in your record.

List Notes

Purpose

To fetch the list of all available Notes in a record.

Request URL

https://fsm.zoho.com/fsm/v1/<module_api_name>/<record_id>/Notes

module_api_name - The API name of the module from whose record you want to fetch the notes

record_id - The unique ID of the record.

Request Method

GET

Scope

scope=ZohoFSM.modules.<module_name>.READ

Supported Modules

Module NameAPI Name
RequestsRequests
EstimatesEstimates
WorkOrdersWork_Orders
ServiceAppointmentsService_Appointments
ContactsContacts
AssetsAssets

Sample Request

Copiedcurl --request GET 'https://fsm.zoho.com/fsm/v1/Work_Orders/1011000000215001/Notes' \
--header 'Authorization: Zoho-oauthtoken 1000.xxxxxx.xxxxxxe'

Sample Response

Copied{
    "data": [
        {
            "Owner": {
                "name": "Daniel Warne",
                "id": "1011000000139001",
                "email": "lucy.robins@zylker.com"
            },
            "Modified_Time": "2022-03-23T22:47:50-07:00",
            "$attachments": null,
            "Created_Time": "2022-03-23T22:47:50-07:00",
            "Parent_Id": {
                "name": "WO28",
                "id": "1011000000215001"
            },
            "$editable": true,
            "$se_module": "Work_Orders",
            "$is_shared_to_client": "false",
            "Modified_By": {
                "name": "Daniel Warne",
                "id": "1011000000139001",
                "email": "lucy.robins@zylker.com"
            },
            "$size": null,
            "$voice_note": null,
            "id": "1011000000237019",
            "Created_By": {
                "name": "Daniel Warne",
                "id": "1011000000139001",
                "email": "lucy.robins@zylker.com"
            },
            "Note_Title": null,
            "Note_Content": "This is sample note two."
        },
        {
            "Owner": {
                "name": "Daniel Warne",
                "id": "1011000000139001",
                "email": "lucy.robins@zylker.com"
            },
            "Modified_Time": "2022-03-23T22:47:42-07:00",
            "$attachments": null,
            "Created_Time": "2022-03-23T22:47:42-07:00",
            "Parent_Id": {
                "name": "WO28",
                "id": "1011000000215001"
            },
            "$editable": true,
            "$se_module": "Work_Orders",
            "$is_shared_to_client": "false",
            "Modified_By": {
                "name": "Daniel Warne",
                "id": "1011000000139001",
                "email": "lucy.robins@zylker.com
            },
            "$size": null,
            "$voice_note": null,
            "id": "1011000000237015",
            "Created_By": {
                "name": "Daniel Warne",
                "id": "1011000000139001",
                "email": "lucy.robins@zylker.com"
            },
            "Note_Title": null,
            "Note_Content": "This is sample note one."
        }
    ],
    "info": {
        "per_page": 200,
        "count": 2,
        "page": 1,
        "more_records": false
    }
}

Show full

Show less