Notes are pieces of textual (HTML-formatted) information that can be attached to deals, persons and organizations. Notes are usually displayed in the UI in chronological order – newest first – and in context with other updates regarding the item they are attached to. The maximum note size is approximately 100,000 characters (or 100KB per note).
Returns all notes.
/v1/notes
user_id
integer
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.
Format
uuid
deal_id
integer
The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned.
person_id
integer
The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned.
org_id
integer
The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned.
start
integer
Pagination start
Default
0
limit
integer
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
Format
date
end_date
string
The date in format of YYYY-MM-DD until which notes to fetch to
Format
date
pinned_to_lead_flag
number
If set, the results are filtered by note to lead pinning state
Values
0
1
pinned_to_deal_flag
number
If set, the results are filtered by note to deal pinning state
Values
0
1
pinned_to_organization_flag
number
If set, the results are filtered by note to organization pinning state
Values
0
1
pinned_to_person_flag
number
If set, the results are filtered by note to person pinning state
Values
0
1
OK
Returns details about a specific note.
/v1/notes/{id}
id
integer
required
The ID of the note
OK
Returns all comments associated with a note.
/v1/notes/{id}/comments
id
integer
required
The ID of the note
start
integer
Pagination start
Default
0
limit
integer
Items shown per page
OK
Returns the details of a comment.
/v1/notes/{id}/comments/{commentId}
id
integer
required
The ID of the note
commentId
string
required
The ID of the comment
Format
uuid
OK
Adds a new note.
/v1/notes
application/json
content
string
required
The content of the note in HTML format. Subject to sanitization on the back-end.
lead_id
string
The ID of the lead the note will be attached to. This property is required unless one of (deal_id/person_id/org_id
) is specified.
Format
uuid
deal_id
integer
The ID of the deal the note will be attached to. This property is required unless one of (lead_id/person_id/org_id
) is specified.
person_id
integer
The ID of the person this note will be attached to. This property is required unless one of (deal_id/lead_id/org_id
) is specified.
org_id
integer
The ID of the organization this note will be attached to. This property is required unless one of (deal_id/lead_id/person_id
) is specified.
user_id
integer
The ID of the user who will be marked as the author of the note. Only an admin can change the author.
add_time
string
The optional creation date & time of the note in UTC. Can be set in the past or in the future. Format: YYYY-MM-DD HH:MM:SS
pinned_to_lead_flag
If set, the results are filtered by note to lead pinning state (lead_id
is also required)
Values
0
1
pinned_to_deal_flag
If set, the results are filtered by note to deal pinning state (deal_id
is also required)
Values
0
1
pinned_to_organization_flag
If set, the results are filtered by note to organization pinning state (org_id
is also required)
Values
0
1
pinned_to_person_flag
If set, the results are filtered by note to person pinning state (person_id
is also required)
Values
0
1
OK
Adds a new comment to a note.
/v1/notes/{id}/comments
id
integer
required
The ID of the note
application/json
content
string
required
The content of the comment in HTML format. Subject to sanitization on the back-end.
OK
Updates a note.
/v1/notes/{id}
id
integer
required
The ID of the note
application/json
content
string
The content of the note in HTML format. Subject to sanitization on the back-end.
lead_id
string
The ID of the lead the note will be attached to
Format
uuid
deal_id
integer
The ID of the deal the note will be attached to
person_id
integer
The ID of the person the note will be attached to
org_id
integer
The ID of the organization the note will be attached to
user_id
integer
The ID of the user who will be marked as the author of the note. Only an admin can change the author.
add_time
string
The optional creation date & time of the note in UTC. Can be set in the past or in the future. Format: YYYY-MM-DD HH:MM:SS
pinned_to_lead_flag
If set, the results are filtered by note to lead pinning state (lead_id
is also required)
Values
0
1
pinned_to_deal_flag
If set, the results are filtered by note to deal pinning state (deal_id
is also required)
Values
0
1
pinned_to_organization_flag
If set, the results are filtered by note to organization pinning state (org_id
is also required)
Values
0
1
pinned_to_person_flag
If set, the results are filtered by note to person pinning state (person_id
is also required)
Values
0
1
OK
Updates a comment related to a note.
/v1/notes/{id}/comments/{commentId}
id
integer
required
The ID of the note
commentId
string
required
The ID of the comment
Format
uuid
application/json
content
string
required
The content of the comment in HTML format. Subject to sanitization on the back-end.
OK
Deletes a specific note.
/v1/notes/{id}
id
integer
required
The ID of the note
OK
Deletes a comment.
/v1/notes/{id}/comments/{commentId}
id
integer
required
The ID of the note
commentId
string
required
The ID of the comment
Format
uuid
OK