Notion tools

Look up the eight Notion tools, selectors, access boundaries, inputs, and outputs available to workflows.

This reference lists the eight shipped Notion tools. See the Notion overview for authentication and access boundaries.

Permissions

Notion tools can access only pages shared with the integration connection. Sharing a parent page also shares its child pages.

Read tools need read access to the target page. Write tools need the matching Notion content or comment capability. Agent steps must also set allow_write: true. A tool step opts into a write by naming that tool directly.

For tool step and agent integration fields, see the workflow schema reference.

Read a page from an event

Notion events contain IDs instead of current page values. Add this fragment under an existing job's steps list to fetch the current page:

- key: page
  tool: get_page
  connection: notion_acme # Replace with your Notion integration connection slug.
  with:
    page_id: ${{ event.entity.id }}

The get_page result becomes available as steps.page.outputs.result.

Tool catalog

Tools

readsearch

Search shared Notion pages and data sources by title. This is not full-text search. The result is paginated and can be filtered by object type.

Requiresread

Parameters

querystring

Title text to search for

objectstring

Only return pages or data sources

Possible values: page, data_source

page_sizeinteger

Number of results to return, from 1 to 100

Minimum 1. Maximum 100.

cursorstring

Notion pagination cursor from the previous response

Returns

resultsarray of object

next_cursorstring | null

Cursor for the next page

has_moreboolean

Whether another page is available

readget_page

Retrieve a shared Notion page by URL or ID, including its title, parent, properties, and timestamps.

Requiresread

Parameters

page_idstringRequired

Notion page URL or page ID

Returns

idstring

Notion page ID

urlstring

Notion page URL

titlestring

Page title

parentobject

Notion object with provider-defined fields

propertiesobject

Notion object with provider-defined fields

created_timestring

Creation timestamp

last_edited_timestring

Last edit timestamp

- key: get_page
  tool: get_page
  connection: notion_acme # Replace with the slug of your integration connection.
  with:
    page_id: <page_id>
  outputs:
    id: ${{ result.id }}

readget_page_content

Retrieve the Markdown content of a shared Notion page by URL or ID.

Requiresread

Parameters

page_idstringRequired

Notion page URL or page ID

Returns

markdownstring

Page content in Markdown

truncatedboolean

Whether Notion truncated the content

unknown_block_idsarray of string

- key: get_page_content
  tool: get_page_content
  connection: notion_acme # Replace with the slug of your integration connection.
  with:
    page_id: <page_id>
  outputs:
    markdown: ${{ result.markdown }}

readquery_data_source

Query rows in a shared Notion data source. Notion filter and sort objects pass through unchanged.

Requiresread

Parameters

data_source_idstringRequired

Notion data source URL or data source ID

filterobject

Notion object with provider-defined fields

sortsarray of object

page_sizeinteger

Number of results to return, from 1 to 100

Minimum 1. Maximum 100.

cursorstring

Notion pagination cursor from the previous response

Returns

resultsarray of object

next_cursorstring | null

Cursor for the next page

has_moreboolean

Whether another page is available

- key: query_data_source
  tool: query_data_source
  connection: notion_acme # Replace with the slug of your integration connection.
  with:
    data_source_id: <data_source_id>
  outputs:
    results: ${{ result.results }}

readget_comments

List comments on a shared Notion page or block. The result is paginated.

Requiresread

Parameters

block_idstringRequired

Notion page URL, block URL, or block ID

cursorstring

Notion pagination cursor from the previous response

Returns

resultsarray of object

next_cursorstring | null

Cursor for the next page

has_moreboolean

Whether another page is available

- key: get_comments
  tool: get_comments
  connection: notion_acme # Replace with the slug of your integration connection.
  with:
    block_id: <block_id>
  outputs:
    results: ${{ result.results }}

writecreate_page

Create a Notion page under a page or data source. Properties use Notion's shape and markdown is optional. Notion limits each rich text item to 2,000 characters, block arrays to 100 items, and each request to 500 KB.

Requireswrite

Parameters

parentobjectRequired

Notion page or data source parent, with page_id or data_source_id

propertiesobjectRequired

Notion page properties in Notion's property shape

markdownstring

Markdown page content

Returns

idstring

Notion page ID

urlstring

Notion page URL

titlestring

Page title

parentobject

Notion object with provider-defined fields

propertiesobject

Notion object with provider-defined fields

created_timestring

Creation timestamp

last_edited_timestring

Last edit timestamp

- key: create_page
  tool: create_page
  connection: notion_acme # Replace with the slug of your integration connection.
  with:
    parent: {}
    properties: {}
  outputs:
    id: ${{ result.id }}

writeupdate_page

Update a Notion page properties and/or its Markdown content. Properties are updated first when both are provided; content mode is append or replace. Notion limits each rich text item to 2,000 characters, block arrays to 100 items, and each request to 500 KB.

Requireswrite

Parameters

page_idstringRequired

Notion page URL or page ID

propertiesobject

Notion page properties in Notion's property shape

markdownstring

Markdown page content

modestring

Whether to append or replace Markdown content

Possible values: append, replace

Returns

This tool returns the provider response without declared fields.

writeadd_comment

Add plain text to a Notion page or reply to a discussion. Text over 2,000 characters is split into multiple rich text items. Notion limits block arrays to 100 items and each request to 500 KB.

Requireswrite

Parameters

page_idstring

Notion page URL or page ID

discussion_idstring

Notion discussion ID for a reply

textstringRequired

Plain-text comment content

Returns

This tool returns the provider response without declared fields.

Was this page helpful?

Edit this page on GitHub

Permissions

Read a page from an event

Tool catalog

Tools

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

On this page