List a record's notes

GET/{parentRecordModule}/{parentRecordId}/Notes

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the List a record's notes action (under Notes).
Fill in the fields below, then reference the result from later steps as {{listARecordSNotes.response.data}}.

Request

Path parameters

parentRecordModulestringrequired

Specify the API name of the parent record module. Refer to [Get Modules](modules.yaml#$.paths./settings/modules.get) for the list of supported modules.

parentRecordIdstring (int64)required

Specify the unique numeric ID of the parent record.

Query parameters

fieldsstring

A comma-separated list of field API names to return in the response. If not specified, all available fields are included in the response.

pageinteger (int32)

Specify the page number for pagination. The value must be **1 or greater**.

Default 1

perPageinteger (int32)

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

Default 200

sort_bystring

Specify the field name to sort the note records by. Possible values: id - Sort by the note ID. Created_Time - Sort by the creation date and time. Modified_Time - Sort by the last modification date and time.

One ofidCreated_TimeModified_Time

sort_orderstring

The order in which results are returned. Possible values: **asc** - Returns results in ascending order. **desc** - Returns results in descending order.

One ofascdesc

Response

Returns 200 with an object. Read it in later steps with {{listARecordSNotes.response.data.<field>}}.

dataarray<object>

Represents the list of note records returned for the specified parent record.

idstring (int64)required

Represents the unique identifier of the note.

Note_Titlestring | null

Represents the title of the note.

Note_Contentstring | null

The content of the note.

$attachmentsarray | null

Represents the list of file attachments associated with the note.

Parent_Idobject3 fields

Represents the parent record associated with the note.

infoobject

Represents the pagination metadata for this response.

pageinteger (int32)required

Specifies the current page number.

per_pageinteger (int32)required

Represents the number of records returned per page.

countinteger (int32)required

The number of note records returned in the current page.

more_recordsbooleanrequired

Represents whether more note records are available beyond the current page.

next_page_tokenstring | null

Indicates the token used to retrieve the next page of results.

previous_page_tokenstring | null

Represents the token used to retrieve the previous page of results.

page_token_expirystring | null

Represents the expiry date and time of the page tokens.

json

{
  "data": [
    {
      "id": "string",
      "Note_Title": "string",
      "Note_Content": "string",
      "$attachments": null,
      "Parent_Id": {
        "module": {
          "api_name": "string",
          "id": "string"
        },
        "name": "string",
        "id": "string"
      }
    }
  ],
  "info": {
    "page": 0,
    "per_page": 0,
    "count": 0,
    "more_records": false,
    "next_page_token": "string",
    "previous_page_token": "string",
    "page_token_expiry": "2025-01-01T00:00:00Z"
  }
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?