Skip to content

Notion: Pages schemas (part 1)

66 Notion schemas with complete fields and constraints.

← Pages operations · All schemas

Create a page — request body — body content item

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternativeAdditional keys: not allowed
$ (anyOf 1).embedJSONRequired within parent
$ (anyOf 1).embed (anyOf 1)ModelAlternativeExpand Create a page — request body — body content item object block, type bookmark bookmark
$ (anyOf 1).embed (anyOf 2)ModelAlternativeExpand Create a page — request body — body content item object block, type embed embed type file upload
$ (anyOf 1).objectstringOptionalMust equal: block
$ (anyOf 1).typestringOptionalMust equal: embed
$ (anyOf 2)objectAlternativeAdditional keys: not allowed
$ (anyOf 2).bookmarkModelRequired within parentExpand Create a page — request body — body content item object block, type bookmark bookmark
$ (anyOf 2).objectstringOptionalMust equal: block
$ (anyOf 2).typestringOptionalMust equal: bookmark
$ (anyOf 3)objectAlternativeAdditional keys: not allowed
$ (anyOf 3).imageModelRequired within parentExpand Create a page — request body — body content item object block, type pdf pdf
$ (anyOf 3).objectstringOptionalMust equal: block
$ (anyOf 3).typestringOptionalMust equal: image
$ (anyOf 4)objectAlternativeAdditional keys: not allowed
$ (anyOf 4).objectstringOptionalMust equal: block
$ (anyOf 4).typestringOptionalMust equal: video
$ (anyOf 4).videoModelRequired within parentExpand Create a page — request body — body content item object block, type pdf pdf
$ (anyOf 5)objectAlternativeAdditional keys: not allowed
$ (anyOf 5).objectstringOptionalMust equal: block
$ (anyOf 5).pdfModelRequired within parentExpand Create a page — request body — body content item object block, type pdf pdf
$ (anyOf 5).typestringOptionalMust equal: pdf
$ (anyOf 6)objectAlternativeAdditional keys: not allowed
$ (anyOf 6).fileModelRequired within parentExpand Create a page — request body — body content item object block, type file file
$ (anyOf 6).objectstringOptionalMust equal: block
$ (anyOf 6).typestringOptionalMust equal: file
$ (anyOf 7)objectAlternativeAdditional keys: not allowed
$ (anyOf 7).audioModelRequired within parentExpand Create a page — request body — body content item object block, type pdf pdf
$ (anyOf 7).objectstringOptionalMust equal: block
$ (anyOf 7).typestringOptionalMust equal: audio
$ (anyOf 8)ModelAlternativeExpand Create a page — request body — body content item object block, type code
$ (anyOf 9)objectAlternativeAdditional keys: not allowed
$ (anyOf 9).equationModelRequired within parentExpand Update a block — request body — body value type equation equation
$ (anyOf 9).objectstringOptionalMust equal: block
$ (anyOf 9).typestringOptionalMust equal: equation
$ (anyOf 10)objectAlternativeAdditional keys: not allowed
$ (anyOf 10).dividerModelRequired within parentExpand Update a block — request body — body value type tab tab
$ (anyOf 10).objectstringOptionalMust equal: block
$ (anyOf 10).typestringOptionalMust equal: divider
$ (anyOf 11)objectAlternativeAdditional keys: not allowed
$ (anyOf 11).breadcrumbModelRequired within parentExpand Update a block — request body — body value type tab tab
$ (anyOf 11).objectstringOptionalMust equal: block
$ (anyOf 11).typestringOptionalMust equal: breadcrumb
$ (anyOf 12)objectAlternativeAdditional keys: not allowed
$ (anyOf 12).objectstringOptionalMust equal: block
$ (anyOf 12).tabModelRequired within parentExpand Create a page — request body — body content item object block, type tab tab
$ (anyOf 12).typestringOptionalMust equal: tab
$ (anyOf 13)objectAlternativeAdditional keys: not allowed
$ (anyOf 13).objectstringOptionalMust equal: block
$ (anyOf 13).table_of_contentsobjectRequired within parentAdditional keys: not allowed
$ (anyOf 13).table_of_contents.colorModelOptionalExpand Update a block — request body — body value type quote quote color
$ (anyOf 13).typestringOptionalMust equal: table_of_contents
$ (anyOf 14)ModelAlternativeExpand Create a page — request body — body content item object block, type link to page
$ (anyOf 15)objectAlternativeAdditional keys: not allowed
$ (anyOf 15).objectstringOptionalMust equal: block
$ (anyOf 15).table_rowModelRequired within parentExpand Update a block — request body — body value type table row table row
$ (anyOf 15).typestringOptionalMust equal: table_row
$ (anyOf 16)objectAlternativeAdditional keys: not allowed
$ (anyOf 16).objectstringOptionalMust equal: block
$ (anyOf 16).tableModelRequired within parentExpand Create a page — request body — body content item object block, type table table
$ (anyOf 16).typestringOptionalMust equal: table
$ (anyOf 17)objectAlternativeAdditional keys: not allowed
$ (anyOf 17).column_listModelRequired within parentExpand Create a page — request body — body content item object block, type column list column list
$ (anyOf 17).objectstringOptionalMust equal: block
$ (anyOf 17).typestringOptionalMust equal: column_list
$ (anyOf 18)objectAlternativeAdditional keys: not allowed
$ (anyOf 18).columnModelRequired within parentExpand Create a page — request body — body content item object block, type column column
$ (anyOf 18).objectstringOptionalMust equal: block
$ (anyOf 18).typestringOptionalMust equal: column
$ (anyOf 19)objectAlternativeAdditional keys: not allowed
$ (anyOf 19).heading_1objectRequired within parentAdditional keys: not allowed
$ (anyOf 19).heading_1.childrenarrayOptionalMaximum items: 100
$ (anyOf 19).heading_1.children[]ModelEach itemExpand Create a page — request body — body content item object block, type quote quote children item
$ (anyOf 19).heading_1.colorModelOptionalExpand Update a block — request body — body value type quote quote color
$ (anyOf 19).heading_1.is_toggleablebooleanOptional
$ (anyOf 19).heading_1.rich_textarrayRequired within parentMaximum items: 100
$ (anyOf 19).heading_1.rich_text[]ModelEach itemExpand Create a database — request body — body title item
$ (anyOf 19).objectstringOptionalMust equal: block
$ (anyOf 19).typestringOptionalMust equal: heading_1
$ (anyOf 20)objectAlternativeAdditional keys: not allowed
$ (anyOf 20).heading_2objectRequired within parentAdditional keys: not allowed
$ (anyOf 20).heading_2.childrenarrayOptionalMaximum items: 100
$ (anyOf 20).heading_2.children[]ModelEach itemExpand Create a page — request body — body content item object block, type quote quote children item
$ (anyOf 20).heading_2.colorModelOptionalExpand Update a block — request body — body value type quote quote color
$ (anyOf 20).heading_2.is_toggleablebooleanOptional
$ (anyOf 20).heading_2.rich_textarrayRequired within parentMaximum items: 100
$ (anyOf 20).heading_2.rich_text[]ModelEach itemExpand Create a database — request body — body title item
$ (anyOf 20).objectstringOptionalMust equal: block
$ (anyOf 20).typestringOptionalMust equal: heading_2
$ (anyOf 21)objectAlternativeAdditional keys: not allowed
$ (anyOf 21).heading_3objectRequired within parentAdditional keys: not allowed
$ (anyOf 21).heading_3.childrenarrayOptionalMaximum items: 100
$ (anyOf 21).heading_3.children[]ModelEach itemExpand Create a page — request body — body content item object block, type quote quote children item
$ (anyOf 21).heading_3.colorModelOptionalExpand Update a block — request body — body value type quote quote color
$ (anyOf 21).heading_3.is_toggleablebooleanOptional
$ (anyOf 21).heading_3.rich_textarrayRequired within parentMaximum items: 100
$ (anyOf 21).heading_3.rich_text[]ModelEach itemExpand Create a database — request body — body title item
$ (anyOf 21).objectstringOptionalMust equal: block
$ (anyOf 21).typestringOptionalMust equal: heading_3
$ (anyOf 22)objectAlternativeAdditional keys: not allowed
$ (anyOf 22).heading_4objectRequired within parentAdditional keys: not allowed
$ (anyOf 22).heading_4.childrenarrayOptionalMaximum items: 100
$ (anyOf 22).heading_4.children[]ModelEach itemExpand Create a page — request body — body content item object block, type quote quote children item
$ (anyOf 22).heading_4.colorModelOptionalExpand Update a block — request body — body value type quote quote color
$ (anyOf 22).heading_4.is_toggleablebooleanOptional
$ (anyOf 22).heading_4.rich_textarrayRequired within parentMaximum items: 100
$ (anyOf 22).heading_4.rich_text[]ModelEach itemExpand Create a database — request body — body title item
$ (anyOf 22).objectstringOptionalMust equal: block
$ (anyOf 22).typestringOptionalMust equal: heading_4
$ (anyOf 23)objectAlternativeAdditional keys: not allowed
$ (anyOf 23).objectstringOptionalMust equal: block
$ (anyOf 23).paragraphobjectRequired within parentAdditional keys: not allowed
$ (anyOf 23).paragraph.childrenarrayOptionalMaximum items: 100
$ (anyOf 23).paragraph.children[]ModelEach itemExpand Create a page — request body — body content item object block, type quote quote children item
$ (anyOf 23).paragraph.colorModelOptionalExpand Update a block — request body — body value type quote quote color
$ (anyOf 23).paragraph.iconModelOptionalExpand Create a database — request body — body icon
$ (anyOf 23).paragraph.rich_textarrayRequired within parentMaximum items: 100
$ (anyOf 23).paragraph.rich_text[]ModelEach itemExpand Create a database — request body — body title item
$ (anyOf 23).typestringOptionalMust equal: paragraph
$ (anyOf 24)objectAlternativeAdditional keys: not allowed
$ (anyOf 24).bulleted_list_itemobjectRequired within parentAdditional keys: not allowed
$ (anyOf 24).bulleted_list_item.childrenarrayOptionalMaximum items: 100
$ (anyOf 24).bulleted_list_item.children[]ModelEach itemExpand Create a page — request body — body content item object block, type quote quote children item
$ (anyOf 24).bulleted_list_item.colorModelOptionalExpand Update a block — request body — body value type quote quote color
$ (anyOf 24).bulleted_list_item.rich_textarrayRequired within parentMaximum items: 100
$ (anyOf 24).bulleted_list_item.rich_text[]ModelEach itemExpand Create a database — request body — body title item
$ (anyOf 24).objectstringOptionalMust equal: block
$ (anyOf 24).typestringOptionalMust equal: bulleted_list_item
$ (anyOf 25)objectAlternativeAdditional keys: not allowed
$ (anyOf 25).numbered_list_itemobjectRequired within parentAdditional keys: not allowed
$ (anyOf 25).numbered_list_item.childrenarrayOptionalMaximum items: 100
$ (anyOf 25).numbered_list_item.children[]ModelEach itemExpand Create a page — request body — body content item object block, type quote quote children item
$ (anyOf 25).numbered_list_item.colorModelOptionalExpand Update a block — request body — body value type quote quote color
$ (anyOf 25).numbered_list_item.rich_textarrayRequired within parentMaximum items: 100
$ (anyOf 25).numbered_list_item.rich_text[]ModelEach itemExpand Create a database — request body — body title item
$ (anyOf 25).objectstringOptionalMust equal: block
$ (anyOf 25).typestringOptionalMust equal: numbered_list_item
$ (anyOf 26)objectAlternativeAdditional keys: not allowed
$ (anyOf 26).objectstringOptionalMust equal: block
$ (anyOf 26).quoteobjectRequired within parentAdditional keys: not allowed
$ (anyOf 26).quote.childrenarrayOptionalMaximum items: 100
$ (anyOf 26).quote.children[]ModelEach itemExpand Create a page — request body — body content item object block, type quote quote children item
$ (anyOf 26).quote.colorModelOptionalExpand Update a block — request body — body value type quote quote color
$ (anyOf 26).quote.rich_textarrayRequired within parentMaximum items: 100
$ (anyOf 26).quote.rich_text[]ModelEach itemExpand Create a database — request body — body title item
$ (anyOf 26).typestringOptionalMust equal: quote
$ (anyOf 27)objectAlternativeAdditional keys: not allowed
$ (anyOf 27).objectstringOptionalMust equal: block
$ (anyOf 27).to_doobjectRequired within parentAdditional keys: not allowed
$ (anyOf 27).to_do.checkedbooleanOptional
$ (anyOf 27).to_do.childrenarrayOptionalMaximum items: 100
$ (anyOf 27).to_do.children[]ModelEach itemExpand Create a page — request body — body content item object block, type quote quote children item
$ (anyOf 27).to_do.colorModelOptionalExpand Update a block — request body — body value type quote quote color
$ (anyOf 27).to_do.rich_textarrayRequired within parentMaximum items: 100
$ (anyOf 27).to_do.rich_text[]ModelEach itemExpand Create a database — request body — body title item
$ (anyOf 27).typestringOptionalMust equal: to_do
$ (anyOf 28)objectAlternativeAdditional keys: not allowed
$ (anyOf 28).objectstringOptionalMust equal: block
$ (anyOf 28).toggleobjectRequired within parentAdditional keys: not allowed
$ (anyOf 28).toggle.childrenarrayOptionalMaximum items: 100
$ (anyOf 28).toggle.children[]ModelEach itemExpand Create a page — request body — body content item object block, type quote quote children item
$ (anyOf 28).toggle.colorModelOptionalExpand Update a block — request body — body value type quote quote color
$ (anyOf 28).toggle.rich_textarrayRequired within parentMaximum items: 100
$ (anyOf 28).toggle.rich_text[]ModelEach itemExpand Create a database — request body — body title item
$ (anyOf 28).typestringOptionalMust equal: toggle
$ (anyOf 29)objectAlternativeAdditional keys: not allowed
$ (anyOf 29).objectstringOptionalMust equal: block
$ (anyOf 29).templateobjectRequired within parentAdditional keys: not allowed
$ (anyOf 29).template.childrenarrayOptionalMaximum items: 100
$ (anyOf 29).template.children[]ModelEach itemExpand Create a page — request body — body content item object block, type quote quote children item
$ (anyOf 29).template.rich_textarrayRequired within parentMaximum items: 100
$ (anyOf 29).template.rich_text[]ModelEach itemExpand Create a database — request body — body title item
$ (anyOf 29).typestringOptionalMust equal: template
$ (anyOf 30)objectAlternativeAdditional keys: not allowed
$ (anyOf 30).calloutobjectRequired within parentAdditional keys: not allowed
$ (anyOf 30).callout.childrenarrayOptionalMaximum items: 100
$ (anyOf 30).callout.children[]ModelEach itemExpand Create a page — request body — body content item object block, type quote quote children item
$ (anyOf 30).callout.colorModelOptionalExpand Update a block — request body — body value type quote quote color
$ (anyOf 30).callout.iconModelOptionalExpand Create a database — request body — body icon
$ (anyOf 30).callout.rich_textarrayRequired within parentMaximum items: 100
$ (anyOf 30).callout.rich_text[]ModelEach itemExpand Create a database — request body — body title item
$ (anyOf 30).objectstringOptionalMust equal: block
$ (anyOf 30).typestringOptionalMust equal: callout
$ (anyOf 31)objectAlternativeAdditional keys: not allowed
$ (anyOf 31).objectstringOptionalMust equal: block
$ (anyOf 31).synced_blockobjectRequired within parentAdditional keys: not allowed
$ (anyOf 31).synced_block.childrenarrayOptionalMaximum items: 100
$ (anyOf 31).synced_block.children[]ModelEach itemExpand Create a page — request body — body content item object block, type quote quote children item
$ (anyOf 31).synced_block.synced_fromobject or nullRequired within parentAdditional keys: not allowed
$ (anyOf 31).synced_block.synced_from.block_idstringRequired within parent
$ (anyOf 31).synced_block.synced_from.typestringOptionalMust equal: block_id
$ (anyOf 31).typestringOptionalMust equal: synced_block

