Objects - Charter

Field	Type	Description
`parent` *	Parent	Where the page is created: `page_id` for a subpage, or `data_source_id` to add a row to a database.
`properties`	map of PagePropertyValue	The values of the page’s properties, keyed by property name or ID. A page whose parent is a data source must use that data source’s schema; a page whose parent is another page has only `title`.
`icon`	Icon	The page’s icon.
`cover`	Cover	The page’s cover image.
`children`	Block[]	The content of the new page, as blocks. At most 100, and at most two levels of nesting — append the rest afterwards. max 100 items
`content`	Block[]	An alias for `children`. Send one or the other, not both. max 100 items
`markdown`	`string`	The content of the new page as Notion-flavored Markdown, which Notion parses into blocks. Newlines must be `\n`.
`template`	Template	A template to build the page from. Applying one is incompatible with supplying content directly.
`position`	Position	Where the content is placed within the page.
`allowAsync`	`boolean`	Whether a large `markdown` body may be parsed in the background. When true the call answers 202 with an async task to poll rather than the finished page.

Parent

What an object lives under.

Field	Type	Description
`type`	`string`	The type of the parent. One of `database_id`, `data_source_id`, `page_id`, `workspace`, `block_id`, `agent_id`.
`dataSourceId`	`string`	The ID of the data source this object belongs to. This is the parent a page in a database takes.
`databaseId`	`string`	The ID of the database. On a data source’s parent this is the database that contains it. As a page’s parent it is the pre-2025-09-03 spelling: prefer `data_source_id`, which names the table the page is a row of.
`pageId`	`string`	The ID of the parent page.
`blockId`	`string`	The ID of the parent block.

PagePropertyValue

One entry in a page’s properties map.

Field	Type	Description
`type`	`string`	The type of this property value. Returned on a read; on a write Notion infers it from whichever field below is set.
`title`	RichText[]	The page’s title, as rich text. Every page has exactly one title property, and it is the only property a page outside a database has. max 100 items
`richText`	RichText[]	A text property, as rich text. max 100 items
`number`	`number`	A number. Send null to clear it.
`select`	SelectValue	The chosen option of a select property. Send null to clear it.
`multiSelect`	SelectValue[]	The chosen options of a multi-select property. max 100 items
`status`	StatusValue	The current status of the page.
`date`	DateValue	A date or date range. Send null to clear it.
`people`	PartialUser[]	The users assigned to a people property. max 100 items
`files`	FileObject[]	The files attached to a files property. An `external` entry must carry a `name`. Sending this replaces the whole list rather than adding to it. max 100 items
`checkbox`	`boolean`	Whether a checkbox is checked.
`url`	`string`	A URL. Maximum 2000 characters. max length 2000
`email`	`string`	An email address. Maximum 200 characters. max length 200
`phoneNumber`	`string`	A phone number. No structure is enforced, so any string up to 200 characters is accepted. max length 200
`relation`	RelationRef[]	The related pages. At most 100 may be sent or read in one request; a relation holding more reports `has_more` and is read in full through the page property item endpoint. max 100 items
`verification`	VerificationValue	The verification state of a page in a wiki database.

RichText

One run of styled text.

Field	Type	Description
`type`	`"text" \| "mention" \| "equation"`	The type of this rich text object.
`text`	TextContent	The literal text, present when `type` is `text`.
`mention`	Mention	An inline mention of a user, page, database, date or link preview, present when `type` is `mention`.
`equation`	EquationContent	An inline LaTeX equation, present when `type` is `equation`.
`annotations`	Annotations	The styling applied to this run of text.

TextContent

A literal run of text.

Field	Type	Description
`content` *	`string`	The actual text content of the text. Maximum 2000 characters; longer text must be split across several rich text objects. max length 2000
`link`	TextLink	An object with information about any inline link in this text, if included. Null when the text is not a link.

TextLink

The link on a text run.

Field	Type	Description
`url` *	`string`	The URL this text links to. Maximum 2000 characters. max length 2000

Mention

An inline reference to something else in the workspace.

