MCP Tool: get_all_account_notes

Retrieves a paginated list of all notes for a specific account. This tool supports pagination for efficient data retrieval and provides comprehensive note information including content, type, visibility, and author details.

Example Prompt

Get all notes for account ACC001

Input Parameters

NameTypeRequiredDescription
accountIdstringYesThe identifier of the account to find notes for
pagenumberNoPage number for pagination (default: 1)
limitnumberNoNumber of notes per page (default: 10)

Response Fields

Below are the fields you may see in each account note object in the response:
FieldTypeDescription
idstringUnique identifier of the note
accountIdstringID of the account the note belongs to
accountstringName of the account
contentstringThe content of the note
typestringThe type of the note (e.g., “Internal”, “Customer”)
typeIdstringID of the note type attribute
typeConfigurationobjectConfiguration of the note type
visibilitystringThe visibility of the note (e.g., “private”, “public”)
attachmentsarrayArray of file attachments for the note
authorstringName of the note author
authorIdstringID of the note author
authorEmailstringEmail of the note author
metadataobjectAdditional metadata for the note
createdAtstring (ISO8601)Creation timestamp
updatedAtstring (ISO8601)Last update timestamp

Sample Response

{
  "data": [
    {
      "id": "NOTE001",
      "accountId": "ACC001",
      "account": "Acme Corporation",
      "content": "Customer has been experiencing intermittent issues over the past month. Consider upgrading their account to premium support tier for better monitoring.",
      "type": "Internal",
      "typeId": "TYPE001",
      "typeConfiguration": {
        "id": "TYPE001",
        "name": "Internal",
        "color": "#3B82F6"
      },
      "visibility": "private",
      "attachments": [
        {
          "id": "ATTACH001",
          "fileName": "performance_report.pdf",
          "fileSize": 1024000,
          "fileType": "application/pdf",
          "url": "https://example.com/files/performance_report.pdf"
        }
      ],
      "author": "John Doe",
      "authorId": "USER001",
      "authorEmail": "john.doe@company.com",
      "metadata": {
        "priority": "high",
        "tags": ["performance", "support"]
      },
      "createdAt": "2025-07-24T07:19:10.258Z",
      "updatedAt": "2025-07-24T07:19:10.258Z"
    },
    {
      "id": "NOTE002",
      "accountId": "ACC001",
      "account": "Acme Corporation",
      "content": "Follow-up call scheduled for next week to discuss the new feature requirements.",
      "type": "Customer",
      "typeId": "TYPE002",
      "typeConfiguration": {
        "id": "TYPE002",
        "name": "Customer",
        "color": "#10B981"
      },
      "visibility": "public",
      "attachments": [],
      "author": "Jane Smith",
      "authorId": "USER002",
      "authorEmail": "jane.smith@company.com",
      "metadata": {
        "priority": "medium",
        "tags": ["follow-up", "requirements"]
      },
      "createdAt": "2025-07-24T08:19:10.258Z",
      "updatedAt": "2025-07-24T08:19:10.258Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 2,
    "totalPages": 1
  },
  "status": true,
  "message": "Account notes retrieved successfully!",
  "timestamp": "2025-07-25T12:50:38.937Z"
}