Referenced models: Update a block — request body — body value type quote quote color, Update a block — request body — body value type tab tab, Create a page — request body — body content item object block, type quote quote children item, Create a page — request body — body content item object block, type column list column list, Create a page — request body — body content item object block, type column column, Update a block — request body — body value type equation equation, Update a block — request body — body value type table row table row, Create a page — request body — body content item object block, type embed embed type file upload, Create a page — request body — body content item object block, type pdf pdf, Create a page — request body — body content item object block, type file file, Create a page — request body — body content item object block, type bookmark bookmark, Create a database — request body — body icon, Create a database — request body — body title item, Create a page — request body — body content item object block, type link to page, Create a page — request body — body content item object block, type code, Create a page — request body — body content item object block, type tab tab, Create a page — request body — body content item object block, type table table

Create a page — request body — body content item object block, type bookmark bookmark

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
captionarrayOptionalMaximum items: 100
caption[]ModelEach itemExpand Create a database — request body — body title item
urlstringRequired within parent

Referenced models: Create a database — request body — body title item

Create a page — request body — body content item object block, type code

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
codeobjectRequired within parentAdditional keys: not allowed
code.captionarrayOptionalMaximum items: 100
code.caption[]ModelEach itemExpand Create a database — request body — body title item
code.languageModelRequired within parentExpand Update a block — request body — body value type code code language
code.rich_textarrayRequired within parentMaximum items: 100
code.rich_text[]ModelEach itemExpand Create a database — request body — body title item
objectstringOptionalMust equal: block
typestringOptionalMust equal: code

Referenced models: Update a block — request body — body value type code code language, Create a database — request body — body title item

Create a page — request body — body content item object block, type column column

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
childrenarrayRequired within parentMaximum items: 100
children[]ModelEach itemExpand Create a page — request body — body content item object block, type quote quote children item
width_rationumberOptionalRatio between 0 and 1 of the width of this column relative to all columns in the list. If not provided, uses an equal width.
Less than: 1
Greater than: 0

Referenced models: Create a page — request body — body content item object block, type quote quote children item

Create a page — request body — body content item object block, type column list column list

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
childrenarrayRequired within parentMaximum items: 100
Minimum items: 2
children[]ModelEach itemExpand Create a page — request body — body content item object block, type column list column list children item

Referenced models: Create a page — request body — body content item object block, type column list column list children item

Create a page — request body — body content item object block, type column list column list children item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
columnModelRequired within parentExpand Create a page — request body — body content item object block, type column column
objectstringOptionalMust equal: block
typestringOptionalMust equal: column

Referenced models: Create a page — request body — body content item object block, type column column

