List notes

Retrieves a list of notes from your workspace.

Without the members:pii:read scope, owner and creator email fields are returned as [redacted]. Filtering by owner[email] or creator[email] requires the members:pii:read scope.

  • Notes are sorted by creation date, newest first.
  • You can filter results using query parameters like archived, processed, owner[email], creator[email], source[recordId], or date/time ranges.
  • Use the pageCursor parameter to paginate through results.
  • Use the fields query parameter to optimize response size (default: all non-null fields, use fields=all to include null values, or fields=name,tags for specific fields).

To discover available fields use the /v2/notes/configurations endpoint.

Date/Time Filtering

You can filter notes by creation or update timestamps using ISO-8601 date-time format:

  • Use createdFrom and createdTo to filter by creation date (inclusive bounds)
  • Use updatedFrom and updatedTo to filter by update date (inclusive bounds)
  • All date/time filters can be combined with each other and with other filters
  • Date ranges must be valid (From <= To) or a 400 error will be returned

Filtering combinations

Some combinations of the archived and processed flags result in empty or unexpected results. Use the following table to understand which notes are returned based on the filter values:

archivedprocessedResult
All notes
truetrueNone
truefalseArchived
falsetrueProcessed
falsefalseUnprocessed
trueArchived
falseProcessed + unprocessed
trueProcessed
falseArchived + unprocessed

Note: Archived notes always return processed: false in the API response, regardless of their actual processing state. This is a known limitation of the system.

Query Params
string

Cursor for pagination.

boolean

Filter notes by archived status.

boolean

Filter notes by processed status.

uuid

Filter notes by owner UUID.

string

Filter notes by owner email.

uuid

Filter notes by creator UUID.

string

Filter notes by creator email.

string

Filter notes by the external source record ID. Returns all notes where the source.recordId matches the provided value. Multiple notes can share the same recordId and all will be returned. Can be combined with other filters (e.g., archived, processed, owner[email]).

string

Filter notes by the source system name from metadata.source. Can be combined with metadata[source][recordId] and other filters.

string

Filter notes by the source record ID from metadata.source. Can be combined with metadata[source][system] and other filters.

date-time

Filter notes created on or after this date/time (inclusive). Must be in ISO-8601 format (e.g., "2023-10-01T12:00:00Z"). Can be combined with createdTo to define a range.

date-time

Filter notes created on or before this date/time (inclusive). Must be in ISO-8601 format (e.g., "2023-12-31T23:59:59Z"). Can be combined with createdFrom to define a range.

date-time

Filter notes updated on or after this date/time (inclusive). Must be in ISO-8601 format (e.g., "2023-10-01T12:00:00Z"). Can be combined with updatedTo to define a range.

date-time

Filter notes updated on or before this date/time (inclusive). Must be in ISO-8601 format (e.g., "2023-12-31T23:59:59Z"). Can be combined with updatedFrom to define a range.

fields
array of strings

Controls which fields are returned in the response to optimize bandwidth and tailor data to your needs.

Options:

  • Not specified: Returns only fields with non-empty values (default)
  • fields[]=all: Returns all fields, including those with null values
  • fields[]=name&fields[]=tags: Returns only the specified fields

Notes:

  • When specific fields are requested, they are returned even if they have null/empty values
  • Unknown field IDs result in a 400 Bad Request error
  • Combining all with specific field IDs results in a 400 Bad Request error

For detailed usage, examples, and field discovery, see Response Field Control.

fields
Responses

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json