v1

latestOpenAPI 3.1.1Productboard Proprietary2026-07-2453178243.2 KB

notes

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], metadata[source][system], metadata[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:

archived	processed	Result
–	–	All notes
true	true	None
true	false	Archived
false	true	Processed
false	false	Unprocessed
true	–	Archived
false	–	Processed + unprocessed
–	true	Processed
–	false	Archived + 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.

get/notes

Query parameters

pageCursorstring

Cursor for pagination.

archivedboolean

Example:true

Filter notes by archived status.

processedboolean

Example:true

Filter notes by processed status.

type[]NoteTypeInput[]

Filter notes by one or more note types. Use array notation: type[]=textNote&type[]=conversationNote. Currently supported note types:

textNote
conversationNote
opportunityNote

Legacy aliases (simple, conversation, opportunity) are also accepted.

[
  "textNote"
]

owner[id]string uuid

Filter notes by owner UUID.

owner[email]string

Example:jane.doe@example.com

Filter notes by owner email.

creator[id]string uuid

Filter notes by creator UUID.

creator[email]string

Example:john.doe@example.com

Filter notes by creator email.

metadata[source][system]string

Example:support

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

metadata[source][recordId]string

Example:ticket-12345

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

createdFromstring date-time

Example:2023-10-01T00:00:00Z

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.

createdTostring date-time

Example:2023-12-31T23:59:59Z

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.

updatedFromstring date-time

Example:2023-10-01T00:00:00Z

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.

updatedTostring date-time

Example:2023-12-31T23:59:59Z

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.

fieldsstring[]

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.

Response

A paginated list of notes

Example response

{
  "data": [
    {
      "type": "textNote",
      "links": {
        "self": "https://api.productboard.com/v2/notes/123e4567-e89b-12d3-a456-426614174000",
        "html": "https://example.productboard.com/all-notes/notes/42"
      },
      "relationships": {
        "data": [
          {
            "target": {
              "id": "123e4567-e89b-12d3-a456-426614174000"
            }
          }
        ]
      },
      "createdAt": "2025-01-15T10:30:00Z",
      "metadata": {
        "source": {
          "system": "zendesk",
          "recordId": "ticket-999",
          "url": "https://example.zendesk.com/tickets/999"
        }
      },
      "updatedAt": "2025-01-15T14:45:00Z"
    }
  ]
}