notion

0.3.0

Explore all defined data models and types for this version. For live editing and client SDK generators, inspect on TypeHub.

Open in TypeHub
Defined Types (168)
Agent_Parent_Id
Parent is an agent.
Type
Append_Block_Children_Request
Request body to append child blocks.
Type
Async_Task
Status and result of an asynchronous background task, e.g. a markdown page creation/update started with `allow_async: true`.
Type
Async_Task_Operation
The operation an async task executes.
Type
Block
A block object represents a piece of content within Notion.
Type
Block_Audio
Audio block.
Type
Block_Bookmark
Bookmark block.
Type
Block_Breadcrumb
Breadcrumb block.
Type
Block_Bulleted_List_Item
Bulleted list item block.
Type
Block_Callout
Callout block.
Type
Block_Child_Database
Child database block.
Type
Block_Child_Page
Child page block.
Type
Block_Code
Code block.
Type
Block_Collection
Paginated list of blocks.
Type
Block_Column
Column block.
Type
Block_Column_List
Column list block.
Type
Block_Divider
Divider block.
Type
Block_Embed
Embed block.
Type
Block_Equation
Equation block.
Type
Block_File
File block.
Type
Block_Heading_Four
Heading 4 block.
Type
Block_Heading_One
Heading 1 block.
Type
Block_Heading_Three
Heading 3 block.
Type
Block_Heading_Two
Heading 2 block.
Type
Block_Image
Image block.
Type
Block_Link_Preview
Link preview block (read-only).
Type
Block_Link_To_Page
Link to page block.
Type
Block_Meeting_Notes
Meeting notes block (formerly transcription).
Type
Block_Numbered_List_Item
Numbered list item block.
Type
Block_PDF
PDF block.
Type
Block_Paragraph
Paragraph block.
Type
Block_Parent_Id
Parent is a block.
Type
Block_Quote
Quote block.
Type
Block_Synced_Block
Synced block.
Type
Block_Tab
Tab block.
Type
Block_Table
Table block.
Type
Block_Table_Of_Contents
Table of contents block.
Type
Block_Table_Row
Table row block.
Type
Block_Template
Template block.
Type
Block_To_Do
To-do block.
Type
Block_Toggle
Toggle block.
Type
Block_Unsupported
Block type not supported by the API.
Type
Block_Video
Video block.
Type
Bookmark
Content of a bookmark block.
Type
Bulleted_List_Item
Content of a bulleted list item block.
Type
Callout
Content of a callout block.
Type
Child_Database
Content of a child database block.
Type
Child_Page
Content of a child page block.
Type
Code
Content of a code block.
Type
Column
Content of a column block.
Type
Column_List
Content of a column list block.
Type
Comment
A comment on a Notion page or block.
Type
Comment_Attachment
A file attached to a comment.
Type
Comment_Attachment_Request
A file upload to attach to a new comment.
Type
Comment_Collection
Paginated list of comments.
Type
Comment_Display_Name
The author name shown for a comment.
Type
Comment_Display_Name_Custom
Custom display name for a comment.
Type
Content_Position
Where to insert new content.
Type
Cover
Cover image of a page, database or data source.
Type
Create_Comment_Request
Request body to create a comment on a page, block or existing discussion. Provide either `parent` or `discussion_id`, and either `rich_text` or `markdown`.
Type
Create_Data_Source_Request
Request body to create a data source in an existing database.
Type
Create_Database_Request
Request body to create a database and its initial data source.
Type
Create_File_Upload_Request
Request body to start a file upload.
Type
Create_Page_Request
Request body to create a page.
Type
Create_View_Query_Request
Request body to execute a view's query.
Type
Create_View_Request
Request body to create a view in a database or a widget in a dashboard.
Type
Custom_Emoji
A custom emoji in the workspace.
Type
Custom_Emoji_Collection
Paginated list of custom emojis in the workspace.
Type
Custom_Emoji_Icon
Icon using a workspace custom emoji.
Type
Data_Source
A data source (table) inside a database. It holds the property schema and the pages.
Type
Data_Source_Parent_Id
Parent is a data source.
Type
Data_Source_Property
A property definition in a data source schema. `type` names the key that holds the type-specific configuration.
Type
Data_Source_Reference
Reference to a data source inside a database.
Type
Data_Source_Template
A page template available in a data source.
Type
Data_Source_Template_Collection
Paginated list of data source templates.
Type
Database
A database: a container for one or more data sources.
Type
Database_Parent_Id
Parent is a database.
Type
Date_Value
A date or date range value.
Type
Embed
Content of an embed block.
Type
Emoji_Icon
Emoji icon.
Type
Empty_Object
Empty object used by block types without configuration (divider, breadcrumb, tab).
Type
Equation
A LaTeX equation expression.
Type
Error
Error response returned by the Notion API for any non-2xx status.
Type
External_Icon
Icon hosted at an external URL.
Type
External_Object
An externally hosted file.
Type
File
File object used by image, video, pdf, file and audio blocks, and by files property values.
Type
File_Icon
Icon hosted by Notion.
Type
File_Import_Result
Result of importing a file from an external URL.
Type
File_Object
A Notion-hosted file with a temporary URL.
Type
File_Upload
Tracks the lifecycle of a file uploaded to Notion via the API.
Type
File_Upload_Collection
Paginated list of file uploads.
Type
File_Upload_Creator
Who created the file upload.
Type
File_Upload_Icon
Icon using a file uploaded via the File Upload API (request only).
Type
File_Upload_Parts
Part progress of a multi-part upload.
Type
Heading
Content of a heading block.
Type
Icon
Page, database or block icon.
Type
Id_Reference
Reference to a Notion object by its ID.
Type
Initial_Data_Source
Configuration of the initial data source of a new database.
Type
Link
An inline link.
Type
Link_Preview
Content of a link preview.
Type
Link_To_Page
Content of a link to page block.
Type
Markdown_Content_Update
A search-and-replace operation on page markdown.
Type
Markdown_Replace_Content
Replace the entire page content with new markdown.
Type
Markdown_Update_Content
Search-and-replace updates to page markdown.
Type
Meeting_Notes
Content of a meeting notes block (formerly transcription).
Type
Meeting_Notes_Calendar_Event
Calendar event linked to a meeting notes block.
Type
Meeting_Notes_Children
IDs of the child blocks of a meeting notes block.
Type
Meeting_Notes_Recording
Recording time range of a meeting notes block.
Type
Mention
An inline mention of a user, date, page, database, link preview, template or custom emoji.
Type
Move_Page_Request
Request body to move a page to a new parent.
Type
Noticon
A native Notion icon, specified by name and color.
Type
Noticon_Icon
Icon using a native Notion icon.
Type
Numbered_List_Item
Type
Object_Reference
Reference to a Notion object containing its object type and ID.
Type
Page
The Page object contains the page property values of a single Notion page.
Type
Page_Markdown
Page content rendered as enhanced Markdown.
Type
Page_Or_Data_Source
A page or data source object, as returned by search and data source queries.
Type
Page_Or_Data_Source_Collection
Paginated list of pages and/or data sources.
Type
Page_Parent_Id
Parent is a page.
Type
Page_Property_Value
Value of a page property. `type` names the key that holds the value.
Type
Page_Template
Template to apply when creating or updating a page.
Type
Paragraph
Content of a paragraph block.
Type
Parent_Id
Information about the parent of a page, block, database, data source or comment.
Type
Person
Details about a person user.
Type
Property_Item
A single page property item, or a paginated list of property items for title, rich_text, relation, people and rollup properties.
Type
Query_Data_Source_Request
Request body to query a data source.
Type
Quote
Content of a quote block.
Type
Request_Status
Indicates whether a paginated result set is complete.
Type
Rich_Text
Rich text object containing styled text, mentions or inline equations.
Type
Rich_Text_Annotation
Styling annotations of rich text.
Type
Rich_Text_Equation
Rich text object of type equation.
Type
Rich_Text_Mention
Rich text object of type mention.
Type
Rich_Text_Text
Rich text object of type text.
Type
Search_Filter
Filter for search results.
Type
Search_Request
Request body to search pages and data sources by title.
Type
Search_Sort
Sort for search results.
Type
Select_Option
A select, multi-select or status option.
Type
Sort
A sort condition for data source queries and views.
Type
Synced_Block
Content of a synced block.
Type
Synced_Block_From
Reference to the original synced block.
Type
Table
Content of a table block.
Type
Table_Of_Contents
Content of a table of contents block.
Type
Table_Row
Content of a table row block.
Type
Template
Content of a template block (deprecated in the Notion UI).
Type
Text
Text content of a rich text object of type text.
Type
To_Do
Content of a to-do block.
Type
Toggle
Content of a toggle block.
Type
Unsupported
Content of a block type not supported by the public API.
Type
Update_Block_Request
Request body to update a block. Send the key that matches the block's type, and/or `in_trash`.
Type
Update_Comment_Request
Request body to update a comment. Provide either `rich_text` or `markdown`.
Type
Update_Data_Source_Request
Request body to update a data source's title, icon, schema, trash status or parent.
Type
Update_Database_Request
Request body to update database attributes.
Type
Update_Page_Markdown_Request
Request body to update a page's content with enhanced markdown.
Type
Update_Page_Request
Request body to update page properties, icon, cover or trash status.
Type
Update_View_Request
Request body to update a view.
Type
User
A user in a Notion workspace: a member, guest or bot (integration).
Type
User_Bot
Details about a bot user.
Type
User_Bot_Owner
Details about the owner of the bot.
Type
User_Bot_Workspace_Limits
Limits and restrictions that apply to the bot's workspace.
Type
User_Collection
Paginated list of users.
Type
View
A view of a database (table, board, list, calendar, timeline, gallery, form, chart, map or dashboard).
Type
View_Collection
Paginated list of view references.
Type
View_Position
Where to place a new view in the database's view tab bar.
Type
View_Query
A cached execution of a view's query with its first page of results.
Type
View_Query_Deletion
Result of deleting a cached view query.
Type
View_Query_Result_Collection
Paginated cached results of a view query.
Type
Widget_Placement
Where to place a new widget in a dashboard view.
Type
Workspace_Parent_Id
Parent is the workspace.
Type
part of the Apioo-Project