Field	Type	Description
`type`	`string`	The type of the inline mention. One of `user`, `page`, `database`, `date`, `link_preview`, `template_mention`.
`user`	PartialUser	The mentioned user.
`page`	PageRef	The mentioned page.
`database`	DatabaseRef	The mentioned database.
`date`	DateValue	The mentioned date.
`linkPreview`	LinkPreviewRef	The mentioned link preview.
`templateMention`	TemplateMention	The template placeholder being mentioned.

PartialUser

A user, referenced by ID.

Field	Type	Description
`object`	`string`	Always `user`. defaults to `"user"`
`id` *	`string`	The ID of the user.

PageRef

A reference to a page by ID.

Field	Type	Description
`id` *	`string`	The ID of the page.

DatabaseRef

A reference to a database by ID.

Field	Type	Description
`id` *	`string`	The ID of the database.

DateValue

A date, or a date range, with an optional time zone.

Field	Type	Description
`start` *	`string`	An ISO 8601 format date, with optional time. A date without a time (`2024-05-01`) and a datetime (`2024-05-01T10:00:00-04:00`) are both accepted.
`end`	`string`	An ISO 8601 formatted date, with optional time. Null if this is not a range.
`timeZone`	`string`	Time zone information for `start` and `end`, as an IANA database name such as `America/New_York`. When set, `start` and `end` must not carry their own UTC offset. Null when the dates carry their own offsets.

LinkPreviewRef

A mention of a third-party URL that Notion renders as a preview.

Field	Type	Description
`url` *	`string`	The URL of the link preview. max length 2000

TemplateMention

A placeholder that resolves when a template is instantiated.

Field	Type	Description
`type`	`"template_mention_date" \| "template_mention_user"`	The type of the template mention.
`templateMentionDate`	`"today" \| "now"`	Resolves to the date the template is used.
`templateMentionUser`	`string`	Resolves to the user who uses the template.

EquationContent

An inline LaTeX equation.

Field	Type	Description
`expression` *	`string`	The LaTeX string representing the inline equation. Maximum 1000 characters. max length 1000

Annotations

The styling applied to one run of rich text.

Field	Type	Description
`bold`	`boolean`	Whether the text is bolded.
`italic`	`boolean`	Whether the text is italicized.
`strikethrough`	`boolean`	Whether the text is struck through.
`underline`	`boolean`	Whether the text is underlined.
`code`	`boolean`	Whether the text is code style.
`color`	NotionColor	Color of the text. Possible values include the ten hues as text colors and again as `_background` highlights, plus `default`.

SelectValue

One chosen option of a select or multi-select property.

Field	Type	Description
`id`	`string`	The ID of the option. Use this or `name`, not both.
`name`	`string`	The name of the option as it appears in Notion. Commas are not valid in a select value. An option that does not exist yet is created.

StatusValue

The current status of a page in a status property.

Field	Type	Description
`id`	`string`	The ID of the status option. Use this or `name`, not both.
`name`	`string`	The name of the status option. It must already exist on the database’s status property.

FileObject

A file, either linked externally or hosted by Notion.

Field	Type	Description
`type`	`"external" \| "file" \| "file_upload"`	The type of this file object.
`external`	ExternalFileData	A file hosted somewhere else, referenced by URL.
`fileUpload`	FileUploadRef	A completed file upload to attach, referenced by its ID.
`name`	`string`	The name of the file, as shown in Notion. Required for an `external` entry in a files property; optional for a `file_upload`, which carries the name it was uploaded with.

ExternalFileData

A file Notion links to but does not host.

Field	Type	Description
`url` *	`string`	A link to the externally hosted content. Maximum 2000 characters. Notion does not copy the file, so the link must stay reachable. max length 2000

FileUploadRef

A completed file upload, by ID.

Field	Type	Description
`id` *	`string`	The ID of a completed File Upload object.

RelationRef

One related page, referenced by ID.

Field	Type	Description
`id` *	`string`	The ID of the related page.

VerificationValue

The verification state of a page in a wiki database.

Field	Type	Description
`state` *	`"verified" \| "unverified" \| "expired"`	The verification state of the page. `expired` is a state Notion moves a page into when its verification lapses; set `verified` or `unverified`.
`date`	DateValue	The date the page was verified and the date the verification expires. Only meaningful when `state` is `verified`.

Icon

A page, database or callout icon.

