Notion (Independent Publisher)
Notion connector use the API to access Notion's pages, databases, and users.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Chandra Sekhar & Harshini Varma |
| URL | https://github.com/sekharmalla |
| chandra.malla@msftcommunity.com |
| Connector Metadata | |
|---|---|
| Publisher | Chandra Sekhar & Harshini Varma |
| Website | https://www.notion.so/ |
| Privacy policy | https://www.notion.so/Privacy-Policy-3468d120cf614d4c9014c09f6adc9091 |
| Categories | Productivity;collaboration |
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Append block children |
Creates and appends new children blocks to the parent block_id specified. |
| Create a page |
Creates a new page in the specified database. existing page. |
| Create comment |
Creates a comment in a page or existing discussion thread. |
| Delete a block |
Sets a Block object, including page blocks, to archived: true using the ID specified. Note: in the Notion UI application, this moves the block to the "Trash" where it can still be accessed and restored. |
| List of all users |
Returns a paginated list of Users for the workspace |
| Query a database |
Gets a list of Pages contained in the database, filtered and ordered according to the filter conditions and sort criteria provided in the request. |
| Retrieve a block |
Retrieves a Block object using the ID specified. |
| Retrieve a database |
Retrieves a Database object using the ID specified. |
| Retrieve a page |
Retrieves a Page object using the ID specified. |
| Retrieve a page property item |
Retrieve a page property item |
| Retrieve block children |
Returns a paginated array of child block objects contained in the block using the ID specified |
| Retrieve comments |
Retrieves a list of un-resolved Comment objects from a page or block. |
| Retrieve User |
Retrieves a User using the ID specified. |
| Retrieve your token's bot user |
Retrieves the bot User associated with the API token provided in the authorization header. The bot will have an owner field with information about the person who authorized the integration. |
| Search |
Searches all pages and child pages that are shared with the integration. The results may include databases. |
| Update a block |
Updates the content for the specified block_id based on the block type. Supported fields based on the block object type |
Append block children
Creates and appends new children blocks to the parent block_id specified.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Block id
|
block_id | True | string |
Identifier for a block |
|
object
|
object | string |
object |
|
|
type
|
type | string |
type |
|
|
type
|
type | string |
type |
|
|
content
|
content | string |
content |
|
|
type
|
type | string |
type |
|
|
content
|
content | string |
content |
|
|
url
|
url | string |
url |
Create a page
Creates a new page in the specified database. existing page.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Database ID
|
database_id | True | string |
Unique identifier for the database. |
|
Emoji
|
emoji | string |
emoji |
|
|
Cover URL
|
url | string |
Page cover image URL. |
|
|
Properties
|
properties | object |
Schema of properties for the database as they appear in Notion. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Unique identifier of the page. |
|
Created time
|
created_time | string |
Date and time when this page was created. Formatted as an ISO 8601 date time string. |
|
Last edited time
|
last_edited_time | string |
Date and time when this page was updated. Formatted as an ISO 8601 date time string. |
|
Id
|
created_by.id | string |
Unique identifier for this user. |
|
Id
|
last_edited_by.id | string |
Unique identifier for this user. |
|
url
|
cover.url | string |
Link to the externally hosted image. |
|
emoji
|
icon.emoji | string |
Emoji character. |
|
database_id
|
parent.database_id | string |
database_id |
|
archived
|
archived | boolean |
The archived status of the page. |
|
URL
|
url | string |
The URL of the Notion page. |
Create comment
Creates a comment in a page or existing discussion thread.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Page ID
|
page_id | string |
Identifier for a page |
|
|
Discussion ID
|
discussion_id | string |
Identifier for a Notion block |
|
|
Content
|
content | string |
Text content. This field contains the actual content of your text and is probably the field you'll use most often. |
Returns
- Body
- CommentResponse
Delete a block
Sets a Block object, including page blocks, to archived: true using the ID specified. Note: in the Notion UI application, this moves the block to the "Trash" where it can still be accessed and restored.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Block ID
|
blockId | True | string |
Identifier for a Notion block |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
Identifier for the block. |
|
Created time
|
created_time | date-time |
Date and time when this block was created. |
|
Last edited time
|
last_edited_time | date-time |
Date and time when this block was last updated. |
|
Object
|
created_by.object | string |
Always "user" |
|
Id
|
created_by.id | string |
Unique identifier for this user. |
|
Object
|
last_edited_by.object | string |
Last edited user |
|
Id
|
last_edited_by.id | string |
Unique identifier for this user. |
|
Has children
|
has_children | boolean |
Whether or not the block has children blocks nested within it. |
|
Archived
|
archived | boolean |
The archived status of the block. |
|
Type
|
type | string |
An object containing a type-specific block information |
List of all users
Returns a paginated list of Users for the workspace
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Page size
|
page_size | integer |
The number of items from the full list desired in the response. Maximum: 100 |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Identifier for a Notion block |
|
Display Name
|
name | string |
User's name displayed in Notion. |
|
Avatar URL
|
avatar_url | string |
Chosen avatar image. |
|
Type
|
type | string |
Type of the user. Possible values are "person" and "bot". |
|
Email
|
string |
Email address of person. |
|
|
Next Cursor
|
next_cursor | string |
A cursor returned used to request the next page of results. Treat this as an opaque value |
|
Has more
|
has_more | boolean |
When the response includes the end of the list |
Query a database
Gets a list of Pages contained in the database, filtered and ordered according to the filter conditions and sort criteria provided in the request.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Database ID
|
database_id | True | string |
Identifier for a Notion database. |
Returns
- Body
- DatabaseResponse
Retrieve a block
Retrieves a Block object using the ID specified.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Block ID
|
blockId | True | string |
Identifier for the block. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
object
|
object | string |
object |
|
id
|
id | string |
Identifier for the block. |
|
Created time
|
created_time | date-time |
Date and time when this block was created. |
|
Last edited time
|
last_edited_time | date-time |
Date and time when this block was last updated. |
|
Object
|
created_by.object | string |
Always "user" |
|
Id
|
created_by.id | string |
Unique identifier for this user. |
|
Object
|
last_edited_by.object | string |
Last edited user |
|
Id
|
last_edited_by.id | string |
Unique identifier for this user. |
|
Has children
|
has_children | boolean |
Whether or not the block has children blocks nested within it. |
|
Archived
|
archived | boolean |
The archived status of the block. |
|
Type
|
type | string |
An object containing a type-specific block information |
Retrieve a database
Retrieves a Database object using the ID specified.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Database id
|
database_id | True | string |
Identifier for a Notion database |
Returns
- Body
- DatabaseResponse
Retrieve a page
Retrieves a Page object using the ID specified.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Page ID
|
page_id | True | string |
Identifier for a Notion page |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Unique identifier of the page. |
|
Created time
|
created_time | string |
Date and time when this page was created. Formatted as an ISO 8601 date time string. |
|
Last edited time
|
last_edited_time | string |
Date and time when this page was updated. Formatted as an ISO 8601 date time string. |
|
Id
|
created_by.id | string |
Unique identifier for this user. |
|
Id
|
last_edited_by.id | string |
Unique identifier for this user. |
|
url
|
cover.url | string |
Link to the externally hosted image. |
|
emoji
|
icon.emoji | string |
Emoji character. |
|
database_id
|
parent.database_id | string |
database_id |
|
archived
|
archived | boolean |
The archived status of the page. |
|
URL
|
url | string |
The URL of the Notion page. |
Retrieve a page property item
Retrieve a page property item
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Page ID
|
page_id | True | string |
Identifier for a Notion page |
|
Property ID
|
property_id | True | string |
Identifier for a page property |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Object
|
object | string |
Always list. |
|
Has more
|
has_more | boolean |
When the response includes the end of the list, false. Otherwise, true. |
Retrieve block children
Returns a paginated array of child block objects contained in the block using the ID specified
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Block id
|
block_id | True | string |
Identifier for a block |
|
Page size
|
page_size | integer |
The number of items from the full list desired in the response. Maximum: 100 |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
items.id | string |
Identifier for the block. |
|
Created time
|
items.created_time | date-time |
Date and time when this block was created. |
|
Last edited time
|
items.last_edited_time | date-time |
Date and time when this block was last updated. |
|
Has children
|
items.has_children | boolean |
Whether or not the block has children blocks nested within it. |
|
Archived
|
items.archived | boolean |
The archived status of the block. |
|
Type
|
items.type | string |
Type of block. Possible values |
|
Plain text
|
plain_text | string |
Plain text in the paragraph block plain_text |
|
Next cursor
|
next_cursor | string |
A cursor returned used to request the next page of results. Treat this as an opaque value |
|
Has more
|
has_more | boolean |
Whether or not the block has more blocks or not |
Retrieve comments
Retrieves a list of un-resolved Comment objects from a page or block.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Block Id
|
block_id | True | string |
Identifier for a Notion block or page |
Returns
- Body
- CommentResponse
Retrieve User
Retrieves a User using the ID specified.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
User ID
|
user_id | True | string |
Unique identifier for this user. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Identifier for a Notion user |
|
User Name
|
name | string |
Name of the User |
|
Avatar URL
|
avatar_url | string |
Chosen avatar image |
|
Email
|
string |
Email address of person. |
Retrieve your token's bot user
Retrieves the bot User associated with the API token provided in the authorization header. The bot will have an owner field with information about the person who authorized the integration.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Unique identifier for this user. |
|
Name
|
name | string |
User's name as displayed in Notion. |
|
Avatar url
|
avatar_url | string |
Chosen avatar image. |
|
Type
|
type | string |
Type of the user. Possible values are "person" and "bot". |
|
Owner type
|
bot.owner.type | string |
The type of owner - either "workspace" or "user". |
Search
Searches all pages and child pages that are shared with the integration. The results may include databases.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Query
|
query | True | string |
When supplied, limits which pages are returned by comparing the query to the page title. |
|
Direction
|
direction | string |
The direction to sort. Possible values include ascending and descending. |
|
|
Timestamp
|
timestamp | string |
The name of the timestamp to sort against. Possible values include last_edited_time. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
Identifier for the block. |
|
Created time
|
created_time | string |
Date and time when this page was created. |
|
Last edited time
|
last_edited_time | string |
Date and time when this page was updated. |
|
Plain text
|
plain_text | string |
The plain text without annotations. |
|
Tags
|
Tags | object |
The tags object contains the list of tags. |
|
URL
|
url | string |
The URL of the object. |
|
Next cursor
|
next_cursor | string |
A cursor returned used to request the next page of results. Treat this as an opaque value |
|
Has more
|
has_more | boolean |
Whether or not the block has more blocks or not |
Update a block
Updates the content for the specified block_id based on the block type. Supported fields based on the block object type
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Block ID
|
blockId | True | string |
Identifier for a Notion block |
|
Content
|
content | string |
Text content. This field contains the actual content of your text and is probably the field you'll use most often. |
|
|
Color
|
color | string |
Color of the block. |
|
|
Content
|
content | string |
Text content. This field contains the actual content of your text and is probably the field you'll use most often. |
|
|
Color
|
color | string |
Color of the block. |
|
|
Content
|
content | string |
Text content2. This field contains the actual content of your text and is probably the field you'll use most often. |
|
|
Color
|
color | string |
Color of the block. |
|
|
Content
|
content | string |
Text content. This field contains the actual content of your text and is probably the field you'll use most often. |
|
|
Color
|
color | string |
colors |
|
|
Contents1
|
content | string |
Text content. This field contains the actual content of your text and is probably the field you'll use most often. |
|
|
Color
|
color | string |
Color of the block. |
|
|
Contents1
|
content | string |
Text content. This field contains the actual content of your text and is probably the field you'll use most often. |
|
|
Color
|
color | string |
Color of the block. |
|
|
Contents1
|
content | string |
Text content. This field contains the actual content of your text and is probably the field you'll use most often. |
|
|
Checked
|
checked | boolean |
Whether the to_do is checked or not. |
|
|
Color
|
color | string |
Color of the block. |
Definitions
CommentResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
Unique identifier of the comment. |
|
Page Id
|
parent.page_id | string |
The ID of the page that this page belongs to. |
|
Discussion id
|
discussion_id | string |
Unique identifier of the discussion thread that the comment is associated with. |
|
Created time
|
created_time | string |
Date and time when this comment was created. |
|
Last edited time
|
last_edited_time | string |
Date and time when this comment was updated. |
|
object
|
created_by.object | string |
object |
|
id
|
created_by.id | string |
id |
|
Rich text
|
rich_text | array of object |
Content of the comment, which supports rich text formatting, links, and mentions. |
|
type
|
rich_text.type | string |
type |
|
Content
|
rich_text.text.content | string |
Text content. |
|
Link
|
rich_text.text.link | string |
Any inline link in this text. |
|
Plain text
|
rich_text.plain_text | string |
The plain text without annotations. |
|
href
|
rich_text.href | string |
(optional) The URL of any link or internal Notion mention in this text, if any. |
DatabaseResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
results
|
results | array of object | |
|
Object
|
results.object | string |
Page or 'database' |
|
Id
|
results.id | string |
Unique identifier for the database. |
|
Created time
|
results.created_time | string |
Date and time when this database was created. Formatted as an ISO 8601 date time string. |
|
Last edited time
|
results.last_edited_time | string |
Date and time when this database was updated. Formatted as an ISO 8601 date time string. |
|
Object
|
results.created_by.object | string |
User who created the database. |
|
Id
|
results.created_by.id | string |
Unique identifier for the user |
|
Object
|
results.last_edited_by.object | string |
User who created the database. |
|
Id
|
results.last_edited_by.id | string |
Unique identifier for the user |
|
Archived
|
results.archived | boolean |
The archived status of the database. |
|
URL
|
results.url | string |
The URL of the Notion database |