younifyd
Menu

List notes

List notes

GET/Notes

Use it in a workflow

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

Request

Query parameters

fieldsstring

Comma-separated list of field API names to include in the response

idsstring

Comma-separated list of note IDs to retrieve specific notes. Use the [Get Notes API](notes.yaml#$.paths./Notes.get) to retrieve the note IDs.

per_pageinteger (int32)

Number of records per page

pageinteger (int32)

Page number for pagination

page_tokenstring

Page token for retrieving records beyond the 2000-record limit.

sort_orderstring

Sort order (ascending or descending)

One ofascdesc

sort_bystring

Field name to sort results by

One ofModified_TimeCreated_Timeid

Response

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

dataarray<object>

Array of note records

idstring (int64)required

Unique identifier of the note

Note_Titlestring | null

The title of the note

Note_Contentstring | null

The content/body of the note

$attachmentsarray | null

Attachments associated with the note

Parent_Idobject3 fields

Parent record information

infoobject

Pagination metadata

pageinteger (int32)required

Current page number

per_pageinteger (int32)required

Number of records per page

countinteger (int32)required

Number of records in current page

more_recordsbooleanrequired

Indicates if more records are available

next_page_tokenstring | null

Token for retrieving the next page of note records.

previous_page_tokenstring | null

Token for retrieving the previous page of note records.

page_token_expirystring | null

Expiry time of page tokens

sort_bystring

Field by which the results are sorted

sort_orderstring

Sort order of the results

One ofascdesc

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",
    "sort_by": "string",
    "sort_order": "asc"
  }
}

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