Create a page — request body — body content item object block, type embed embed type file upload

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
captionarrayOptionalMaximum items: 100
caption[]ModelEach itemExpand Create a database — request body — body title item
file_uploadModelRequired within parentExpand Update a block — request body — body value type pdf pdf file upload
typestringOptionalMust equal: file_upload

Referenced models: Update a block — request body — body value type pdf pdf file upload, Create a database — request body — body title item

Create a page — request body — body content item object block, type file file

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternativeAdditional keys: not allowed
$ (anyOf 1).captionarrayOptionalMaximum items: 100
$ (anyOf 1).caption[]ModelEach itemExpand Create a database — request body — body title item
$ (anyOf 1).externalModelRequired within parentExpand Update a block — request body — body value type pdf pdf external
$ (anyOf 1).namestringOptionalMaximum length: 100
Minimum length: 1
$ (anyOf 1).typestringOptionalMust equal: external
$ (anyOf 2)objectAlternativeAdditional keys: not allowed
$ (anyOf 2).captionarrayOptionalMaximum items: 100
$ (anyOf 2).caption[]ModelEach itemExpand Create a database — request body — body title item
$ (anyOf 2).file_uploadModelRequired within parentExpand Update a block — request body — body value type pdf pdf file upload
$ (anyOf 2).namestringOptionalMaximum length: 100
Minimum length: 1
$ (anyOf 2).typestringOptionalMust equal: file_upload

Referenced models: Update a block — request body — body value type pdf pdf external, Update a block — request body — body value type pdf pdf file upload, Create a database — request body — body title item

Create a page — request body — body content item object block, type link to page

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
link_to_pageJSONRequired within parent
link_to_page (anyOf 1)objectAlternativeAdditional keys: not allowed
link_to_page (anyOf 1).page_idstringRequired within parent
link_to_page (anyOf 1).typestringOptionalMust equal: page_id
link_to_page (anyOf 2)objectAlternativeAdditional keys: not allowed
link_to_page (anyOf 2).database_idstringRequired within parent
link_to_page (anyOf 2).typestringOptionalMust equal: database_id
link_to_page (anyOf 3)objectAlternativeAdditional keys: not allowed
link_to_page (anyOf 3).comment_idstringRequired within parent
link_to_page (anyOf 3).typestringOptionalMust equal: comment_id
objectstringOptionalMust equal: block
typestringOptionalMust equal: link_to_page

Create a page — request body — body content item object block, type pdf pdf

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternativeAdditional keys: not allowed
$ (anyOf 1).captionarrayOptionalMaximum items: 100
$ (anyOf 1).caption[]ModelEach itemExpand Create a database — request body — body title item
$ (anyOf 1).externalModelRequired within parentExpand Update a block — request body — body value type pdf pdf external
$ (anyOf 1).typestringOptionalMust equal: external
$ (anyOf 2)objectAlternativeAdditional keys: not allowed
$ (anyOf 2).captionarrayOptionalMaximum items: 100
$ (anyOf 2).caption[]ModelEach itemExpand Create a database — request body — body title item
$ (anyOf 2).file_uploadModelRequired within parentExpand Update a block — request body — body value type pdf pdf file upload
$ (anyOf 2).typestringOptionalMust equal: file_upload

Referenced models: Update a block — request body — body value type pdf pdf external, Update a block — request body — body value type pdf pdf file upload, Create a database — request body — body title item

Create a page — request body — body content item object block, type quote quote children item

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternativeAdditional keys: not allowed
$ (anyOf 1).embedJSONRequired within parent
$ (anyOf 1).embed (anyOf 1)ModelAlternativeExpand Create a page — request body — body content item object block, type bookmark bookmark
$ (anyOf 1).embed (anyOf 2)ModelAlternativeExpand Create a page — request body — body content item object block, type embed embed type file upload
$ (anyOf 1).objectstringOptionalMust equal: block
$ (anyOf 1).typestringOptionalMust equal: embed
$ (anyOf 2)objectAlternativeAdditional keys: not allowed
$ (anyOf 2).bookmarkModelRequired within parentExpand Create a page — request body — body content item object block, type bookmark bookmark
$ (anyOf 2).objectstringOptionalMust equal: block
$ (anyOf 2).typestringOptionalMust equal: bookmark
$ (anyOf 3)objectAlternativeAdditional keys: not allowed
$ (anyOf 3).imageModelRequired within parentExpand Create a page — request body — body content item object block, type pdf pdf
$ (anyOf 3).objectstringOptionalMust equal: block
$ (anyOf 3).typestringOptionalMust equal: image
$ (anyOf 4)objectAlternativeAdditional keys: not allowed
$ (anyOf 4).objectstringOptionalMust equal: block
$ (anyOf 4).typestringOptionalMust equal: video
$ (anyOf 4).videoModelRequired within parentExpand Create a page — request body — body content item object block, type pdf pdf
$ (anyOf 5)objectAlternativeAdditional keys: not allowed
$ (anyOf 5).objectstringOptionalMust equal: block
$ (anyOf 5).pdfModelRequired within parentExpand Create a page — request body — body content item object block, type pdf pdf
$ (anyOf 5).typestringOptionalMust equal: pdf
$ (anyOf 6)objectAlternativeAdditional keys: not allowed
$ (anyOf 6).fileModelRequired within parentExpand Create a page — request body — body content item object block, type file file
$ (anyOf 6).objectstringOptionalMust equal: block
$ (anyOf 6).typestringOptionalMust equal: file
$ (anyOf 7)objectAlternativeAdditional keys: not allowed
$ (anyOf 7).audioModelRequired within parentExpand Create a page — request body — body content item object block, type pdf pdf
$ (anyOf 7).objectstringOptionalMust equal: block
$ (anyOf 7).typestringOptionalMust equal: audio
$ (anyOf 8)ModelAlternativeExpand Create a page — request body — body content item object block, type code
$ (anyOf 9)objectAlternativeAdditional keys: not allowed
$ (anyOf 9).equationModelRequired within parentExpand Update a block — request body — body value type equation equation
$ (anyOf 9).objectstringOptionalMust equal: block
$ (anyOf 9).typestringOptionalMust equal: equation
$ (anyOf 10)objectAlternativeAdditional keys: not allowed
$ (anyOf 10).dividerModelRequired within parentExpand Update a block — request body — body value type tab tab
$ (anyOf 10).objectstringOptionalMust equal: block
$ (anyOf 10).typestringOptionalMust equal: divider
$ (anyOf 11)objectAlternativeAdditional keys: not allowed
$ (anyOf 11).breadcrumbModelRequired within parentExpand Update a block — request body — body value type tab tab
$ (anyOf 11).objectstringOptionalMust equal: block
$ (anyOf 11).typestringOptionalMust equal: breadcrumb
$ (anyOf 12)objectAlternativeAdditional keys: not allowed
$ (anyOf 12).objectstringOptionalMust equal: block
$ (anyOf 12).tabModelRequired within parentExpand Create a page — request body — body content item object block, type quote quote children item object block, type tab tab
$ (anyOf 12).typestringOptionalMust equal: tab
$ (anyOf 13)objectAlternativeAdditional keys: not allowed
$ (anyOf 13).objectstringOptionalMust equal: block
$ (anyOf 13).table_of_contentsobjectRequired within parentAdditional keys: not allowed
$ (anyOf 13).table_of_contents.colorModelOptionalExpand Update a block — request body — body value type quote quote color
$ (anyOf 13).typestringOptionalMust equal: table_of_contents
$ (anyOf 14)ModelAlternativeExpand Create a page — request body — body content item object block, type link to page
$ (anyOf 15)objectAlternativeAdditional keys: not allowed
$ (anyOf 15).objectstringOptionalMust equal: block
$ (anyOf 15).table_rowModelRequired within parentExpand Update a block — request body — body value type table row table row
$ (anyOf 15).typestringOptionalMust equal: table_row
$ (anyOf 16)objectAlternativeAdditional keys: not allowed
$ (anyOf 16).heading_1ModelRequired within parentExpand Create a page — request body — body content item object block, type quote quote children item object block, type heading 1 heading 1
$ (anyOf 16).objectstringOptionalMust equal: block
$ (anyOf 16).typestringOptionalMust equal: heading_1
$ (anyOf 17)objectAlternativeAdditional keys: not allowed
$ (anyOf 17).heading_2ModelRequired within parentExpand Create a page — request body — body content item object block, type quote quote children item object block, type heading 1 heading 1
$ (anyOf 17).objectstringOptionalMust equal: block
$ (anyOf 17).typestringOptionalMust equal: heading_2
$ (anyOf 18)objectAlternativeAdditional keys: not allowed
$ (anyOf 18).heading_3ModelRequired within parentExpand Create a page — request body — body content item object block, type quote quote children item object block, type heading 1 heading 1
$ (anyOf 18).objectstringOptionalMust equal: block
$ (anyOf 18).typestringOptionalMust equal: heading_3
$ (anyOf 19)objectAlternativeAdditional keys: not allowed
$ (anyOf 19).heading_4ModelRequired within parentExpand Create a page — request body — body content item object block, type quote quote children item object block, type heading 1 heading 1
$ (anyOf 19).objectstringOptionalMust equal: block
$ (anyOf 19).typestringOptionalMust equal: heading_4
$ (anyOf 20)objectAlternativeAdditional keys: not allowed
$ (anyOf 20).objectstringOptionalMust equal: block
$ (anyOf 20).paragraphModelRequired within parentExpand Create a page — request body — body content item object block, type tab tab children item paragraph
$ (anyOf 20).typestringOptionalMust equal: paragraph
$ (anyOf 21)objectAlternativeAdditional keys: not allowed
$ (anyOf 21).bulleted_list_itemModelRequired within parentExpand Create a page — request body — body content item object block, type quote quote children item object block, type quote quote
$ (anyOf 21).objectstringOptionalMust equal: block
$ (anyOf 21).typestringOptionalMust equal: bulleted_list_item
$ (anyOf 22)objectAlternativeAdditional keys: not allowed
$ (anyOf 22).numbered_list_itemModelRequired within parentExpand Create a page — request body — body content item object block, type quote quote children item object block, type quote quote
$ (anyOf 22).objectstringOptionalMust equal: block
$ (anyOf 22).typestringOptionalMust equal: numbered_list_item
$ (anyOf 23)objectAlternativeAdditional keys: not allowed
$ (anyOf 23).objectstringOptionalMust equal: block
$ (anyOf 23).quoteModelRequired within parentExpand Create a page — request body — body content item object block, type quote quote children item object block, type quote quote
$ (anyOf 23).typestringOptionalMust equal: quote
$ (anyOf 24)objectAlternativeAdditional keys: not allowed
$ (anyOf 24).objectstringOptionalMust equal: block
$ (anyOf 24).tableModelRequired within parentExpand Create a page — request body — body content item object block, type table table
$ (anyOf 24).typestringOptionalMust equal: table
$ (anyOf 25)objectAlternativeAdditional keys: not allowed
$ (anyOf 25).objectstringOptionalMust equal: block
$ (anyOf 25).to_doobjectRequired within parentAdditional keys: not allowed
$ (anyOf 25).to_do.checkedbooleanOptional
$ (anyOf 25).to_do.childrenarrayOptionalMaximum items: 100
$ (anyOf 25).to_do.children[]ModelEach itemExpand Create a page — request body — body content item object block, type tab tab children item paragraph children item
$ (anyOf 25).to_do.colorModelOptionalExpand Update a block — request body — body value type quote quote color
$ (anyOf 25).to_do.rich_textarrayRequired within parentMaximum items: 100
$ (anyOf 25).to_do.rich_text[]ModelEach itemExpand Create a database — request body — body title item
$ (anyOf 25).typestringOptionalMust equal: to_do
$ (anyOf 26)objectAlternativeAdditional keys: not allowed
$ (anyOf 26).objectstringOptionalMust equal: block
$ (anyOf 26).toggleModelRequired within parentExpand Create a page — request body — body content item object block, type quote quote children item object block, type quote quote
$ (anyOf 26).typestringOptionalMust equal: toggle
$ (anyOf 27)objectAlternativeAdditional keys: not allowed
$ (anyOf 27).objectstringOptionalMust equal: block
$ (anyOf 27).templateobjectRequired within parentAdditional keys: not allowed
$ (anyOf 27).template.childrenarrayOptionalMaximum items: 100
$ (anyOf 27).template.children[]ModelEach itemExpand Create a page — request body — body content item object block, type tab tab children item paragraph children item
$ (anyOf 27).template.rich_textarrayRequired within parentMaximum items: 100
$ (anyOf 27).template.rich_text[]ModelEach itemExpand Create a database — request body — body title item
$ (anyOf 27).typestringOptionalMust equal: template
$ (anyOf 28)objectAlternativeAdditional keys: not allowed
$ (anyOf 28).calloutobjectRequired within parentAdditional keys: not allowed
$ (anyOf 28).callout.childrenarrayOptionalMaximum items: 100
$ (anyOf 28).callout.children[]ModelEach itemExpand Create a page — request body — body content item object block, type tab tab children item paragraph children item
$ (anyOf 28).callout.colorModelOptionalExpand Update a block — request body — body value type quote quote color
$ (anyOf 28).callout.iconModelOptionalExpand Create a database — request body — body icon
$ (anyOf 28).callout.rich_textarrayRequired within parentMaximum items: 100
$ (anyOf 28).callout.rich_text[]ModelEach itemExpand Create a database — request body — body title item
$ (anyOf 28).objectstringOptionalMust equal: block
$ (anyOf 28).typestringOptionalMust equal: callout
$ (anyOf 29)objectAlternativeAdditional keys: not allowed
$ (anyOf 29).objectstringOptionalMust equal: block
$ (anyOf 29).synced_blockobjectRequired within parentAdditional keys: not allowed
$ (anyOf 29).synced_block.childrenarrayOptionalMaximum items: 100
$ (anyOf 29).synced_block.children[]ModelEach itemExpand Create a page — request body — body content item object block, type tab tab children item paragraph children item
$ (anyOf 29).synced_block.synced_fromobject or nullRequired within parentAdditional keys: not allowed
$ (anyOf 29).synced_block.synced_from.block_idstringRequired within parent
$ (anyOf 29).synced_block.synced_from.typestringOptionalMust equal: block_id
$ (anyOf 29).typestringOptionalMust equal: synced_block

