v1
latestOpenAPI 3.0.12026-08-0621301.7 MBGet all notes
Returns all notes.
Query parameters
The ID of the user whose notes to fetch. If omitted, notes by all users will be returned.
The ID of the lead which notes to fetch. If omitted, notes about all leads will be returned.
The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned.
The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned.
The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned.
The ID of the project which notes to fetch. If omitted, notes about all projects will be returned.
The ID of the task which notes to fetch. If omitted, notes about all tasks will be returned.
Pagination start
Items shown per page
The field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys). Supported fields: id, user_id, deal_id, person_id, org_id, content, add_time, update_time.
The date in format of YYYY-MM-DD from which notes to fetch
The date in format of YYYY-MM-DD until which notes to fetch to
If set, only notes with an update_time later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
If set, the results are filtered by note to lead pinning state
If set, the results are filtered by note to deal pinning state
If set, the results are filtered by note to organization pinning state
If set, the results are filtered by note to person pinning state
If set, the results are filtered by note to project pinning state
If set, the results are filtered by note to task pinning state
Response
Get all notes