Field	Type	Description
`type`	`string`	The type of this icon. One of `emoji`, `external`, `file_upload`, `custom_emoji`, `icon`.
`emoji`	`string`	A standard emoji character, for example `🥬`.
`external`	ExternalFileData	An externally hosted image, referenced by URL.
`fileUpload`	FileUploadRef	A completed file upload to use as the icon.
`customEmoji`	CustomEmojiData	One of the workspace’s own uploaded emoji.
`icon`	NotionIconData	One of Notion’s own built-in icons.

CustomEmojiData

A workspace’s own uploaded emoji.

Field	Type	Description
`id` *	`string`	The ID of the custom emoji.

NotionIconData

One of Notion’s own built-in icons.

Field	Type	Description
`name` *	`string`	The name of the built-in Notion icon.
`color`	`string`	The color applied to the icon.

Cover

A page or database cover image.

Field	Type	Description
`type`	`"external" \| "file_upload"`	The type of this cover.
`external`	ExternalFileData	An externally hosted image, referenced by URL.
`fileUpload`	FileUploadRef	A completed file upload to use as the cover.

Block

One piece of content on a page.

Field	Type	Description
`object`	`string`	Always `block`.
`type`	`string`	Which kind of block this is. Returned on a read; on a write Notion infers it from whichever content field is set.
`code`	CodeContent	A block of code.
`equation`	EquationBlockContent	A standalone LaTeX equation.
`image`	MediaContent	An image.
`video`	MediaContent	A video.
`audio`	MediaContent	An audio clip.
`pdf`	MediaContent	A PDF.
`file`	FileBlockContent	A file attachment.
`embed`	EmbedContent	Third-party content rendered inline.
`bookmark`	BookmarkContent	A link rendered as a bookmark card.
`divider`	EmptyContent	A horizontal rule. Send an empty object.
`breadcrumb`	EmptyContent	The page’s ancestry. Send an empty object.
`tableOfContents`	TableOfContentsContent	A table of contents built from the page’s headings.
`tableRow`	TableRowContent	One row of a table.
`linkToPage`	LinkToPageContent	A link to another page, database or comment.
`paragraph`	BlockParagraphContent	A paragraph of text.
`heading1`	BlockHeadingContent	A top-level heading.
`heading2`	BlockHeadingContent	A second-level heading.
`heading3`	BlockHeadingContent	A third-level heading.
`heading4`	BlockHeadingContent	A fourth-level heading.
`bulletedListItem`	BlockTextContent	A bulleted list item.
`numberedListItem`	BlockNumberedListItemContent	A numbered list item.
`toDo`	BlockToDoContent	A checklist item.
`toggle`	BlockTextContent	A toggle, which collapses the blocks beneath it.
`quote`	BlockTextContent	A quotation.
`callout`	BlockCalloutContent	A callout — text in a tinted box with an icon.
`template`	BlockTemplateContent	A template button. Deprecated by Notion.
`syncedBlock`	BlockSyncedBlockContent	Content mirrored between two places.
`tab`	BlockTabContent	A set of tabs.
`table`	BlockTableContent	A table.
`columnList`	BlockColumnListContent	A row of side-by-side columns.
`column`	BlockColumnContent	One column of a column list.

CodeContent

A code block.

Field	Type	Description
`richText` *	RichText[]	The code, as rich text. max 100 items
`language` *	CodeLanguage	The language the code is highlighted as.
`caption`	RichText[]	The caption shown beneath the code. max 100 items

EquationBlockContent

A standalone LaTeX equation, as its own block.

Field	Type	Description
`expression` *	`string`	A KaTeX compatible string.

MediaContent

A file Notion embeds — an image, a video, an audio clip, a PDF or a file.

Field	Type	Description
`type`	`"external" \| "file" \| "file_upload"`	Where the file comes from.
`external`	ExternalFileData	A file hosted elsewhere, referenced by URL.
`fileUpload`	FileUploadRef	A completed file upload to attach, referenced by its ID.
`caption`	RichText[]	The caption shown beneath the media. max 100 items

FileBlockContent

A file attachment, which unlike other media carries a display name.