Referenced models: Update a block — request body — body value type quote quote color, Update a block — request body — body value type tab tab, Create a page — request body — body content item object block, type tab tab children item paragraph children item, Update a block — request body — body value type equation equation, Create a page — request body — body content item object block, type quote quote children item object block, type quote quote, Update a block — request body — body value type table row table row, Create a page — request body — body content item object block, type embed embed type file upload, Create a page — request body — body content item object block, type quote quote children item object block, type heading 1 heading 1, Create a page — request body — body content item object block, type pdf pdf, Create a page — request body — body content item object block, type file file, Create a page — request body — body content item object block, type bookmark bookmark, Create a database — request body — body icon, Create a page — request body — body content item object block, type tab tab children item paragraph, Create a database — request body — body title item, Create a page — request body — body content item object block, type link to page, Create a page — request body — body content item object block, type code, Create a page — request body — body content item object block, type quote quote children item object block, type tab tab, Create a page — request body — body content item object block, type table table

Create a page — request body — body content item object block, type quote quote children item object block, type heading 1 heading 1

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
childrenarrayOptionalMaximum items: 100
children[]ModelEach itemExpand Create a page — request body — body content item object block, type tab tab children item paragraph children item
colorModelOptionalExpand Update a block — request body — body value type quote quote color
is_toggleablebooleanOptional
rich_textarrayRequired within parentMaximum items: 100
rich_text[]ModelEach itemExpand Create a database — request body — body title item

Referenced models: Update a block — request body — body value type quote quote color, Create a page — request body — body content item object block, type tab tab children item paragraph children item, Create a database — request body — body title item

Create a page — request body — body content item object block, type quote quote children item object block, type quote quote

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
childrenarrayOptionalMaximum items: 100
children[]ModelEach itemExpand Create a page — request body — body content item object block, type tab tab children item paragraph children item
colorModelOptionalExpand Update a block — request body — body value type quote quote color
rich_textarrayRequired within parentMaximum items: 100
rich_text[]ModelEach itemExpand Create a database — request body — body title item

Referenced models: Update a block — request body — body value type quote quote color, Create a page — request body — body content item object block, type tab tab children item paragraph children item, Create a database — request body — body title item

Create a page — request body — body content item object block, type quote quote children item object block, type tab tab

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
childrenarrayRequired within parentMaximum items: 100
Minimum items: 1
children[]ModelEach itemExpand Create a page — request body — body content item object block, type quote quote children item object block, type tab tab children item

Referenced models: Create a page — request body — body content item object block, type quote quote children item object block, type tab tab children item

Create a page — request body — body content item object block, type quote quote children item object block, type tab tab children item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
objectstringOptionalMust equal: block
paragraphModelRequired within parentExpand Create a page — request body — body content item object block, type quote quote children item object block, type tab tab children item paragraph
typestringOptionalMust equal: paragraph

Referenced models: Create a page — request body — body content item object block, type quote quote children item object block, type tab tab children item paragraph

Create a page — request body — body content item object block, type quote quote children item object block, type tab tab children item paragraph

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
colorModelOptionalExpand Update a block — request body — body value type quote quote color
iconModelOptionalExpand Create a database — request body — body icon
rich_textarrayRequired within parentMaximum items: 100
rich_text[]ModelEach itemExpand Create a database — request body — body title item

Referenced models: Update a block — request body — body value type quote quote color, Create a database — request body — body icon, Create a database — request body — body title item

Create a page — request body — body content item object block, type tab tab

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
childrenarrayRequired within parentMaximum items: 100
Minimum items: 1
children[]ModelEach itemExpand Create a page — request body — body content item object block, type tab tab children item

Referenced models: Create a page — request body — body content item object block, type tab tab children item

Create a page — request body — body content item object block, type tab tab children item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
objectstringOptionalMust equal: block
paragraphModelRequired within parentExpand Create a page — request body — body content item object block, type tab tab children item paragraph
typestringOptionalMust equal: paragraph

Referenced models: Create a page — request body — body content item object block, type tab tab children item paragraph

Create a page — request body — body content item object block, type tab tab children item paragraph

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
childrenarrayOptionalMaximum items: 100
children[]ModelEach itemExpand Create a page — request body — body content item object block, type tab tab children item paragraph children item
colorModelOptionalExpand Update a block — request body — body value type quote quote color
iconModelOptionalExpand Create a database — request body — body icon
rich_textarrayRequired within parentMaximum items: 100
rich_text[]ModelEach itemExpand Create a database — request body — body title item

Referenced models: Update a block — request body — body value type quote quote color, Create a page — request body — body content item object block, type tab tab children item paragraph children item, Create a database — request body — body icon, Create a database — request body — body title item

