v1

latestOpenAPI 3.1.1Productboard Proprietary2026-07-2453178243.2 KB
notes

Search notes

Performs a filtered search over notes using a POST request. This endpoint supports the same filtering capabilities as GET /v2/notes, but allows more complex filtering through relationships.

Filtering by owner or creator email requires the members:pii:read scope.

Filter Logic

  • Multiple values within a filter use OR logic (e.g., customer with id1 OR id2)
  • Different filter types use AND logic (e.g., customer AND link filters)

Relationships

Filter notes by their relationships to customers (users or companies) and links (features):

  • filter.relationships.customer[].id - Filter by customer or company UUIDs (OR logic within)
  • filter.relationships.link[].id - Filter by linked feature UUIDs (OR logic within)
post/notes/search

Query parameters

pageCursorstring

Cursor for pagination.

fields[]string[]

Deprecated: Use return.fields in the request body instead.

Controls which fields are returned in the response.

Request body

Example request

{
  "data": {
    "filter": {
      "type": "textNote",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  }
}

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"
    }
  ]
}