What is a Note object?

Several actions return a Note object. These are structured objects containing the following attributes:

  • Vault: the vault the note belongs to (an AFO-internal "Vault" type, which renders as Text when used in other non-AFO actions)
  • File Path: full file path of the note, starting from the vault root (Text)
  • Front matter: the block of metadata the note may have, excluding its --- boundaries (Text)
  • Properties: Obsidian's note properties (Dictionary)
  • Body: the note body, i.e. the file contents excluding any front matter (Text)
  • Content: the file contents in their entirety (Text)


Suppose you have a note file subfolder/newnote.md that contains the following:

tags: important, whatever
created_at: 2023-02-07T16:59:24Z

This is a note.

The related Note object's attributes would be:

  • Content: the whole file, i.e. what you see above
  • Vault: Testbed
  • File Path: /subfolder/newnote.md
  • Front Matter:
tags: important, whatever
created_at: 2023-02-07T16:59:24Z
  • Properties:
    • tags : a list of strings, i.e. "important", "whatever"
    • created_at : the string "2023-02-07T16:59:24Z"
    • See the examples section on the page for Get Note Properties on how to work with them.
  • Body:

This is a note.

(Notice the leading line break here — whitespace is not trimmed.) And, lastly, "Content" would be the contents of the file, as is.

If the front matter contains a structure that Obsidian can't process, Properties will be empty, because that's what Obsidian will return in that case. For details on what's allowed and supported, please see the official Properties docs page.

How to access a Note's attributes

A Note object's attributes can be accessed and selected by clicking the object, for example after you have placed it in a text block or when you use it as a parameter of another action.

Changes / History


  • Adds the Properties attribute
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Carlo Contact Carlo