Create a page — request body — body content item object block, type tab tab children item paragraph children item

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternativeAdditional keys: not allowed
$ (anyOf 1).embedJSONRequired within parent
$ (anyOf 1).embed (anyOf 1)ModelAlternativeExpand Create a page — request body — body content item object block, type bookmark bookmark
$ (anyOf 1).embed (anyOf 2)ModelAlternativeExpand Create a page — request body — body content item object block, type embed embed type file upload
$ (anyOf 1).objectstringOptionalMust equal: block
$ (anyOf 1).typestringOptionalMust equal: embed
$ (anyOf 2)objectAlternativeAdditional keys: not allowed
$ (anyOf 2).bookmarkModelRequired within parentExpand Create a page — request body — body content item object block, type bookmark bookmark
$ (anyOf 2).objectstringOptionalMust equal: block
$ (anyOf 2).typestringOptionalMust equal: bookmark
$ (anyOf 3)objectAlternativeAdditional keys: not allowed
$ (anyOf 3).imageModelRequired within parentExpand Create a page — request body — body content item object block, type pdf pdf
$ (anyOf 3).objectstringOptionalMust equal: block
$ (anyOf 3).typestringOptionalMust equal: image
$ (anyOf 4)objectAlternativeAdditional keys: not allowed
$ (anyOf 4).objectstringOptionalMust equal: block
$ (anyOf 4).typestringOptionalMust equal: video
$ (anyOf 4).videoModelRequired within parentExpand Create a page — request body — body content item object block, type pdf pdf
$ (anyOf 5)objectAlternativeAdditional keys: not allowed
$ (anyOf 5).objectstringOptionalMust equal: block
$ (anyOf 5).pdfModelRequired within parentExpand Create a page — request body — body content item object block, type pdf pdf
$ (anyOf 5).typestringOptionalMust equal: pdf
$ (anyOf 6)objectAlternativeAdditional keys: not allowed
$ (anyOf 6).fileModelRequired within parentExpand Create a page — request body — body content item object block, type file file
$ (anyOf 6).objectstringOptionalMust equal: block
$ (anyOf 6).typestringOptionalMust equal: file
$ (anyOf 7)objectAlternativeAdditional keys: not allowed
$ (anyOf 7).audioModelRequired within parentExpand Create a page — request body — body content item object block, type pdf pdf
$ (anyOf 7).objectstringOptionalMust equal: block
$ (anyOf 7).typestringOptionalMust equal: audio
$ (anyOf 8)ModelAlternativeExpand Create a page — request body — body content item object block, type code
$ (anyOf 9)objectAlternativeAdditional keys: not allowed
$ (anyOf 9).equationModelRequired within parentExpand Update a block — request body — body value type equation equation
$ (anyOf 9).objectstringOptionalMust equal: block
$ (anyOf 9).typestringOptionalMust equal: equation
$ (anyOf 10)objectAlternativeAdditional keys: not allowed
$ (anyOf 10).dividerModelRequired within parentExpand Update a block — request body — body value type tab tab
$ (anyOf 10).objectstringOptionalMust equal: block
$ (anyOf 10).typestringOptionalMust equal: divider
$ (anyOf 11)objectAlternativeAdditional keys: not allowed
$ (anyOf 11).breadcrumbModelRequired within parentExpand Update a block — request body — body value type tab tab
$ (anyOf 11).objectstringOptionalMust equal: block
$ (anyOf 11).typestringOptionalMust equal: breadcrumb
$ (anyOf 12)objectAlternativeAdditional keys: not allowed
$ (anyOf 12).objectstringOptionalMust equal: block
$ (anyOf 12).tabModelRequired within parentExpand Update a block — request body — body value type tab tab
$ (anyOf 12).typestringOptionalMust equal: tab
$ (anyOf 13)objectAlternativeAdditional keys: not allowed
$ (anyOf 13).objectstringOptionalMust equal: block
$ (anyOf 13).table_of_contentsobjectRequired within parentAdditional keys: not allowed
$ (anyOf 13).table_of_contents.colorModelOptionalExpand Update a block — request body — body value type quote quote color
$ (anyOf 13).typestringOptionalMust equal: table_of_contents
$ (anyOf 14)ModelAlternativeExpand Create a page — request body — body content item object block, type link to page
$ (anyOf 15)objectAlternativeAdditional keys: not allowed
$ (anyOf 15).objectstringOptionalMust equal: block
$ (anyOf 15).table_rowModelRequired within parentExpand Update a block — request body — body value type table row table row
$ (anyOf 15).typestringOptionalMust equal: table_row
$ (anyOf 16)objectAlternativeAdditional keys: not allowed
$ (anyOf 16).heading_1ModelRequired within parentExpand Update a block — request body — body value type heading 1 heading 1
$ (anyOf 16).objectstringOptionalMust equal: block
$ (anyOf 16).typestringOptionalMust equal: heading_1
$ (anyOf 17)objectAlternativeAdditional keys: not allowed
$ (anyOf 17).heading_2ModelRequired within parentExpand Update a block — request body — body value type heading 1 heading 1
$ (anyOf 17).objectstringOptionalMust equal: block
$ (anyOf 17).typestringOptionalMust equal: heading_2
$ (anyOf 18)objectAlternativeAdditional keys: not allowed
$ (anyOf 18).heading_3ModelRequired within parentExpand Update a block — request body — body value type heading 1 heading 1
$ (anyOf 18).objectstringOptionalMust equal: block
$ (anyOf 18).typestringOptionalMust equal: heading_3
$ (anyOf 19)objectAlternativeAdditional keys: not allowed
$ (anyOf 19).heading_4ModelRequired within parentExpand Update a block — request body — body value type heading 1 heading 1
$ (anyOf 19).objectstringOptionalMust equal: block
$ (anyOf 19).typestringOptionalMust equal: heading_4
$ (anyOf 20)objectAlternativeAdditional keys: not allowed
$ (anyOf 20).objectstringOptionalMust equal: block
$ (anyOf 20).paragraphModelRequired within parentExpand Create a page — request body — body content item object block, type quote quote children item object block, type tab tab children item paragraph
$ (anyOf 20).typestringOptionalMust equal: paragraph
$ (anyOf 21)objectAlternativeAdditional keys: not allowed
$ (anyOf 21).bulleted_list_itemModelRequired within parentExpand Update a block — request body — body value type quote quote
$ (anyOf 21).objectstringOptionalMust equal: block
$ (anyOf 21).typestringOptionalMust equal: bulleted_list_item
$ (anyOf 22)objectAlternativeAdditional keys: not allowed
$ (anyOf 22).numbered_list_itemModelRequired within parentExpand Update a block — request body — body value type quote quote
$ (anyOf 22).objectstringOptionalMust equal: block
$ (anyOf 22).typestringOptionalMust equal: numbered_list_item
$ (anyOf 23)objectAlternativeAdditional keys: not allowed
$ (anyOf 23).objectstringOptionalMust equal: block
$ (anyOf 23).quoteModelRequired within parentExpand Update a block — request body — body value type quote quote
$ (anyOf 23).typestringOptionalMust equal: quote
$ (anyOf 24)objectAlternativeAdditional keys: not allowed
$ (anyOf 24).objectstringOptionalMust equal: block
$ (anyOf 24).to_doobjectRequired within parentAdditional keys: not allowed
$ (anyOf 24).to_do.checkedbooleanOptional
$ (anyOf 24).to_do.colorModelOptionalExpand Update a block — request body — body value type quote quote color
$ (anyOf 24).to_do.rich_textarrayRequired within parentMaximum items: 100
$ (anyOf 24).to_do.rich_text[]ModelEach itemExpand Create a database — request body — body title item
$ (anyOf 24).typestringOptionalMust equal: to_do
$ (anyOf 25)objectAlternativeAdditional keys: not allowed
$ (anyOf 25).objectstringOptionalMust equal: block
$ (anyOf 25).toggleModelRequired within parentExpand Update a block — request body — body value type quote quote
$ (anyOf 25).typestringOptionalMust equal: toggle
$ (anyOf 26)objectAlternativeAdditional keys: not allowed
$ (anyOf 26).objectstringOptionalMust equal: block
$ (anyOf 26).templateModelRequired within parentExpand Update a block — request body — body value type template template
$ (anyOf 26).typestringOptionalMust equal: template
$ (anyOf 27)objectAlternativeAdditional keys: not allowed
$ (anyOf 27).calloutobjectRequired within parentAdditional keys: not allowed
$ (anyOf 27).callout.colorModelOptionalExpand Update a block — request body — body value type quote quote color
$ (anyOf 27).callout.iconModelOptionalExpand Create a database — request body — body icon
$ (anyOf 27).callout.rich_textarrayRequired within parentMaximum items: 100
$ (anyOf 27).callout.rich_text[]ModelEach itemExpand Create a database — request body — body title item
$ (anyOf 27).objectstringOptionalMust equal: block
$ (anyOf 27).typestringOptionalMust equal: callout
$ (anyOf 28)objectAlternativeAdditional keys: not allowed
$ (anyOf 28).objectstringOptionalMust equal: block
$ (anyOf 28).synced_blockobjectRequired within parentAdditional keys: not allowed
$ (anyOf 28).synced_block.synced_fromobject or nullRequired within parentAdditional keys: not allowed
$ (anyOf 28).synced_block.synced_from.block_idstringRequired within parent
$ (anyOf 28).synced_block.synced_from.typestringOptionalMust equal: block_id
$ (anyOf 28).typestringOptionalMust equal: synced_block

