notes_list
Retrieve a paginated list of notes filtered by deal, person, organization, or lead. Sort by date or content and control pagination with start and limit parameters.
Instructions
List notes with pagination and filtering options.
Returns a paginated list of notes. Use filters to narrow results by associated entity.
Workflow tips:
Filter by entity to get notes for specific deals, persons, organizations, or leads
Filter by user_id to get notes by specific user
Use pinned flags to filter pinned notes
Sort by add_time, update_time, or content
Use start/limit for pagination (default limit: 100, max: 500)
Common use cases:
List all notes for a deal: { "deal_id": 123 }
List all notes for a person: { "person_id": 456 }
List pinned notes: { "deal_id": 123, "pinned_to_deal_flag": true }
List notes by user: { "user_id": 789 }
Recent notes first: { "sort": "add_time", "sort_by": "desc" }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Field to sort by (e.g., add_time, update_time, content) | |
| limit | No | Number of items to return | |
| start | No | Pagination start | |
| org_id | No | Filter by organization ID | |
| deal_id | No | Filter by deal ID | |
| lead_id | No | Filter by lead ID | |
| sort_by | No | Sort direction | |
| user_id | No | Filter by user (creator) ID | |
| person_id | No | Filter by person ID | |
| pinned_to_deal_flag | No | Filter notes pinned to deals | |
| pinned_to_lead_flag | No | Filter notes pinned to leads | |
| pinned_to_person_flag | No | Filter notes pinned to persons | |
| pinned_to_organization_flag | No | Filter notes pinned to organizations |