Field	Type	Description
`type`	`"external" \| "file" \| "file_upload"`	Where the file comes from.
`external`	ExternalFileData	A file hosted elsewhere, referenced by URL.
`fileUpload`	FileUploadRef	A completed file upload to attach, referenced by its ID.
`caption`	RichText[]	The caption shown beneath the media. max 100 items
`name`	`string`	The name of the file, as shown in Notion. max length 100

EmbedContent

Third-party content rendered inline.

Field	Type	Description
`url`	`string`	The link to the embedded content.
`fileUpload`	FileUploadRef	A completed file upload to embed. An uploaded `.html` file becomes an HTML embed.
`caption`	RichText[]	The caption shown with the embed. max 100 items

BookmarkContent

A link rendered as a bookmark card.

Field	Type	Description
`url` *	`string`	The link this bookmark points to.
`caption`	RichText[]	The caption shown with the bookmark. max 100 items

EmptyContent

A block with no content of its own — a divider or a breadcrumb. This object has no settable fields.

TableOfContentsContent

A table of contents, built from the page’s headings.

Field	Type	Description
`color`	NotionColor	The color of the block.

TableRowContent

One row of a table.

Field	Type	Description
`cells` *	`RichText`[][]	The row’s cells, left to right, each an array of rich text. The number of cells must equal the parent table’s `table_width`.

LinkToPageContent

A link to another page, database or comment in the workspace.

Field	Type	Description
`type`	`"page_id" \| "database_id" \| "comment_id"`	What kind of thing is linked to.
`pageId`	`string`	The ID of the linked page.
`databaseId`	`string`	The ID of the linked database.
`commentId`	`string`	The ID of the linked comment.

BlockParagraphContent

A top-level paragraph.

Field	Type	Description
`richText` *	RichText[]	The rich text displayed in the block. max 100 items
`color`	NotionColor	The color of the block.
`icon`	Icon	An icon shown beside the paragraph. Used when the paragraph is the direct child of a `tab` block, where it labels the tab.
`children`	NestedBlock[]	The nested child blocks. At most 100. max 100 items

NestedBlock

A block one level down from the top.

Field	Type	Description
`object`	`string`	Always `block`.
`type`	`string`	Which kind of block this is. Returned on a read; on a write Notion infers it from whichever content field is set.
`code`	CodeContent	A block of code.
`equation`	EquationBlockContent	A standalone LaTeX equation.
`image`	MediaContent	An image.
`video`	MediaContent	A video.
`audio`	MediaContent	An audio clip.
`pdf`	MediaContent	A PDF.
`file`	FileBlockContent	A file attachment.
`embed`	EmbedContent	Third-party content rendered inline.
`bookmark`	BookmarkContent	A link rendered as a bookmark card.
`divider`	EmptyContent	A horizontal rule. Send an empty object.
`breadcrumb`	EmptyContent	The page’s ancestry. Send an empty object.
`tableOfContents`	TableOfContentsContent	A table of contents built from the page’s headings.
`tableRow`	TableRowContent	One row of a table.
`linkToPage`	LinkToPageContent	A link to another page, database or comment.
`paragraph`	NestedParagraphContent	A paragraph of text.
`heading1`	NestedHeadingContent	A top-level heading.
`heading2`	NestedHeadingContent	A second-level heading.
`heading3`	NestedHeadingContent	A third-level heading.
`heading4`	NestedHeadingContent	A fourth-level heading.
`bulletedListItem`	NestedTextBlockContent	A bulleted list item.
`numberedListItem`	NestedNumberedListItemContent	A numbered list item.
`toDo`	NestedToDoContent	A checklist item.
`toggle`	NestedTextBlockContent	A toggle, which collapses the blocks beneath it.
`quote`	NestedTextBlockContent	A quotation.
`callout`	NestedCalloutContent	A callout — text in a tinted box with an icon.
`template`	NestedTemplateContent	A template button. Deprecated by Notion.
`syncedBlock`	NestedSyncedBlockContent	Content mirrored between two places.
`tab`	NestedTabContent	A set of tabs.
`table`	NestedTableContent	A table.

NestedParagraphContent

A paragraph one level down.

Field	Type	Description
`richText` *	RichText[]	The rich text displayed in the block. max 100 items
`color`	NotionColor	The color of the block.
`icon`	Icon	An icon shown beside the paragraph. Used when the paragraph is the direct child of a `tab` block, where it labels the tab.
`children`	LeafBlock[]	The nested child blocks. At most 100. max 100 items

