Links

Notion API

This page provides an overview of the Notion API connection, which enables you to access your Notion account from within your Uiflow application.
This page outlines the following aspects of the Notion API connection:
Note: For more information, see Notion's API documentation.

Configuration requirements

This table outlines the required information to configure a Notion API connection:
Configuration field
Description
Connection Name
Name of your connection. This appears as a title for your connection tile in the Connect tab.
authToken
Notion-generated access code.
notionVersion
Version of the Notion API you want to access.

Available actions

This section provides an overview of each available action for the Notion API connection:
  • search: Enables you to locate pages in the connected Notion account.
  • getPage: Retrieves a page from the connected Notion account.
  • getBlock: Retrieves a block from the connected Notion account.
  • getBlockChildren: Retrieves an array of a block's children.
The search action enables you to locate pages in the connected Notion account. The following table outlines its parameters:
Parameter
Type
Description
query
string
Text the Notion API searches for in page titles.
sortDirection
string
Sorts the files in either ascending or descending order.
filter
string
Filters results by value and property keys. The possible values for each key are: * value: page, database * property: object
startCursor
number
Location where the next set of results starts.
pageSize
number
The number of items returned in the response.

getPage

The getPage action enables you to retrieve a page from the connected Notion account.
The only parameter required for the getPage action is pageId, a unique string identifier for a Notion page.

getBlock

The getBlock action enables you to retrieve a block from the connected Notion account.
The only parameter required for the getBlock action is blockId, a unique string identifier for a Notion block.

getBlockChildren

The getBlockChildren action enables you to retrieve an array of child blocks from a referenced Notion block. The following table outlines its parameters:
Parameter
Type
Description
blockId
string
Unique identifier for a Notion block.
startCursor
number
Location where the next set of results starts.
pageSize
number
The number of items returned in the response.

Component preview

The component preview shows how your connection component appears in the Logic view of your Uiflow application.
This section outlines how to:

Change the component name

To change the component name, navigate to the Edit Action section and adjust the Action Name field.

Display parameters on the component

To display parameters on your connection component, click Expose above the parameter fields. Selected parameters appear as nodes on the left of the connection component.