Referenced models: Update a block — request body — body value type quote quote color, Update a block — request body — body value type tab tab, Update a block — request body — body value type equation equation, Update a block — request body — body value type quote quote, Create a page — request body — body content item object block, type quote quote children item object block, type tab tab children item paragraph, Update a block — request body — body value type template template, Update a block — request body — body value type table row table row, Create a page — request body — body content item object block, type embed embed type file upload, Update a block — request body — body value type heading 1 heading 1, Create a page — request body — body content item object block, type pdf pdf, Create a page — request body — body content item object block, type file file, Create a page — request body — body content item object block, type bookmark bookmark, Create a database — request body — body icon, Create a database — request body — body title item, Create a page — request body — body content item object block, type link to page, Create a page — request body — body content item object block, type code

Create a page — request body — body content item object block, type table table

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
childrenarrayRequired within parentMaximum items: 100
Minimum items: 1
children[]ModelEach itemExpand Create a page — request body — body content item object block, type table table children item
has_column_headerbooleanOptional
has_row_headerbooleanOptional
table_widthintegerRequired within parentMinimum: 1

Referenced models: Create a page — request body — body content item object block, type table table children item

Create a page — request body — body content item object block, type table table children item

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
objectstringOptionalMust equal: block
table_rowModelRequired within parentExpand Update a block — request body — body value type table row table row
typestringOptionalMust equal: table_row

Referenced models: Update a block — request body — body value type table row table row

Create a page — request body — body position

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative
$ (anyOf 1).after_blockobjectRequired within parent
$ (anyOf 1).after_block.idstringRequired within parent
$ (anyOf 1).typestringRequired within parentMust equal: after_block
$ (anyOf 2)objectAlternative
$ (anyOf 2).typestringRequired within parentMust equal: page_start
$ (anyOf 3)objectAlternative
$ (anyOf 3).typestringRequired within parentMust equal: page_end

Retrieve a page as markdown — response body

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
idstringRequired within parentThe ID of the page or block.
Format: uuid
markdownstringRequired within parentThe page content as Markdown, in the syntax set by `markdown_version`: Notion-flavored Markdown (`v2`, recommended) or enhanced markdown (`v1`, deprecated, the default on current Notion-Versions).
objectstringRequired within parentThe type of object, always 'page_markdown'.
Must equal: page_markdown
truncatedbooleanRequired within parentWhether the content was truncated due to exceeding the record count limit.
unknown_block_idsarrayRequired within parentBlock IDs that could not be loaded (appeared as <unknown> tags in the markdown). Pass these IDs back to this endpoint to fetch their content separately.
Maximum items: 100
unknown_block_ids[]stringEach itemFormat: uuid
warningsarrayOptionalContent warnings from a synchronous update. Returned only when there is at least one warning.
Maximum items: 100
warnings[]objectEach itemAdditional keys: allowed
warnings[].codestringRequired within parentThe warning category, for example `unsupported_tag` or `no_match`.
warnings[].messagestringRequired within parentWhat the request changed, ignored, or could not match.

Retrieve a page property item — response body — Property Item

FieldTypePresenceDescription and constraints
$objectRoot
has_morebooleanRequired within parent
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternative
next_cursor (anyOf 2)nullAlternative
objectstringRequired within parentMust equal: list
property_itemJSONRequired within parent
property_item (anyOf 1)objectAlternative
property_item (anyOf 1).idstringRequired within parent
property_item (anyOf 1).next_urlJSONRequired within parent
property_item (anyOf 1).next_url (anyOf 1)stringAlternative
property_item (anyOf 1).next_url (anyOf 2)nullAlternative
property_item (anyOf 1).titleModelRequired within parentExpand List views — response body — view
property_item (anyOf 1).typestringRequired within parentMust equal: title
property_item (anyOf 2)objectAlternative
property_item (anyOf 2).idstringRequired within parent
property_item (anyOf 2).next_urlJSONRequired within parent
property_item (anyOf 2).next_url (anyOf 1)stringAlternative
property_item (anyOf 2).next_url (anyOf 2)nullAlternative
property_item (anyOf 2).rich_textModelRequired within parentExpand List views — response body — view
property_item (anyOf 2).typestringRequired within parentMust equal: rich_text
property_item (anyOf 3)objectAlternative
property_item (anyOf 3).idstringRequired within parent
property_item (anyOf 3).next_urlJSONRequired within parent
property_item (anyOf 3).next_url (anyOf 1)stringAlternative
property_item (anyOf 3).next_url (anyOf 2)nullAlternative
property_item (anyOf 3).peopleModelRequired within parentExpand List views — response body — view
property_item (anyOf 3).typestringRequired within parentMust equal: people
property_item (anyOf 4)objectAlternative
property_item (anyOf 4).idstringRequired within parent
property_item (anyOf 4).next_urlJSONRequired within parent
property_item (anyOf 4).next_url (anyOf 1)stringAlternative
property_item (anyOf 4).next_url (anyOf 2)nullAlternative
property_item (anyOf 4).relationModelRequired within parentExpand List views — response body — view
property_item (anyOf 4).typestringRequired within parentMust equal: relation
property_item (anyOf 5)objectAlternative
property_item (anyOf 5).idstringRequired within parent
property_item (anyOf 5).next_urlJSONRequired within parent
property_item (anyOf 5).next_url (anyOf 1)stringAlternative
property_item (anyOf 5).next_url (anyOf 2)nullAlternative
property_item (anyOf 5).rollupJSONRequired within parent
property_item (anyOf 5).rollup (anyOf 1)ModelAlternativeExpand Retrieve a page property item — response body — value Rollup rollup type number
property_item (anyOf 5).rollup (anyOf 2)ModelAlternativeExpand Retrieve a page property item — response body — value Rollup rollup type date
property_item (anyOf 5).rollup (anyOf 3)ModelAlternativeExpand Retrieve a page property item — response body — value Rollup rollup type array
property_item (anyOf 5).rollup (anyOf 4)ModelAlternativeExpand Retrieve a page property item — response body — value Rollup rollup type unsupported
property_item (anyOf 5).rollup (anyOf 5)ModelAlternativeExpand Retrieve a page property item — response body — value Rollup rollup type incomplete
property_item (anyOf 5).typestringRequired within parentMust equal: rollup
resultsarrayRequired within parent
results[]ModelEach itemExpand Retrieve a page property item — response body — value
typestringRequired within parentMust equal: property_item

Referenced models: List views — response body — view, Retrieve a page property item — response body — value, Retrieve a page property item — response body — value Rollup rollup type incomplete, Retrieve a page property item — response body — value Rollup rollup type unsupported, Retrieve a page property item — response body — value Rollup rollup type number, Retrieve a page property item — response body — value Rollup rollup type date, Retrieve a page property item — response body — value Rollup rollup type array

Retrieve a page property item — response body — value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Retrieve a page property item — response body — value Number
$ (anyOf 2)ModelAlternativeExpand Retrieve a page property item — response body — value Url
$ (anyOf 3)ModelAlternativeExpand Retrieve a page property item — response body — value Select
$ (anyOf 4)ModelAlternativeExpand Retrieve a page property item — response body — value Multi Select
$ (anyOf 5)ModelAlternativeExpand Retrieve a page property item — response body — value Status
$ (anyOf 6)ModelAlternativeExpand Retrieve a page property item — response body — value Date
$ (anyOf 7)ModelAlternativeExpand Retrieve a page property item — response body — value Email
$ (anyOf 8)ModelAlternativeExpand Retrieve a page property item — response body — value Phone Number
$ (anyOf 9)ModelAlternativeExpand Retrieve a page property item — response body — value Checkbox
$ (anyOf 10)ModelAlternativeExpand Retrieve a page property item — response body — value Files
$ (anyOf 11)ModelAlternativeExpand Retrieve a page property item — response body — value Created By
$ (anyOf 12)ModelAlternativeExpand Retrieve a page property item — response body — value Created Time
$ (anyOf 13)ModelAlternativeExpand Retrieve a page property item — response body — value Last Edited By
$ (anyOf 14)ModelAlternativeExpand Retrieve a page property item — response body — value Last Edited Time
$ (anyOf 15)ModelAlternativeExpand Retrieve a page property item — response body — value Formula
$ (anyOf 16)ModelAlternativeExpand Retrieve a page property item — response body — value Button
$ (anyOf 17)ModelAlternativeExpand Retrieve a page property item — response body — value Unique Id
$ (anyOf 18)ModelAlternativeExpand Retrieve a page property item — response body — value Verification
$ (anyOf 19)ModelAlternativeExpand Retrieve a page property item — response body — value Place
$ (anyOf 20)ModelAlternativeExpand Retrieve a page property item — response body — value Title
$ (anyOf 21)ModelAlternativeExpand Retrieve a page property item — response body — value Rich Text
$ (anyOf 22)ModelAlternativeExpand Retrieve a page property item — response body — value People
$ (anyOf 23)ModelAlternativeExpand Retrieve a page property item — response body — value Relation
$ (anyOf 24)ModelAlternativeExpand Retrieve a page property item — response body — value Rollup

