Here you will find all the information you need to use Notion.

Please leave comments, feature requests and bug reports for this module in the issues section of this repository.

Find the FAQs here: FAQs

# Install via PowerShellGet 2.x
Install-Module -Name Notion -Repository PSGallery

# Install via PowerShellGet 3.x
Install-PSResource Notion -Repository PSGallery

Before you start with connecting to your Notion teamspace, you need to create an integration, which is allowed to interact with your space.

Follow this link to get a detailed instructions how to create your Notion integration.

# Import the module
Import-Module -Name Notion

# List all Cmdlets
Get-Command -Module Notion

# List Cmdlets for blocks
Get-Command -Module Notion -Noun NotionBlock

# Connect to Notion (with your integration/bearer token)
$BearerToken = Read-Host -Prompt "Enter your Bearer token" | ConvertTo-Securestring -AsPlainText
Connect-Notion -BearerToken $BearerToken

There are several attempts to talk to the Notion API out there, but most of them didn't take care of the correct syntax of the individual configuration of each block/page/database etc. So we decided to create classes for all available Notion objects presented by the API. (there are some objects which are not available right now - end of 2024 like e.g. template)

The charm of Notion classes are this simple use while creating objects.

[notion_block]::new() # creates an empty block object
[notion_page]::new()  # creates a new page object
[notion_emoji]::new() # creates a new emoji object

However, there is also a New-NotionBlock CmdLet available to create a new block object.

New-NotionBookmarkBlock -URL "https://www.example.com" -Caption "Example Bookmark"
New-NotionCalloutBlock -RichText "This is a callout" -Icon "??"
New-NotionBreadcrumbBlock #new breadcrumb block

If you receive items from the API, the Notion module will automatically convert it into Notion objects (based on the classes) so that the can be used.

There are several type of Notion object for different purposes.

• Block
• Page
• Database
• Parent
• User
• Comment
• Unfurl attribute
• File
• Emoji

Find the classes Documentation here: Classes Documentation

• Get (retrieves an object)
• New (creates an object without uploading it)
• Add (adds a new object to another already existing object e.g. a block to a page)
• Update (modifies an object)
• Remove (deletes an object)

Each of the objects have got individual CmdLets to deal with.

An easy way to generate new blocks is to instantiate them from predefined classes via [classname]::new(). On the querying side the API returns a naked object with properties. The module automatically turns those answers into proper Notion objects (derived from classes)

The enumerations (enums) are predefined values which are valid for a certain properties. e.g. colors

• [notion_rich_text_type]
• [notion_blocktype]
• [notion_database_property_type]
• #[relation_type]
• [notion_database_property_format_type]
• [notion_filetype]
• [notion_page_property_type]
• [notion_property_color]
• [notion_formula_type]
• [notion_rollup_type]
• [notion_rollup_function_type]
• [notion_page_verification_state]
• [notion_parent_type]
• [bot_owner_type]
• [notion_color]
• [notion_icon_type]
• [rich_text_mention_type]
• [template_mention_date]

• [notion_annotation]
• [notion_heading_1_block]
• [notion_heading_2_block]
• [notion_heading_3_block]
• [notion_block]
• [notion_bookmark_block]
• [notion_bot_user]
• [notion_breadcrumb_block]
• [notion_bulleted_list_item_block]
• [notion_callout_block]
• [notion_checkbox_page_property]
• [notion_child_database_block]
• [notion_child_page_block]
• [notion_code_block]
• [notion_column_block]
• [notion_column_list_block]
• [notion_comment]
• [notion_created_by_page_property]
• [notion_created_time_page_property]
• [notion_custom_emoji]
• [notion_database]
• [notion_databaseproperties]
• [notion_date_page_property]
• [notion_divider_block]
• [notion_email_page_property]
• [notion_embed_block]
• [notion_emoji]
• [notion_equation_block]
• [notion_external_file]
• [notion_file]
• [notion_file_block]
• [notion_files_page_property]
• [notion_formula_page_property]
• [notion_hosted_file]
• [notion_image_block]
• [notion_last_edited_by_page_property]
• [notion_last_edited_time_page_property]
• [notion_link_preview_block]
• [notion_multi_select_item]
• [notion_multi_select_page_property]
• [notion_number_page_property]
• [notion_numbered_list_item_block]
• [notion_page]
• [notion_icon]
• [notion_page_parent]
• [notion_pageproperties]
• [notion_paragraph_block]
• [notion_parent]
• [notion_page_parent]
• [notion_workspace_parent]
• [notion_PDF_block]
• [notion_people_page_property]
• [notion_people_user]
• [notion_phone_number_page_property]
• [notion_quote_block]
• [notion_relation_page_property]
• [notion_rich_text_page_property]
• [notion_rollup_page_property]
• [notion_section_unfurl_attribute]
• [notion_select_page_property]
• [notion_status_page_property]
• [notion_sub_type_child_unfurl_attribute]
• [notion_sub_type_unfurl_attribute]
• [notion_synced_block]
• [notion_table_of_contents_block]
• [notion_title_page_property]
• [notion_to_do_block]
• [notion_toggle_block]
• [notion_unique_id_page_property]
• [notion_url_page_property]
• [notion_user]
• [notion_verification_page_property]
• [notion_video_block]
• [rich_text]
• [rich_text_equation]
• [rich_text_equation_structure]
• [rich_text_mention]
• [rich_text_mention_base]
• [rich_text_mention_database]
• [rich_text_mention_database_structure]
• [rich_text_mention_date]
• [rich_text_mention_date_structure]
• [rich_text_mention_link_preview]
• [rich_text_mention_page]
• [rich_text_mention_page_structure]
• [rich_text_mention_template_mention]
• [rich_text_mention_template_mention_structure_base]
• [rich_text_mention_template_mention_template_mention_date_structure]
• [rich_text_mention_template_mention_template_mention_user_structure]
• [rich_text_mention_user]
• [rich_text_text]
• [rich_text_text_structure]

A full list of changes in each version can be found in the change log.