LeafBlock

A block two levels down, which is as deep as one request goes.

Field	Type	Description
`object`	`string`	Always `block`.
`type`	`string`	Which kind of block this is. Returned on a read; on a write Notion infers it from whichever content field is set.
`code`	CodeContent	A block of code.
`equation`	EquationBlockContent	A standalone LaTeX equation.
`image`	MediaContent	An image.
`video`	MediaContent	A video.
`audio`	MediaContent	An audio clip.
`pdf`	MediaContent	A PDF.
`file`	FileBlockContent	A file attachment.
`embed`	EmbedContent	Third-party content rendered inline.
`bookmark`	BookmarkContent	A link rendered as a bookmark card.
`divider`	EmptyContent	A horizontal rule. Send an empty object.
`breadcrumb`	EmptyContent	The page’s ancestry. Send an empty object.
`tableOfContents`	TableOfContentsContent	A table of contents built from the page’s headings.
`tableRow`	TableRowContent	One row of a table.
`linkToPage`	LinkToPageContent	A link to another page, database or comment.
`paragraph`	ParagraphContent	A paragraph of text.
`heading1`	HeadingContent	A top-level heading.
`heading2`	HeadingContent	A second-level heading.
`heading3`	HeadingContent	A third-level heading.
`heading4`	HeadingContent	A fourth-level heading.
`bulletedListItem`	TextBlockContent	A bulleted list item.
`numberedListItem`	NumberedListItemContent	A numbered list item.
`toDo`	ToDoContent	A checklist item.
`toggle`	TextBlockContent	A toggle, which collapses the blocks beneath it.
`quote`	TextBlockContent	A quotation.
`callout`	CalloutContent	A callout — text in a tinted box with an icon.
`template`	TemplateContent	A template button. Deprecated by Notion.
`syncedBlock`	SyncedBlockContent	Content mirrored between two places.
`tab`	TabContent	A set of tabs.

ParagraphContent

A paragraph of rich text.

Field	Type	Description
`richText` *	RichText[]	The rich text displayed in the block. max 100 items
`color`	NotionColor	The color of the block.
`icon`	Icon	An icon shown beside the paragraph. Used when the paragraph is the direct child of a `tab` block, where it labels the tab.

HeadingContent

A heading, optionally collapsible.

Field	Type	Description
`richText` *	RichText[]	The rich text displayed in the block. max 100 items
`color`	NotionColor	The color of the block.
`isToggleable`	`boolean`	Whether the heading collapses to hide the blocks beneath it. A heading can only have children when this is true.

TextBlockContent

Rich text with a colour.

Field	Type	Description
`richText` *	RichText[]	The rich text displayed in the block. max 100 items
`color`	NotionColor	The color of the block.

NumberedListItemContent

A numbered list item.

Field	Type	Description
`richText` *	RichText[]	The rich text displayed in the block. max 100 items
`color`	NotionColor	The color of the block.

ToDoContent

A checklist item.

Field	Type	Description
`richText` *	RichText[]	The rich text displayed in the block. max 100 items
`color`	NotionColor	The color of the block.
`checked`	`boolean`	Whether the to-do is checked. Unchecked when absent.

CalloutContent

A callout — rich text in a tinted box with an icon.

Field	Type	Description
`richText` *	RichText[]	The rich text displayed in the block. max 100 items
`color`	NotionColor	The color of the block.
`icon`	Icon	The icon shown in the callout.

TemplateContent

A template button and the blocks it duplicates.

Field	Type	Description
`richText` *	RichText[]	The title of the template button. max 100 items

SyncedBlockContent

Content that appears in more than one place and stays in step.

Field	Type	Description
`syncedFrom` *	SyncedFromRef	The original this block mirrors, or null if this block is itself the original. Required either way.

SyncedFromRef

The original block a duplicate synced block mirrors.

Field	Type	Description
`type`	`string`	Always `block_id`.
`blockId` *	`string`	The ID of the original synced block.

TabContent

A set of tabs, whose children are the tabs themselves. This object has no settable fields.

NestedHeadingContent