Referenced models: Retrieve a page property item — response body — value Button, Retrieve a page property item — response body — value Checkbox, Retrieve a page property item — response body — value Created By, Retrieve a page property item — response body — value Created Time, Retrieve a page property item — response body — value Date, Retrieve a page property item — response body — value Email, Retrieve a page property item — response body — value Files, Retrieve a page property item — response body — value Formula, Retrieve a page property item — response body — value Last Edited By, Retrieve a page property item — response body — value Last Edited Time, Retrieve a page property item — response body — value Multi Select, Retrieve a page property item — response body — value Number, Retrieve a page property item — response body — value People, Retrieve a page property item — response body — value Phone Number, Retrieve a page property item — response body — value Place, Retrieve a page property item — response body — value Relation, Retrieve a page property item — response body — value Rich Text, Retrieve a page property item — response body — value Rollup, Retrieve a page property item — response body — value Select, Retrieve a page property item — response body — value Status, Retrieve a page property item — response body — value Title, Retrieve a page property item — response body — value Unique Id, Retrieve a page property item — response body — value Url, Retrieve a page property item — response body — value Verification

Retrieve a page property item — response body — value Button

FieldTypePresenceDescription and constraints
$objectRoot
buttonModelRequired within parentExpand List views — response body — view
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
typestringRequired within parentMust equal: button

Referenced models: List views — response body — view

Retrieve a page property item — response body — value Checkbox

FieldTypePresenceDescription and constraints
$objectRoot
checkboxbooleanRequired within parent
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
typestringRequired within parentMust equal: checkbox

Retrieve a page property item — response body — value Created By

FieldTypePresenceDescription and constraints
$objectRoot
created_byJSONRequired within parent
created_by (anyOf 1)ModelAlternativeExpand Update page — response body — object page created by
created_by (anyOf 2)ModelAlternativeExpand Retrieve a user — response body
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
typestringRequired within parentMust equal: created_by

Referenced models: Update page — response body — object page created by, Retrieve a user — response body

Retrieve a page property item — response body — value Created Time

FieldTypePresenceDescription and constraints
$objectRoot
created_timestringRequired within parentFormat: date-time
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
typestringRequired within parentMust equal: created_time

Retrieve a page property item — response body — value Date

FieldTypePresenceDescription and constraints
$objectRoot
dateJSONRequired within parent
date (anyOf 1)ModelAlternativeExpand Retrieve a page property item — response body — value Date date end, start, time zone
date (anyOf 2)nullAlternative
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
typestringRequired within parentMust equal: date

Referenced models: Retrieve a page property item — response body — value Date date end, start, time zone

