provider Notes GET
/notes @utdk/pipedrive
/notes Get all notes
Returns all notes.
- user_id query
- The ID of the user whose notes to fetch. If omitted, notes by all users will be returned.
- integer
- lead_id query
- The ID of the lead which notes to fetch. If omitted, notes about all leads will be returned.
- string
- deal_id query
- The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned.
- integer
- person_id query
- The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned.
- integer
- org_id query
- The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned.
- integer
- project_id query
- The ID of the project which notes to fetch. If omitted, notes about all projects will be returned.
- integer
- task_id query
- The ID of the task which notes to fetch. If omitted, notes about all tasks will be returned.
- integer
- start query
- Pagination start
- integer
- limit query
- Items shown per page
- integer
- sort query
- 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`.
- string
- start_date query
- The date in format of YYYY-MM-DD from which notes to fetch
- string
- end_date query
- The date in format of YYYY-MM-DD until which notes to fetch to
- string
- updated_since query
- 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.
- string
- pinned_to_lead_flag query
- If set, the results are filtered by note to lead pinning state
- enum: 0, 1
- pinned_to_deal_flag query
- If set, the results are filtered by note to deal pinning state
- enum: 0, 1
- pinned_to_organization_flag query
- If set, the results are filtered by note to organization pinning state
- enum: 0, 1
- pinned_to_person_flag query
- If set, the results are filtered by note to person pinning state
- enum: 0, 1
- pinned_to_project_flag query
- If set, the results are filtered by note to project pinning state
- enum: 0, 1
- pinned_to_task_flag query
- If set, the results are filtered by note to task pinning state
- enum: 0, 1
Try it
Authentication
Configure credentials for Pipedrive API v1
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import pipedrive from '@utdk/pipedrive';
await pipedrive.getnotes({
"start": 0
})