A heading one level down.

Field	Type	Description
`richText` *	RichText[]	The rich text displayed in the block. max 100 items
`color`	NotionColor	The color of the block.
`isToggleable`	`boolean`	Whether the heading collapses to hide the blocks beneath it. A heading can only have children when this is true.
`children`	LeafBlock[]	The blocks the heading collapses, when `is_toggleable` is true. max 100 items

NestedTextBlockContent

A list item, quote or toggle one level down.

Field	Type	Description
`richText` *	RichText[]	The rich text displayed in the block. max 100 items
`color`	NotionColor	The color of the block.
`children`	LeafBlock[]	The nested child blocks. At most 100. max 100 items

NestedNumberedListItemContent

A numbered list item one level down.

Field	Type	Description
`richText` *	RichText[]	The rich text displayed in the block. max 100 items
`color`	NotionColor	The color of the block.
`children`	LeafBlock[]	The nested child blocks. At most 100. max 100 items

NestedToDoContent

A checklist item one level down.

Field	Type	Description
`richText` *	RichText[]	The rich text displayed in the block. max 100 items
`color`	NotionColor	The color of the block.
`checked`	`boolean`	Whether the to-do is checked. Unchecked when absent.
`children`	LeafBlock[]	The nested child blocks. At most 100. max 100 items

NestedCalloutContent

A callout one level down.

Field	Type	Description
`richText` *	RichText[]	The rich text displayed in the block. max 100 items
`color`	NotionColor	The color of the block.
`icon`	Icon	The icon shown in the callout.
`children`	LeafBlock[]	The nested child blocks. At most 100. max 100 items

NestedTemplateContent

A template button one level down.

Field	Type	Description
`richText` *	RichText[]	The title of the template button. max 100 items
`children`	LeafBlock[]	The blocks the button duplicates. max 100 items

NestedSyncedBlockContent

A synced block one level down.

Field	Type	Description
`syncedFrom` *	SyncedFromRef	The original this block mirrors, or null if this block is itself the original. Required either way.
`children`	LeafBlock[]	The synced content. Only set on the original, never on a duplicate. max 100 items

NestedTabContent

A set of tabs one level down.

Field	Type	Description
`children` *	LeafBlock[]	The tabs, each a `paragraph` block labelling and holding one tab. max 100 items

NestedTableContent

A table one level down.

Field	Type	Description
`tableWidth` *	`integer`	The number of columns. Fixed at creation — an update cannot change it. ≥ 1
`hasColumnHeader`	`boolean`	Whether the first row is styled as a header.
`hasRowHeader`	`boolean`	Whether the first column is styled as a header.
`children` *	LeafBlock[]	The table’s rows, each a `table_row` block whose `cells` count matches `table_width`. max 100 items

BlockHeadingContent

A top-level heading.

Field	Type	Description
`richText` *	RichText[]	The rich text displayed in the block. max 100 items
`color`	NotionColor	The color of the block.
`isToggleable`	`boolean`	Whether the heading collapses to hide the blocks beneath it. A heading can only have children when this is true.
`children`	NestedBlock[]	The blocks the heading collapses, when `is_toggleable` is true. max 100 items

BlockTextContent

A top-level list item, quote or toggle.

Field	Type	Description
`richText` *	RichText[]	The rich text displayed in the block. max 100 items
`color`	NotionColor	The color of the block.
`children`	NestedBlock[]	The nested child blocks. At most 100. max 100 items

BlockNumberedListItemContent

A top-level numbered list item.

Field	Type	Description
`richText` *	RichText[]	The rich text displayed in the block. max 100 items
`color`	NotionColor	The color of the block.
`children`	NestedBlock[]	The nested child blocks. At most 100. max 100 items

BlockToDoContent

A top-level checklist item.

Field	Type	Description
`richText` *	RichText[]	The rich text displayed in the block. max 100 items
`color`	NotionColor	The color of the block.
`checked`	`boolean`	Whether the to-do is checked. Unchecked when absent.
`children`	NestedBlock[]	The nested child blocks. At most 100. max 100 items

BlockCalloutContent

A top-level callout.

