Skip to navigation

List Notes

Returns a list of notes for one or more contacts. Notes are private. A user can see only the notes that they wrote. Notes that other users wrote about the same contacts are not returned.

The contact parameter is required. A query parameter other than contact, count, or page_token returns 400. The response is one list for all the contacts. Each note shows its contact in the contact field.

Notes are sorted by updated_at, most recently updated first. Notes with the same updated_at are sorted by note ID, so the order is stable. A note that changes while you page moves to the first page, so later pages do not include it. To show reminders by due date, get all the pages, then sort them by remind_at.

Note: Requires the Contacts API on your plan.

Required scopes

contacts:read

Authentication

AuthorizationBearer
OAuth 2.0
OR
AuthorizationBearer
Personal Access Token

Query parameters

contactlist of stringsRequired
Returns only notes about these contacts. Use 1 to 10 contact URIs, separated by commas. If the user cannot access one of the contacts, the request returns 403 and no notes.
countintegerOptional1-100Defaults to 20
The number of rows to return
page_tokenstringOptional
The token to pass to get the next or previous portion of the collection

Response

OK
collectionlist of objects
paginationobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error