Person management
Journal management
API documentation
Account management
Persons
Journal
Notes
Table of contents
This endpoint lets you manage notes for contacts in your account.
Notes allow you to record important information, reminders, or observations about a specific person.
All notes are associated with a person and include information about who created them.
The Note object
This object represents a note attached to a person in your account.
Attributes
The ID of the note.
The object type. Always 'note'.
The content of the note.
The ID of the person this note is attached to.
Information about the user who created the note.
The date and time the object was created, in Unix timestamp format.
The date and time the object was last updated, in Unix timestamp format.
{
"id":
123
,
"object":
"note"
,
"content":
"This is a sample note about the person."
,
"person_id":
456
,
"author": {
"id":
789
,
"name":
"John Doe"
,
"email":
"[email protected]"
},
"created_at":
1712322633
,
"updated_at":
1712322633
}
Get the list of notes for a person
This endpoint retrieves all notes associated with a specific person.
URL parameters
The ID of the person whose notes you want to retrieve.
Query parameters
The page number for paginated results.
The number of items per page for paginated results.
Response attributes
An array of note objects.
Pagination links.
Pagination metadata.
{
"data": [
{
"id":
123
,
"object":
"note"
,
"content":
"This is a sample note about the person."
,
"person_id":
456
,
"author": {
"id":
789
,
"name":
"John Doe"
,
"email":
"[email protected]"
},
"created_at":
1712322633
,
"updated_at":
1712322633
}
],
"links": {
"first": "http://example.com/api/persons/456/notes?page=1",
"last": "http://example.com/api/persons/456/notes?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{"url": null, "label": "« Previous", "active": false},
{"url": "http://example.com/api/persons/456/notes?page=1", "label": "1", "active": true},
{"url": null, "label": "Next »", "active": false}
],
"path": "http://example.com/api/persons/456/notes",
"per_page": 15,
"to": 1,
"total": 1
}
}
Get a specific note
This endpoint retrieves a specific note by its ID.
URL parameters
The ID of the person the note belongs to.
The ID of the note to retrieve.
Query parameters
No query parameters are available for this endpoint.
Response attributes
The requested note object.
{
"data": {
"id":
123
,
"object":
"note"
,
"content":
"This is a sample note about the person."
,
"person_id":
456
,
"author": {
"id":
789
,
"name":
"John Doe"
,
"email":
"[email protected]"
},
"created_at":
1712322633
,
"updated_at":
1712322633
}
}
Create a new note
This endpoint creates a new note for a person. It will return the note in the response.
URL parameters
The ID of the person to add the note to.
Query parameters
The content of the note. Maximum 255 characters.
Response attributes
The created note object.
{
"data": {
"id":
123
,
"object":
"note"
,
"content":
"This is a sample note about the person."
,
"person_id":
456
,
"author": {
"id":
789
,
"name":
"John Doe"
,
"email":
"[email protected]"
},
"created_at":
1712322633
,
"updated_at":
1712322633
}
}
Update a note
This endpoint updates an existing note. It will return the updated note in the response.
URL parameters
The ID of the person the note belongs to.
The ID of the note to update.
Query parameters
The updated content of the note. Maximum 255 characters.
Response attributes
The updated note object.
{
"data": {
"id":
123
,
"object":
"note"
,
"content":
"This is a sample note about the person."
,
"person_id":
456
,
"author": {
"id":
789
,
"name":
"John Doe"
,
"email":
"[email protected]"
},
"created_at":
1712322633
,
"updated_at":
1712322633
}
}
Delete a note
This endpoint deletes a note. It will return a 204 No Content response on success, or a 404 Not Found if the note doesn't exist or you don't have permission to delete it.
URL parameters
The ID of the person the note belongs to.
The ID of the note to delete.
Query parameters
No query parameters are available for this endpoint.
Response attributes
This endpoint returns a 204 No Content response with no body on success, or a 404 Not Found if the note doesn't exist or you don't have permission to delete it.
204 No Content
Please login to vote.
It's free and will help us improve the page.
Taylor will be proud of you.
Last updated on April 5, 2025.