Field	Type	Description
`richText` *	RichText[]	The rich text displayed in the block. max 100 items
`color`	NotionColor	The color of the block.
`icon`	Icon	The icon shown in the callout.
`children`	NestedBlock[]	The nested child blocks. At most 100. max 100 items

BlockTemplateContent

A top-level template button.

Field	Type	Description
`richText` *	RichText[]	The title of the template button. max 100 items
`children`	NestedBlock[]	The blocks the button duplicates. max 100 items

BlockSyncedBlockContent

A top-level synced block.

Field	Type	Description
`syncedFrom` *	SyncedFromRef	The original this block mirrors, or null if this block is itself the original. Required either way.
`children`	NestedBlock[]	The synced content. Only set on the original, never on a duplicate. max 100 items

BlockTabContent

A top-level set of tabs.

Field	Type	Description
`children` *	NestedBlock[]	The tabs, each a `paragraph` block labelling and holding one tab. max 100 items

BlockTableContent

A top-level table.

Field	Type	Description
`tableWidth` *	`integer`	The number of columns. Fixed at creation — an update cannot change it. ≥ 1
`hasColumnHeader`	`boolean`	Whether the first row is styled as a header.
`hasRowHeader`	`boolean`	Whether the first column is styled as a header.
`children` *	NestedBlock[]	The table’s rows, each a `table_row` block whose `cells` count matches `table_width`. max 100 items

BlockColumnListContent

A top-level row of side-by-side columns.

Field	Type	Description
`children` *	NestedBlock[]	The columns, each a `column` block. A column list needs at least two. max 100 items

BlockColumnContent

One column of a top-level column list.

Field	Type	Description
`widthRatio`	`number`	This column’s share of the row’s width, between 0 and 1. The ratios across one column list should sum to 1; absent, the columns are equal. ≥ 0; ≤ 1
`children` *	NestedBlock[]	The blocks stacked in this column. max 100 items

Template

The template a new or updated page is built from.

Field	Type	Description
`type` *	`"none" \| "default" \| "template_id"`	Which template to apply: `none` for an empty page, `default` for the parent database’s default template, or `template_id` for a specific one.
`templateId`	`string`	The ID of the template page to apply, when `type` is `template_id`.
`timezone`	`string`	An IANA time zone name, for example `America/New_York`, used to resolve date placeholders in the template.

Position

Where new blocks are placed among a parent’s existing children.

Field	Type	Description
`type`	`"after_block" \| "page_start" \| "page_end"`	Where to insert the new content.
`afterBlock`	AfterBlockRef	The existing block to insert after, when `type` is `after_block`.

AfterBlockRef

The block that new content is inserted after.

Field	Type	Description
`id` *	`string`	The ID of the existing block to insert after.

PageUpdateBody

The body of an update-page request.

Field	Type	Description
`properties`	map of PagePropertyValue	The values of the page’s properties, keyed by property name or ID. A page whose parent is a data source must use that data source’s schema; a page whose parent is another page has only `title`. Set a value to null to clear it. Leave the computed types out of the map entirely rather than sending them as null.
`icon`	Icon	The page’s icon. Null removes it.
`cover`	Cover	The page’s cover image. Null removes it.
`inTrash`	`boolean`	Whether the page is in the trash. False restores it.
`isArchived`	`boolean`	Whether the page is archived. `in_trash` is the field to reach for; this is the older spelling and the API still accepts it.
`isLocked`	`boolean`	Whether the page is locked against editing in the Notion app. It does not block writes through the API.
`template`	Template	A template to apply to the page.
`eraseContent`	`boolean`	Whether to delete every block on the page.

PageMoveBody

The body of a move-page request.

Field	Type	Description
`parent` *	Parent	Where to move the page to.

PageMarkdownUpdateBody

The body of an update-page-markdown request.

Field	Type	Description
`type`	`"update_content" \| "replace_content" \| "insert_content" \| "replace_content_range"`	Which operation to perform.
`updateContent`	UpdateContentOp	Edit parts of the page by search and replace.
`replaceContent`	ReplaceContentOp	Replace the whole of the page’s content.
`allowAsync`	`boolean`	Whether a large edit may run in the background, answering 202 with an async task to poll rather than the finished page.

UpdateContentOp

Edit parts of a page, leaving the rest alone.

