Sign in

v1

latestOpenAPI 3.1.1Productboard Proprietary2026-07-2453178243.2 KB
notes

Get note

Retrieves the full details of a specific note by its ID.

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

By default, the response includes all non-null fields available in your workspace for that note type (e.g. textNote, conversationNote). You can optimize the response size by using the fields query parameter:

  • Use fields=name,tags,content to retrieve only specific fields
  • Use fields=all to include all fields, even those with null values

You can use this endpoint to display the entire note content, including metadata such as owner, tags, and relationships.

Use the /v2/notes/configurations endpoint to discover which fields are available for your workspace.

get/notes/{id}

Path parameters

idstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000

Note identifier.

Query parameters

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

Note details

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