Get all notes
GET {{baseUrl}}/notes?user_id=<integer>&lead_id=<uuid>&deal_id=<integer>&person_id=<integer>&org_id=<integer>&start=0&limit=<integer>&sort=<string>&start_date=<date>&end_date=<date>&pinned_to_lead_flag=<number>&pinned_to_deal_flag=<number>&pinned_to_organization_flag=<number>&pinned_to_person_flag=<number>
Returns all notes.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
user_id | string | The ID of the user whose notes to fetch. If omitted, notes by all users will be returned. | |
lead_id | string | The ID of the lead which notes to fetch. If omitted, notes about all leads will be returned. | |
deal_id | string | The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned. | |
person_id | string | The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned. | |
org_id | string | The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned. | |
start | number | Pagination start | |
limit | string | Items shown per page | |
sort | string | 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. | |
start_date | string | The date in format of YYYY-MM-DD from which notes to fetch | |
end_date | string | The date in format of YYYY-MM-DD until which notes to fetch to | |
pinned_to_lead_flag | string | If set, the results are filtered by note to lead pinning state | |
pinned_to_deal_flag | string | If set, the results are filtered by note to deal pinning state | |
pinned_to_organization_flag | string | If set, the results are filtered by note to organization pinning state | |
pinned_to_person_flag | string | If set, the results are filtered by note to person pinning state |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"success":true,"data":[{"id":1,"active_flag":true,"add_time":"2019-12-09 13:59:21","content":"abc","deal":{"title":"Deal title"},"lead_id":"adf21080-0e10-11eb-879b-05d71fb426ec","deal_id":1,"last_update_user_id":1,"org_id":1,"organization":{"name":"Organization name"},"person":{"name":"Person name"},"person_id":1,"pinned_to_lead_flag":false,"pinned_to_deal_flag":true,"pinned_to_organization_flag":false,"pinned_to_person_flag":false,"update_time":"2019-12-09 14:26:11","user":{"email":"user@email.com","icon_url":"https://iconurl.net/profile_120x120_123.jpg","is_you":true,"name":"User Name"},"user_id":1}],"additional_data":{"pagination":{"start":0,"limit":100,"more_items_in_collection":true,"next_start":100}}}