Field	Type	Description
`contentUpdates` *	ContentUpdate[]	The search-and-replace operations to apply, in order.
`allowDeletingContent`	`boolean`	Whether an edit may delete child pages or databases. Refused when absent, so a replacement that would remove one fails rather than doing it quietly.

ContentUpdate

One search-and-replace over a page’s Markdown.

Field	Type	Description
`oldStr` *	`string`	The existing content to find. It must match a unique stretch of the page, or the operation cannot tell which one you meant.
`newStr` *	`string`	What to put in its place.

ReplaceContentOp

Replace a page’s entire content.

Field	Type	Description
`newStr` *	`string`	The Markdown that becomes the whole of the page’s content.
`allowDeletingContent`	`boolean`	Whether the replacement may delete child pages or databases. Refused when absent.

NotionColor

Value
`default`
`default_background`
`blue`
`blue_background`
`brown`
`brown_background`
`gray`
`gray_background`
`green`
`green_background`
`orange`
`orange_background`
`pink`
`pink_background`
`purple`
`purple_background`
`red`
`red_background`
`yellow`
`yellow_background`

CodeLanguage

Value
`abap`
`abc`
`agda`
`arduino`
`ascii art`
`assembly`
`bash`
`basic`
`bnf`
`c`
`c#`
`c++`
`clojure`
`coffeescript`
`coq`
`css`
`dart`
`dhall`
`diff`
`docker`
`ebnf`
`elixir`
`elm`
`erlang`
`f#`
`flow`
`fortran`
`gherkin`
`glsl`
`go`
`graphql`
`groovy`
`haskell`
`hcl`
`html`
`idris`
`java`
`javascript`
`json`
`julia`
`kotlin`
`latex`
`less`
`lisp`
`livescript`
`llvm ir`
`lua`
`makefile`
`markdown`
`markup`
`matlab`
`mathematica`
`mermaid`
`nix`
`notion formula`
`objective-c`
`ocaml`
`pascal`
`perl`
`php`
`plain text`
`powershell`
`prolog`
`protobuf`
`purescript`
`python`
`r`
`racket`
`reason`
`ruby`
`rust`
`sass`
`scala`
`scheme`
`scss`
`shell`
`smalltalk`
`solidity`
`sql`
`swift`
`toml`
`typescript`
`vb.net`
`verilog`
`vhdl`
`visual basic`
`webassembly`
`xml`
`yaml`
`java/c/c++/c#`

​Model tree

​PageCreateBody

​Parent

​PagePropertyValue

​RichText

​TextContent

​TextLink

​Mention

​PartialUser

​PageRef

​DatabaseRef

​DateValue

​LinkPreviewRef

​TemplateMention

​EquationContent

​Annotations

​SelectValue

​StatusValue

​FileObject

​ExternalFileData

​FileUploadRef

​RelationRef

​VerificationValue

​Icon

​CustomEmojiData

​NotionIconData

​Cover

​Block

​CodeContent

​EquationBlockContent

​MediaContent

​FileBlockContent

​EmbedContent

​BookmarkContent

​EmptyContent

​TableOfContentsContent

​TableRowContent

​LinkToPageContent

​BlockParagraphContent

​NestedBlock

​NestedParagraphContent

​LeafBlock

​ParagraphContent

​HeadingContent

​TextBlockContent

​NumberedListItemContent

​ToDoContent

​CalloutContent

​TemplateContent

​SyncedBlockContent

​SyncedFromRef

​TabContent

​NestedHeadingContent

​NestedTextBlockContent

​NestedNumberedListItemContent

​NestedToDoContent

​NestedCalloutContent

​NestedTemplateContent

​NestedSyncedBlockContent

​NestedTabContent

​NestedTableContent

​BlockHeadingContent

​BlockTextContent

​BlockNumberedListItemContent

​BlockToDoContent

​BlockCalloutContent

​BlockTemplateContent

​BlockSyncedBlockContent

​BlockTabContent

​BlockTableContent

​BlockColumnListContent

​BlockColumnContent

​Template

​Position

​AfterBlockRef

​PageUpdateBody

​PageMoveBody

​PageMarkdownUpdateBody

​UpdateContentOp

​ContentUpdate

Model tree

PageCreateBody