V2
Block Types
Review all readable block types and the subset of block types supported for writes.
Block Types
The read APIs can return every block type supported by the service. Write APIs accept a defined subset of block types.
Readable Block Types
| Group | Types |
|---|---|
| Text and structure | paragraph, heading_1, heading_2, heading_3, bulleted_list_item, numbered_list_item, to_do, quote, code, callout, divider, toggle, equation |
| Media and embeds | bookmark, embed, image, file |
| Data and layout | table, table_row, column_list, column |
| Page and containers | link_to_page, link_page, child_page, child_database, child_mind_map, mind_map, folder, template, synced_block |
Writable Block Types
| Type | Writable content field |
|---|---|
paragraph |
paragraph |
heading_1 |
heading_1 |
heading_2 |
heading_2 |
heading_3 |
heading_3 |
bulleted_list_item |
bulleted_list_item |
numbered_list_item |
numbered_list_item |
to_do |
to_do |
quote |
quote |
code |
code |
callout |
callout |
divider |
No content object required. |
bookmark |
bookmark |
embed |
embed |
image |
image |
file |
file |
table |
table |
table_row |
table_row |
toggle |
toggle |
equation |
equation |
link_to_page |
link_to_page |
child_page |
child_page |
child_database |
child_database |
column_list |
column_list |
column |
column |
child_mind_map |
child_mind_map |
mind_map |
mind_map |
link_page |
link_page |
folder |
folder |
Rules
- A block content object is stored under the field named by
type. - Write requests must use writable block types only.
- Some block types can contain
children; eachchildrenarray can contain at most 100 blocks. - A
column_listmust contain 2–100 directcolumnchildren.column.width_ratiomust be positive and defaults to1. child_databasecreates a database page by default. Setis_inlinetotruefor an inline database. A title property and default table view are created automatically when needed.child_mind_mapcreates a mind map page andmind_mapcreates an inline mind map. Supply the initial tree throughnodes; edit nodes later through/v2/mind-maps/{mind_map_id}.- Folder descendants can contain only
fileandfolderblocks. link_pageinput is accepted for legacy compatibility and is normalized tolink_to_pageafter a write.templateandsynced_blockremain read-only.- Unsupported block types return
400 unsupported_block_type. - Use the Markdown endpoint when a full-page text export is a better fit than block-level reads.