Retrieve a page property item — response body — value Date date end, start, time zone

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
endJSONRequired within parentThe end date of the date object, if any.
end (anyOf 1)stringAlternativeFormat: date
end (anyOf 2)stringAlternativeFormat: date-time
Pattern: ^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])[Tt](?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:[Zz]|[+-](?:[01]\d|2[0-3]):[0-5]\d)$
end (anyOf 3)stringAlternativePattern: ^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])T(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?$
end (anyOf 4)nullAlternative
startJSONRequired within parentThe start date of the date object.
start (anyOf 1)stringAlternativeFormat: date
start (anyOf 2)stringAlternativeFormat: date-time
Pattern: ^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])[Tt](?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:[Zz]|[+-](?:[01]\d|2[0-3]):[0-5]\d)$
start (anyOf 3)stringAlternativePattern: ^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])T(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?$
time_zoneJSONRequired within parentThe time zone of the date object.
time_zone (anyOf 1)stringAlternative
time_zone (anyOf 2)nullAlternative

Retrieve a page property item — response body — value Email

FieldTypePresenceDescription and constraints
$objectRoot
emailJSONRequired within parent
email (anyOf 1)stringAlternative
email (anyOf 2)nullAlternative
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
typestringRequired within parentMust equal: email

Retrieve a page property item — response body — value Files

FieldTypePresenceDescription and constraints
$objectRoot
filesarrayRequired within parentMaximum items: 100
files[]ModelEach itemExpand Retrieve a page property item — response body — value Files files item
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
typestringRequired within parentMust equal: files

Referenced models: Retrieve a page property item — response body — value Files files item

Retrieve a page property item — response body — value Files files item

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Retrieve a page property item — response body — value Files files item name
$ (allOf 2)JSONAll variants apply
$ (allOf 2) (anyOf 1)ModelAlternativeExpand Retrieve a page property item — response body — value Files files item value File
$ (allOf 2) (anyOf 2)ModelAlternativeExpand Retrieve a page property item — response body — value Files files item value External

Referenced models: Retrieve a page property item — response body — value Files files item value External, Retrieve a page property item — response body — value Files files item value File, Retrieve a page property item — response body — value Files files item name

Retrieve a page property item — response body — value Files files item name

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
namestringRequired within parentThe name of the file.

Retrieve a page property item — response body — value Files files item value External

FieldTypePresenceDescription and constraints
$objectRoot
externalobjectRequired within parentThe external URL.
Additional keys: allowed
external.urlstringRequired within parentThe URL of the external file or resource.
typestringRequired within parentType of attachment. In this case, an external URL.
Must equal: external

Retrieve a page property item — response body — value Files files item value File

FieldTypePresenceDescription and constraints
$objectRoot
fileModelRequired within parentExpand Get agent — response body — icon value File file
The file URL.
typestringRequired within parentType of attachment. In this case, a file uploaded to a Notion workspace.
Must equal: file

Referenced models: Get agent — response body — icon value File file

Retrieve a page property item — response body — value Formula

FieldTypePresenceDescription and constraints
$objectRoot
formulaModelRequired within parentExpand Retrieve a page property item — response body — value Formula formula
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
typestringRequired within parentMust equal: formula

Referenced models: Retrieve a page property item — response body — value Formula formula

Retrieve a page property item — response body — value Formula formula

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Retrieve a page property item — response body — value Formula formula String
$ (anyOf 2)ModelAlternativeExpand Retrieve a page property item — response body — value Formula formula Date
$ (anyOf 3)ModelAlternativeExpand Retrieve a page property item — response body — value Formula formula Number
$ (anyOf 4)ModelAlternativeExpand Retrieve a page property item — response body — value Formula formula Boolean
$ (anyOf 5)ModelAlternativeExpand Retrieve a page property item — response body — value Formula formula Unsupported

Referenced models: Retrieve a page property item — response body — value Formula formula Boolean, Retrieve a page property item — response body — value Formula formula Date, Retrieve a page property item — response body — value Formula formula Number, Retrieve a page property item — response body — value Formula formula String, Retrieve a page property item — response body — value Formula formula Unsupported

Retrieve a page property item — response body — value Formula formula Boolean

FieldTypePresenceDescription and constraints
$objectRoot
booleanJSONRequired within parent
boolean (anyOf 1)booleanAlternative
boolean (anyOf 2)nullAlternative
typestringRequired within parentMust equal: boolean

Retrieve a page property item — response body — value Formula formula Date

FieldTypePresenceDescription and constraints
$objectRoot
dateJSONRequired within parent
date (anyOf 1)ModelAlternativeExpand Retrieve a page property item — response body — value Date date end, start, time zone
date (anyOf 2)nullAlternative
typestringRequired within parentMust equal: date

Referenced models: Retrieve a page property item — response body — value Date date end, start, time zone

Retrieve a page property item — response body — value Formula formula Number

FieldTypePresenceDescription and constraints
$objectRoot
numberJSONRequired within parent
number (anyOf 1)JSONAlternative
number (anyOf 1) (anyOf 1)numberAlternative
number (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number (anyOf 2)nullAlternative
typestringRequired within parentMust equal: number

Retrieve a page property item — response body — value Formula formula String

FieldTypePresenceDescription and constraints
$objectRoot
stringJSONRequired within parent
string (anyOf 1)stringAlternative
string (anyOf 2)nullAlternative
typestringRequired within parentMust equal: string

Retrieve a page property item — response body — value Formula formula Unsupported

FieldTypePresenceDescription and constraints
$objectRoot
typestringRequired within parentMust equal: unsupported
unsupportedModelRequired within parentExpand List views — response body — view

Referenced models: List views — response body — view

Retrieve a page property item — response body — value Last Edited By

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
last_edited_byJSONRequired within parent
last_edited_by (anyOf 1)ModelAlternativeExpand Update page — response body — object page created by
last_edited_by (anyOf 2)ModelAlternativeExpand Retrieve a user — response body
objectstringRequired within parentMust equal: property_item
typestringRequired within parentMust equal: last_edited_by

Referenced models: Update page — response body — object page created by, Retrieve a user — response body

Retrieve a page property item — response body — value Last Edited Time

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
last_edited_timestringRequired within parentFormat: date-time
objectstringRequired within parentMust equal: property_item
typestringRequired within parentMust equal: last_edited_time

Retrieve a page property item — response body — value Multi Select

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
multi_selectarrayRequired within parentMaximum items: 100
multi_select[]ModelEach itemExpand Retrieve a page property item — response body — value Multi Select multi select item
objectstringRequired within parentMust equal: property_item
typestringRequired within parentMust equal: multi_select

Referenced models: Retrieve a page property item — response body — value Multi Select multi select item

Retrieve a page property item — response body — value Multi Select multi select item

FieldTypePresenceDescription and constraints
$objectRoot
colorstringRequired within parentOne of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red`
Known values: default, gray, brown, orange, yellow, green, blue, purple, pink, red
idstringRequired within parent
namestringRequired within parent

Retrieve a page property item — response body — value Number

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
numberJSONRequired within parent
number (anyOf 1)JSONAlternative
number (anyOf 1) (anyOf 1)numberAlternative
number (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number (anyOf 2)nullAlternative
objectstringRequired within parentMust equal: property_item
typestringRequired within parentMust equal: number

Retrieve a page property item — response body — value People

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
peopleJSONRequired within parent
people (anyOf 1)ModelAlternativeExpand Update page — response body — object page created by
people (anyOf 2)ModelAlternativeExpand Retrieve a user — response body
typestringRequired within parentMust equal: people

Referenced models: Update page — response body — object page created by, Retrieve a user — response body

Retrieve a page property item — response body — value Phone Number

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
phone_numberJSONRequired within parent
phone_number (anyOf 1)stringAlternative
phone_number (anyOf 2)nullAlternative
typestringRequired within parentMust equal: phone_number

Retrieve a page property item — response body — value Place

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
placeJSONRequired within parent
place (anyOf 1)objectAlternative
place (anyOf 1).addressJSONOptional
place (anyOf 1).address (anyOf 1)stringAlternative
place (anyOf 1).address (anyOf 2)nullAlternative
place (anyOf 1).aws_place_idJSONOptional
place (anyOf 1).aws_place_id (anyOf 1)stringAlternative
place (anyOf 1).aws_place_id (anyOf 2)nullAlternative
place (anyOf 1).google_place_idJSONOptional
place (anyOf 1).google_place_id (anyOf 1)stringAlternative
place (anyOf 1).google_place_id (anyOf 2)nullAlternative
place (anyOf 1).latJSONRequired within parent
place (anyOf 1).lat (anyOf 1)numberAlternative
place (anyOf 1).lat (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
place (anyOf 1).lonJSONRequired within parent
place (anyOf 1).lon (anyOf 1)numberAlternative
place (anyOf 1).lon (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
place (anyOf 1).nameJSONOptional
place (anyOf 1).name (anyOf 1)stringAlternative
place (anyOf 1).name (anyOf 2)nullAlternative
place (anyOf 2)nullAlternative
place (anyOf 2).addressJSONOptional
place (anyOf 2).address (anyOf 1)stringAlternative
place (anyOf 2).address (anyOf 2)nullAlternative
place (anyOf 2).aws_place_idJSONOptional
place (anyOf 2).aws_place_id (anyOf 1)stringAlternative
place (anyOf 2).aws_place_id (anyOf 2)nullAlternative
place (anyOf 2).google_place_idJSONOptional
place (anyOf 2).google_place_id (anyOf 1)stringAlternative
place (anyOf 2).google_place_id (anyOf 2)nullAlternative
place (anyOf 2).latJSONRequired within parent
place (anyOf 2).lat (anyOf 1)numberAlternative
place (anyOf 2).lat (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
place (anyOf 2).lonJSONRequired within parent
place (anyOf 2).lon (anyOf 1)numberAlternative
place (anyOf 2).lon (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
place (anyOf 2).nameJSONOptional
place (anyOf 2).name (anyOf 1)stringAlternative
place (anyOf 2).name (anyOf 2)nullAlternative
typestringRequired within parentMust equal: place

Retrieve a page property item — response body — value Relation

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
relationobjectRequired within parent
relation.idstringRequired within parentFormat: uuid
typestringRequired within parentMust equal: relation

Retrieve a page property item — response body — value Rich Text

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
rich_textModelRequired within parentExpand Retrieve a page property item — response body — value Title title
typestringRequired within parentMust equal: rich_text

Referenced models: Retrieve a page property item — response body — value Title title

Retrieve a page property item — response body — value Rollup

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
rollupJSONRequired within parent
rollup (anyOf 1)ModelAlternativeExpand Retrieve a page property item — response body — value Rollup rollup type number
rollup (anyOf 2)ModelAlternativeExpand Retrieve a page property item — response body — value Rollup rollup type date
rollup (anyOf 3)ModelAlternativeExpand Retrieve a page property item — response body — value Rollup rollup type array
rollup (anyOf 4)ModelAlternativeExpand Retrieve a page property item — response body — value Rollup rollup type unsupported
rollup (anyOf 5)ModelAlternativeExpand Retrieve a page property item — response body — value Rollup rollup type incomplete
typestringRequired within parentMust equal: rollup

Referenced models: Retrieve a page property item — response body — value Rollup rollup type incomplete, Retrieve a page property item — response body — value Rollup rollup type unsupported, Retrieve a page property item — response body — value Rollup rollup type number, Retrieve a page property item — response body — value Rollup rollup type date, Retrieve a page property item — response body — value Rollup rollup type array

Retrieve a page property item — response body — value Rollup rollup type array

FieldTypePresenceDescription and constraints
$objectRoot
arrayarrayRequired within parentMaximum items: 100
array[]ModelEach itemExpand List views — response body — view
functionstringRequired within parentKnown values: count, count_values, empty, not_empty, unique, show_unique, percent_empty, percent_not_empty, sum, average, median, min, max, range, earliest_date, latest_date, date_range, checked, unchecked, percent_checked, percent_unchecked, count_per_group, percent_per_group, show_original
typestringRequired within parentMust equal: array

Referenced models: List views — response body — view

Retrieve a page property item — response body — value Rollup rollup type date

FieldTypePresenceDescription and constraints
$objectRoot
dateJSONRequired within parent
date (anyOf 1)ModelAlternativeExpand Retrieve a page property item — response body — value Date date end, start, time zone
date (anyOf 2)nullAlternative
functionstringRequired within parentKnown values: count, count_values, empty, not_empty, unique, show_unique, percent_empty, percent_not_empty, sum, average, median, min, max, range, earliest_date, latest_date, date_range, checked, unchecked, percent_checked, percent_unchecked, count_per_group, percent_per_group, show_original
typestringRequired within parentMust equal: date

Referenced models: Retrieve a page property item — response body — value Date date end, start, time zone

Retrieve a page property item — response body — value Rollup rollup type incomplete

FieldTypePresenceDescription and constraints
$objectRoot
functionstringRequired within parentKnown values: count, count_values, empty, not_empty, unique, show_unique, percent_empty, percent_not_empty, sum, average, median, min, max, range, earliest_date, latest_date, date_range, checked, unchecked, percent_checked, percent_unchecked, count_per_group, percent_per_group, show_original
incompleteModelRequired within parentExpand List views — response body — view
typestringRequired within parentMust equal: incomplete

Referenced models: List views — response body — view

Retrieve a page property item — response body — value Rollup rollup type number

FieldTypePresenceDescription and constraints
$objectRoot
functionstringRequired within parentKnown values: count, count_values, empty, not_empty, unique, show_unique, percent_empty, percent_not_empty, sum, average, median, min, max, range, earliest_date, latest_date, date_range, checked, unchecked, percent_checked, percent_unchecked, count_per_group, percent_per_group, show_original
numberJSONRequired within parent
number (anyOf 1)JSONAlternative
number (anyOf 1) (anyOf 1)numberAlternative
number (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number (anyOf 2)nullAlternative
typestringRequired within parentMust equal: number

Retrieve a page property item — response body — value Rollup rollup type unsupported

FieldTypePresenceDescription and constraints
$objectRoot
functionstringRequired within parentKnown values: count, count_values, empty, not_empty, unique, show_unique, percent_empty, percent_not_empty, sum, average, median, min, max, range, earliest_date, latest_date, date_range, checked, unchecked, percent_checked, percent_unchecked, count_per_group, percent_per_group, show_original
typestringRequired within parentMust equal: unsupported
unsupportedModelRequired within parentExpand List views — response body — view

Referenced models: List views — response body — view

Retrieve a page property item — response body — value Select

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
selectJSONRequired within parent
select (anyOf 1)ModelAlternativeExpand Retrieve a page property item — response body — value Multi Select multi select item
select (anyOf 2)nullAlternative
typestringRequired within parentMust equal: select

Referenced models: Retrieve a page property item — response body — value Multi Select multi select item

Retrieve a page property item — response body — value Status

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
statusJSONRequired within parent
status (anyOf 1)ModelAlternativeExpand Retrieve a page property item — response body — value Multi Select multi select item
status (anyOf 2)nullAlternative
typestringRequired within parentMust equal: status

Referenced models: Retrieve a page property item — response body — value Multi Select multi select item

Retrieve a page property item — response body — value Title

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parent
objectstringRequired within parentMust equal: property_item
titleModelRequired within parentExpand Retrieve a page property item — response body — value Title title
typestringRequired within parentMust equal: title

Referenced models: Retrieve a page property item — response body — value Title title

Retrieve a page property item — response body — value Title title

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Retrieve a page property item — response body — value Title title annotations, href, plain text
$ (allOf 2)JSONAll variants apply
$ (allOf 2) (anyOf 1)ModelAlternativeExpand Retrieve a page property item — response body — value Title title value Text
$ (allOf 2) (anyOf 2)ModelAlternativeExpand Retrieve a page property item — response body — value Title title value Mention
$ (allOf 2) (anyOf 3)ModelAlternativeExpand Retrieve a page property item — response body — value Title title value Equation

Referenced models: Retrieve a page property item — response body — value Title title value Equation, Retrieve a page property item — response body — value Title title value Mention, Retrieve a page property item — response body — value Title title annotations, href, plain text, Retrieve a page property item — response body — value Title title value Text

Retrieve a page property item — response body — value Title title annotations, href, plain text

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
annotationsModelRequired within parentExpand Retrieve a page property item — response body — value Title title annotations, href, plain text annotations
All rich text objects contain an annotations object that sets the styling for the rich text.
hrefJSONRequired within parentA URL that the rich text object links to or mentions.
href (anyOf 1)stringAlternative
href (anyOf 2)nullAlternative
plain_textstringRequired within parentThe plain text content of the rich text object, without any styling.

Referenced models: Retrieve a page property item — response body — value Title title annotations, href, plain text annotations

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.