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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Additional keys: not allowed |
$ (anyOf 1).embed | JSON | Required within parent | |
$ (anyOf 1).embed (anyOf 1) | Model | Alternative | Expand Create a page — request body — body content item object block, type bookmark bookmark |
$ (anyOf 1).embed (anyOf 2) | Model | Alternative | Expand Create a page — request body — body content item object block, type embed embed type file upload |
$ (anyOf 1).object | string | Optional | Must equal: block |
$ (anyOf 1).type | string | Optional | Must equal: embed |
$ (anyOf 2) | object | Alternative | Additional keys: not allowed |
$ (anyOf 2).bookmark | Model | Required within parent | Expand Create a page — request body — body content item object block, type bookmark bookmark |
$ (anyOf 2).object | string | Optional | Must equal: block |
$ (anyOf 2).type | string | Optional | Must equal: bookmark |
$ (anyOf 3) | object | Alternative | Additional keys: not allowed |
$ (anyOf 3).image | Model | Required within parent | Expand Create a page — request body — body content item object block, type pdf pdf |
$ (anyOf 3).object | string | Optional | Must equal: block |
$ (anyOf 3).type | string | Optional | Must equal: image |
$ (anyOf 4) | object | Alternative | Additional keys: not allowed |
$ (anyOf 4).object | string | Optional | Must equal: block |
$ (anyOf 4).type | string | Optional | Must equal: video |
$ (anyOf 4).video | Model | Required within parent | Expand Create a page — request body — body content item object block, type pdf pdf |
$ (anyOf 5) | object | Alternative | Additional keys: not allowed |
$ (anyOf 5).object | string | Optional | Must equal: block |
$ (anyOf 5).pdf | Model | Required within parent | Expand Create a page — request body — body content item object block, type pdf pdf |
$ (anyOf 5).type | string | Optional | Must equal: pdf |
$ (anyOf 6) | object | Alternative | Additional keys: not allowed |
$ (anyOf 6).file | Model | Required within parent | Expand Create a page — request body — body content item object block, type file file |
$ (anyOf 6).object | string | Optional | Must equal: block |
$ (anyOf 6).type | string | Optional | Must equal: file |
$ (anyOf 7) | object | Alternative | Additional keys: not allowed |
$ (anyOf 7).audio | Model | Required within parent | Expand Create a page — request body — body content item object block, type pdf pdf |
$ (anyOf 7).object | string | Optional | Must equal: block |
$ (anyOf 7).type | string | Optional | Must equal: audio |
$ (anyOf 8) | Model | Alternative | Expand Create a page — request body — body content item object block, type code |
$ (anyOf 9) | object | Alternative | Additional keys: not allowed |
$ (anyOf 9).equation | Model | Required within parent | Expand Update a block — request body — body value type equation equation |
$ (anyOf 9).object | string | Optional | Must equal: block |
$ (anyOf 9).type | string | Optional | Must equal: equation |
$ (anyOf 10) | object | Alternative | Additional keys: not allowed |
$ (anyOf 10).divider | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
$ (anyOf 10).object | string | Optional | Must equal: block |
$ (anyOf 10).type | string | Optional | Must equal: divider |
$ (anyOf 11) | object | Alternative | Additional keys: not allowed |
$ (anyOf 11).breadcrumb | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
$ (anyOf 11).object | string | Optional | Must equal: block |
$ (anyOf 11).type | string | Optional | Must equal: breadcrumb |
$ (anyOf 12) | object | Alternative | Additional keys: not allowed |
$ (anyOf 12).object | string | Optional | Must equal: block |
$ (anyOf 12).tab | Model | Required within parent | Expand Create a page — request body — body content item object block, type tab tab |
$ (anyOf 12).type | string | Optional | Must equal: tab |
$ (anyOf 13) | object | Alternative | Additional keys: not allowed |
$ (anyOf 13).object | string | Optional | Must equal: block |
$ (anyOf 13).table_of_contents | object | Required within parent | Additional keys: not allowed |
$ (anyOf 13).table_of_contents.color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
$ (anyOf 13).type | string | Optional | Must equal: table_of_contents |
$ (anyOf 14) | Model | Alternative | Expand Create a page — request body — body content item object block, type link to page |
$ (anyOf 15) | object | Alternative | Additional keys: not allowed |
$ (anyOf 15).object | string | Optional | Must equal: block |
$ (anyOf 15).table_row | Model | Required within parent | Expand Update a block — request body — body value type table row table row |
$ (anyOf 15).type | string | Optional | Must equal: table_row |
$ (anyOf 16) | object | Alternative | Additional keys: not allowed |
$ (anyOf 16).object | string | Optional | Must equal: block |
$ (anyOf 16).table | Model | Required within parent | Expand Create a page — request body — body content item object block, type table table |
$ (anyOf 16).type | string | Optional | Must equal: table |
$ (anyOf 17) | object | Alternative | Additional keys: not allowed |
$ (anyOf 17).column_list | Model | Required within parent | Expand Create a page — request body — body content item object block, type column list column list |
$ (anyOf 17).object | string | Optional | Must equal: block |
$ (anyOf 17).type | string | Optional | Must equal: column_list |
$ (anyOf 18) | object | Alternative | Additional keys: not allowed |
$ (anyOf 18).column | Model | Required within parent | Expand Create a page — request body — body content item object block, type column column |
$ (anyOf 18).object | string | Optional | Must equal: block |
$ (anyOf 18).type | string | Optional | Must equal: column |
$ (anyOf 19) | object | Alternative | Additional keys: not allowed |
$ (anyOf 19).heading_1 | object | Required within parent | Additional keys: not allowed |
$ (anyOf 19).heading_1.children | array | Optional | Maximum items: 100 |
$ (anyOf 19).heading_1.children[] | Model | Each item | Expand Create a page — request body — body content item object block, type quote quote children item |
$ (anyOf 19).heading_1.color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
$ (anyOf 19).heading_1.is_toggleable | boolean | Optional | |
$ (anyOf 19).heading_1.rich_text | array | Required within parent | Maximum items: 100 |
$ (anyOf 19).heading_1.rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
$ (anyOf 19).object | string | Optional | Must equal: block |
$ (anyOf 19).type | string | Optional | Must equal: heading_1 |
$ (anyOf 20) | object | Alternative | Additional keys: not allowed |
$ (anyOf 20).heading_2 | object | Required within parent | Additional keys: not allowed |
$ (anyOf 20).heading_2.children | array | Optional | Maximum items: 100 |
$ (anyOf 20).heading_2.children[] | Model | Each item | Expand Create a page — request body — body content item object block, type quote quote children item |
$ (anyOf 20).heading_2.color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
$ (anyOf 20).heading_2.is_toggleable | boolean | Optional | |
$ (anyOf 20).heading_2.rich_text | array | Required within parent | Maximum items: 100 |
$ (anyOf 20).heading_2.rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
$ (anyOf 20).object | string | Optional | Must equal: block |
$ (anyOf 20).type | string | Optional | Must equal: heading_2 |
$ (anyOf 21) | object | Alternative | Additional keys: not allowed |
$ (anyOf 21).heading_3 | object | Required within parent | Additional keys: not allowed |
$ (anyOf 21).heading_3.children | array | Optional | Maximum items: 100 |
$ (anyOf 21).heading_3.children[] | Model | Each item | Expand Create a page — request body — body content item object block, type quote quote children item |
$ (anyOf 21).heading_3.color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
$ (anyOf 21).heading_3.is_toggleable | boolean | Optional | |
$ (anyOf 21).heading_3.rich_text | array | Required within parent | Maximum items: 100 |
$ (anyOf 21).heading_3.rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
$ (anyOf 21).object | string | Optional | Must equal: block |
$ (anyOf 21).type | string | Optional | Must equal: heading_3 |
$ (anyOf 22) | object | Alternative | Additional keys: not allowed |
$ (anyOf 22).heading_4 | object | Required within parent | Additional keys: not allowed |
$ (anyOf 22).heading_4.children | array | Optional | Maximum items: 100 |
$ (anyOf 22).heading_4.children[] | Model | Each item | Expand Create a page — request body — body content item object block, type quote quote children item |
$ (anyOf 22).heading_4.color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
$ (anyOf 22).heading_4.is_toggleable | boolean | Optional | |
$ (anyOf 22).heading_4.rich_text | array | Required within parent | Maximum items: 100 |
$ (anyOf 22).heading_4.rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
$ (anyOf 22).object | string | Optional | Must equal: block |
$ (anyOf 22).type | string | Optional | Must equal: heading_4 |
$ (anyOf 23) | object | Alternative | Additional keys: not allowed |
$ (anyOf 23).object | string | Optional | Must equal: block |
$ (anyOf 23).paragraph | object | Required within parent | Additional keys: not allowed |
$ (anyOf 23).paragraph.children | array | Optional | Maximum items: 100 |
$ (anyOf 23).paragraph.children[] | Model | Each item | Expand Create a page — request body — body content item object block, type quote quote children item |
$ (anyOf 23).paragraph.color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
$ (anyOf 23).paragraph.icon | Model | Optional | Expand Create a database — request body — body icon |
$ (anyOf 23).paragraph.rich_text | array | Required within parent | Maximum items: 100 |
$ (anyOf 23).paragraph.rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
$ (anyOf 23).type | string | Optional | Must equal: paragraph |
$ (anyOf 24) | object | Alternative | Additional keys: not allowed |
$ (anyOf 24).bulleted_list_item | object | Required within parent | Additional keys: not allowed |
$ (anyOf 24).bulleted_list_item.children | array | Optional | Maximum items: 100 |
$ (anyOf 24).bulleted_list_item.children[] | Model | Each item | Expand Create a page — request body — body content item object block, type quote quote children item |
$ (anyOf 24).bulleted_list_item.color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
$ (anyOf 24).bulleted_list_item.rich_text | array | Required within parent | Maximum items: 100 |
$ (anyOf 24).bulleted_list_item.rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
$ (anyOf 24).object | string | Optional | Must equal: block |
$ (anyOf 24).type | string | Optional | Must equal: bulleted_list_item |
$ (anyOf 25) | object | Alternative | Additional keys: not allowed |
$ (anyOf 25).numbered_list_item | object | Required within parent | Additional keys: not allowed |
$ (anyOf 25).numbered_list_item.children | array | Optional | Maximum items: 100 |
$ (anyOf 25).numbered_list_item.children[] | Model | Each item | Expand Create a page — request body — body content item object block, type quote quote children item |
$ (anyOf 25).numbered_list_item.color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
$ (anyOf 25).numbered_list_item.rich_text | array | Required within parent | Maximum items: 100 |
$ (anyOf 25).numbered_list_item.rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
$ (anyOf 25).object | string | Optional | Must equal: block |
$ (anyOf 25).type | string | Optional | Must equal: numbered_list_item |
$ (anyOf 26) | object | Alternative | Additional keys: not allowed |
$ (anyOf 26).object | string | Optional | Must equal: block |
$ (anyOf 26).quote | object | Required within parent | Additional keys: not allowed |
$ (anyOf 26).quote.children | array | Optional | Maximum items: 100 |
$ (anyOf 26).quote.children[] | Model | Each item | Expand Create a page — request body — body content item object block, type quote quote children item |
$ (anyOf 26).quote.color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
$ (anyOf 26).quote.rich_text | array | Required within parent | Maximum items: 100 |
$ (anyOf 26).quote.rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
$ (anyOf 26).type | string | Optional | Must equal: quote |
$ (anyOf 27) | object | Alternative | Additional keys: not allowed |
$ (anyOf 27).object | string | Optional | Must equal: block |
$ (anyOf 27).to_do | object | Required within parent | Additional keys: not allowed |
$ (anyOf 27).to_do.checked | boolean | Optional | |
$ (anyOf 27).to_do.children | array | Optional | Maximum items: 100 |
$ (anyOf 27).to_do.children[] | Model | Each item | Expand Create a page — request body — body content item object block, type quote quote children item |
$ (anyOf 27).to_do.color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
$ (anyOf 27).to_do.rich_text | array | Required within parent | Maximum items: 100 |
$ (anyOf 27).to_do.rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
$ (anyOf 27).type | string | Optional | Must equal: to_do |
$ (anyOf 28) | object | Alternative | Additional keys: not allowed |
$ (anyOf 28).object | string | Optional | Must equal: block |
$ (anyOf 28).toggle | object | Required within parent | Additional keys: not allowed |
$ (anyOf 28).toggle.children | array | Optional | Maximum items: 100 |
$ (anyOf 28).toggle.children[] | Model | Each item | Expand Create a page — request body — body content item object block, type quote quote children item |
$ (anyOf 28).toggle.color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
$ (anyOf 28).toggle.rich_text | array | Required within parent | Maximum items: 100 |
$ (anyOf 28).toggle.rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
$ (anyOf 28).type | string | Optional | Must equal: toggle |
$ (anyOf 29) | object | Alternative | Additional keys: not allowed |
$ (anyOf 29).object | string | Optional | Must equal: block |
$ (anyOf 29).template | object | Required within parent | Additional keys: not allowed |
$ (anyOf 29).template.children | array | Optional | Maximum items: 100 |
$ (anyOf 29).template.children[] | Model | Each item | Expand Create a page — request body — body content item object block, type quote quote children item |
$ (anyOf 29).template.rich_text | array | Required within parent | Maximum items: 100 |
$ (anyOf 29).template.rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
$ (anyOf 29).type | string | Optional | Must equal: template |
$ (anyOf 30) | object | Alternative | Additional keys: not allowed |
$ (anyOf 30).callout | object | Required within parent | Additional keys: not allowed |
$ (anyOf 30).callout.children | array | Optional | Maximum items: 100 |
$ (anyOf 30).callout.children[] | Model | Each item | Expand Create a page — request body — body content item object block, type quote quote children item |
$ (anyOf 30).callout.color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
$ (anyOf 30).callout.icon | Model | Optional | Expand Create a database — request body — body icon |
$ (anyOf 30).callout.rich_text | array | Required within parent | Maximum items: 100 |
$ (anyOf 30).callout.rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
$ (anyOf 30).object | string | Optional | Must equal: block |
$ (anyOf 30).type | string | Optional | Must equal: callout |
$ (anyOf 31) | object | Alternative | Additional keys: not allowed |
$ (anyOf 31).object | string | Optional | Must equal: block |
$ (anyOf 31).synced_block | object | Required within parent | Additional keys: not allowed |
$ (anyOf 31).synced_block.children | array | Optional | Maximum items: 100 |
$ (anyOf 31).synced_block.children[] | Model | Each item | Expand Create a page — request body — body content item object block, type quote quote children item |
$ (anyOf 31).synced_block.synced_from | object or null | Required within parent | Additional keys: not allowed |
$ (anyOf 31).synced_block.synced_from.block_id | string | Required within parent | |
$ (anyOf 31).synced_block.synced_from.type | string | Optional | Must equal: block_id |
$ (anyOf 31).type | string | Optional | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
caption | array | Optional | Maximum items: 100 |
caption[] | Model | Each item | Expand Create a database — request body — body title item |
url | string | Required within parent |
Referenced models: Create a database — request body — body title item
Create a page — request body — body content item object block, type code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
code | object | Required within parent | Additional keys: not allowed |
code.caption | array | Optional | Maximum items: 100 |
code.caption[] | Model | Each item | Expand Create a database — request body — body title item |
code.language | Model | Required within parent | Expand Update a block — request body — body value type code code language |
code.rich_text | array | Required within parent | Maximum items: 100 |
code.rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
object | string | Optional | Must equal: block |
type | string | Optional | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
children | array | Required within parent | Maximum items: 100 |
children[] | Model | Each item | Expand Create a page — request body — body content item object block, type quote quote children item |
width_ratio | number | Optional | Ratio 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
children | array | Required within parent | Maximum items: 100 Minimum items: 2 |
children[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
column | Model | Required within parent | Expand Create a page — request body — body content item object block, type column column |
object | string | Optional | Must equal: block |
type | string | Optional | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
caption | array | Optional | Maximum items: 100 |
caption[] | Model | Each item | Expand Create a database — request body — body title item |
file_upload | Model | Required within parent | Expand Update a block — request body — body value type pdf pdf file upload |
type | string | Optional | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Additional keys: not allowed |
$ (anyOf 1).caption | array | Optional | Maximum items: 100 |
$ (anyOf 1).caption[] | Model | Each item | Expand Create a database — request body — body title item |
$ (anyOf 1).external | Model | Required within parent | Expand Update a block — request body — body value type pdf pdf external |
$ (anyOf 1).name | string | Optional | Maximum length: 100 Minimum length: 1 |
$ (anyOf 1).type | string | Optional | Must equal: external |
$ (anyOf 2) | object | Alternative | Additional keys: not allowed |
$ (anyOf 2).caption | array | Optional | Maximum items: 100 |
$ (anyOf 2).caption[] | Model | Each item | Expand Create a database — request body — body title item |
$ (anyOf 2).file_upload | Model | Required within parent | Expand Update a block — request body — body value type pdf pdf file upload |
$ (anyOf 2).name | string | Optional | Maximum length: 100 Minimum length: 1 |
$ (anyOf 2).type | string | Optional | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
link_to_page | JSON | Required within parent | |
link_to_page (anyOf 1) | object | Alternative | Additional keys: not allowed |
link_to_page (anyOf 1).page_id | string | Required within parent | |
link_to_page (anyOf 1).type | string | Optional | Must equal: page_id |
link_to_page (anyOf 2) | object | Alternative | Additional keys: not allowed |
link_to_page (anyOf 2).database_id | string | Required within parent | |
link_to_page (anyOf 2).type | string | Optional | Must equal: database_id |
link_to_page (anyOf 3) | object | Alternative | Additional keys: not allowed |
link_to_page (anyOf 3).comment_id | string | Required within parent | |
link_to_page (anyOf 3).type | string | Optional | Must equal: comment_id |
object | string | Optional | Must equal: block |
type | string | Optional | Must equal: link_to_page |
Create a page — request body — body content item object block, type pdf pdf
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Additional keys: not allowed |
$ (anyOf 1).caption | array | Optional | Maximum items: 100 |
$ (anyOf 1).caption[] | Model | Each item | Expand Create a database — request body — body title item |
$ (anyOf 1).external | Model | Required within parent | Expand Update a block — request body — body value type pdf pdf external |
$ (anyOf 1).type | string | Optional | Must equal: external |
$ (anyOf 2) | object | Alternative | Additional keys: not allowed |
$ (anyOf 2).caption | array | Optional | Maximum items: 100 |
$ (anyOf 2).caption[] | Model | Each item | Expand Create a database — request body — body title item |
$ (anyOf 2).file_upload | Model | Required within parent | Expand Update a block — request body — body value type pdf pdf file upload |
$ (anyOf 2).type | string | Optional | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Additional keys: not allowed |
$ (anyOf 1).embed | JSON | Required within parent | |
$ (anyOf 1).embed (anyOf 1) | Model | Alternative | Expand Create a page — request body — body content item object block, type bookmark bookmark |
$ (anyOf 1).embed (anyOf 2) | Model | Alternative | Expand Create a page — request body — body content item object block, type embed embed type file upload |
$ (anyOf 1).object | string | Optional | Must equal: block |
$ (anyOf 1).type | string | Optional | Must equal: embed |
$ (anyOf 2) | object | Alternative | Additional keys: not allowed |
$ (anyOf 2).bookmark | Model | Required within parent | Expand Create a page — request body — body content item object block, type bookmark bookmark |
$ (anyOf 2).object | string | Optional | Must equal: block |
$ (anyOf 2).type | string | Optional | Must equal: bookmark |
$ (anyOf 3) | object | Alternative | Additional keys: not allowed |
$ (anyOf 3).image | Model | Required within parent | Expand Create a page — request body — body content item object block, type pdf pdf |
$ (anyOf 3).object | string | Optional | Must equal: block |
$ (anyOf 3).type | string | Optional | Must equal: image |
$ (anyOf 4) | object | Alternative | Additional keys: not allowed |
$ (anyOf 4).object | string | Optional | Must equal: block |
$ (anyOf 4).type | string | Optional | Must equal: video |
$ (anyOf 4).video | Model | Required within parent | Expand Create a page — request body — body content item object block, type pdf pdf |
$ (anyOf 5) | object | Alternative | Additional keys: not allowed |
$ (anyOf 5).object | string | Optional | Must equal: block |
$ (anyOf 5).pdf | Model | Required within parent | Expand Create a page — request body — body content item object block, type pdf pdf |
$ (anyOf 5).type | string | Optional | Must equal: pdf |
$ (anyOf 6) | object | Alternative | Additional keys: not allowed |
$ (anyOf 6).file | Model | Required within parent | Expand Create a page — request body — body content item object block, type file file |
$ (anyOf 6).object | string | Optional | Must equal: block |
$ (anyOf 6).type | string | Optional | Must equal: file |
$ (anyOf 7) | object | Alternative | Additional keys: not allowed |
$ (anyOf 7).audio | Model | Required within parent | Expand Create a page — request body — body content item object block, type pdf pdf |
$ (anyOf 7).object | string | Optional | Must equal: block |
$ (anyOf 7).type | string | Optional | Must equal: audio |
$ (anyOf 8) | Model | Alternative | Expand Create a page — request body — body content item object block, type code |
$ (anyOf 9) | object | Alternative | Additional keys: not allowed |
$ (anyOf 9).equation | Model | Required within parent | Expand Update a block — request body — body value type equation equation |
$ (anyOf 9).object | string | Optional | Must equal: block |
$ (anyOf 9).type | string | Optional | Must equal: equation |
$ (anyOf 10) | object | Alternative | Additional keys: not allowed |
$ (anyOf 10).divider | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
$ (anyOf 10).object | string | Optional | Must equal: block |
$ (anyOf 10).type | string | Optional | Must equal: divider |
$ (anyOf 11) | object | Alternative | Additional keys: not allowed |
$ (anyOf 11).breadcrumb | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
$ (anyOf 11).object | string | Optional | Must equal: block |
$ (anyOf 11).type | string | Optional | Must equal: breadcrumb |
$ (anyOf 12) | object | Alternative | Additional keys: not allowed |
$ (anyOf 12).object | string | Optional | Must equal: block |
$ (anyOf 12).tab | Model | Required within parent | Expand Create a page — request body — body content item object block, type quote quote children item object block, type tab tab |
$ (anyOf 12).type | string | Optional | Must equal: tab |
$ (anyOf 13) | object | Alternative | Additional keys: not allowed |
$ (anyOf 13).object | string | Optional | Must equal: block |
$ (anyOf 13).table_of_contents | object | Required within parent | Additional keys: not allowed |
$ (anyOf 13).table_of_contents.color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
$ (anyOf 13).type | string | Optional | Must equal: table_of_contents |
$ (anyOf 14) | Model | Alternative | Expand Create a page — request body — body content item object block, type link to page |
$ (anyOf 15) | object | Alternative | Additional keys: not allowed |
$ (anyOf 15).object | string | Optional | Must equal: block |
$ (anyOf 15).table_row | Model | Required within parent | Expand Update a block — request body — body value type table row table row |
$ (anyOf 15).type | string | Optional | Must equal: table_row |
$ (anyOf 16) | object | Alternative | Additional keys: not allowed |
$ (anyOf 16).heading_1 | Model | Required within parent | Expand Create a page — request body — body content item object block, type quote quote children item object block, type heading 1 heading 1 |
$ (anyOf 16).object | string | Optional | Must equal: block |
$ (anyOf 16).type | string | Optional | Must equal: heading_1 |
$ (anyOf 17) | object | Alternative | Additional keys: not allowed |
$ (anyOf 17).heading_2 | Model | Required within parent | Expand Create a page — request body — body content item object block, type quote quote children item object block, type heading 1 heading 1 |
$ (anyOf 17).object | string | Optional | Must equal: block |
$ (anyOf 17).type | string | Optional | Must equal: heading_2 |
$ (anyOf 18) | object | Alternative | Additional keys: not allowed |
$ (anyOf 18).heading_3 | Model | Required within parent | Expand Create a page — request body — body content item object block, type quote quote children item object block, type heading 1 heading 1 |
$ (anyOf 18).object | string | Optional | Must equal: block |
$ (anyOf 18).type | string | Optional | Must equal: heading_3 |
$ (anyOf 19) | object | Alternative | Additional keys: not allowed |
$ (anyOf 19).heading_4 | Model | Required within parent | Expand Create a page — request body — body content item object block, type quote quote children item object block, type heading 1 heading 1 |
$ (anyOf 19).object | string | Optional | Must equal: block |
$ (anyOf 19).type | string | Optional | Must equal: heading_4 |
$ (anyOf 20) | object | Alternative | Additional keys: not allowed |
$ (anyOf 20).object | string | Optional | Must equal: block |
$ (anyOf 20).paragraph | Model | Required within parent | Expand Create a page — request body — body content item object block, type tab tab children item paragraph |
$ (anyOf 20).type | string | Optional | Must equal: paragraph |
$ (anyOf 21) | object | Alternative | Additional keys: not allowed |
$ (anyOf 21).bulleted_list_item | Model | Required within parent | Expand Create a page — request body — body content item object block, type quote quote children item object block, type quote quote |
$ (anyOf 21).object | string | Optional | Must equal: block |
$ (anyOf 21).type | string | Optional | Must equal: bulleted_list_item |
$ (anyOf 22) | object | Alternative | Additional keys: not allowed |
$ (anyOf 22).numbered_list_item | Model | Required within parent | Expand Create a page — request body — body content item object block, type quote quote children item object block, type quote quote |
$ (anyOf 22).object | string | Optional | Must equal: block |
$ (anyOf 22).type | string | Optional | Must equal: numbered_list_item |
$ (anyOf 23) | object | Alternative | Additional keys: not allowed |
$ (anyOf 23).object | string | Optional | Must equal: block |
$ (anyOf 23).quote | Model | Required within parent | Expand Create a page — request body — body content item object block, type quote quote children item object block, type quote quote |
$ (anyOf 23).type | string | Optional | Must equal: quote |
$ (anyOf 24) | object | Alternative | Additional keys: not allowed |
$ (anyOf 24).object | string | Optional | Must equal: block |
$ (anyOf 24).table | Model | Required within parent | Expand Create a page — request body — body content item object block, type table table |
$ (anyOf 24).type | string | Optional | Must equal: table |
$ (anyOf 25) | object | Alternative | Additional keys: not allowed |
$ (anyOf 25).object | string | Optional | Must equal: block |
$ (anyOf 25).to_do | object | Required within parent | Additional keys: not allowed |
$ (anyOf 25).to_do.checked | boolean | Optional | |
$ (anyOf 25).to_do.children | array | Optional | Maximum items: 100 |
$ (anyOf 25).to_do.children[] | Model | Each item | Expand Create a page — request body — body content item object block, type tab tab children item paragraph children item |
$ (anyOf 25).to_do.color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
$ (anyOf 25).to_do.rich_text | array | Required within parent | Maximum items: 100 |
$ (anyOf 25).to_do.rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
$ (anyOf 25).type | string | Optional | Must equal: to_do |
$ (anyOf 26) | object | Alternative | Additional keys: not allowed |
$ (anyOf 26).object | string | Optional | Must equal: block |
$ (anyOf 26).toggle | Model | Required within parent | Expand Create a page — request body — body content item object block, type quote quote children item object block, type quote quote |
$ (anyOf 26).type | string | Optional | Must equal: toggle |
$ (anyOf 27) | object | Alternative | Additional keys: not allowed |
$ (anyOf 27).object | string | Optional | Must equal: block |
$ (anyOf 27).template | object | Required within parent | Additional keys: not allowed |
$ (anyOf 27).template.children | array | Optional | Maximum items: 100 |
$ (anyOf 27).template.children[] | Model | Each item | Expand Create a page — request body — body content item object block, type tab tab children item paragraph children item |
$ (anyOf 27).template.rich_text | array | Required within parent | Maximum items: 100 |
$ (anyOf 27).template.rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
$ (anyOf 27).type | string | Optional | Must equal: template |
$ (anyOf 28) | object | Alternative | Additional keys: not allowed |
$ (anyOf 28).callout | object | Required within parent | Additional keys: not allowed |
$ (anyOf 28).callout.children | array | Optional | Maximum items: 100 |
$ (anyOf 28).callout.children[] | Model | Each item | Expand Create a page — request body — body content item object block, type tab tab children item paragraph children item |
$ (anyOf 28).callout.color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
$ (anyOf 28).callout.icon | Model | Optional | Expand Create a database — request body — body icon |
$ (anyOf 28).callout.rich_text | array | Required within parent | Maximum items: 100 |
$ (anyOf 28).callout.rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
$ (anyOf 28).object | string | Optional | Must equal: block |
$ (anyOf 28).type | string | Optional | Must equal: callout |
$ (anyOf 29) | object | Alternative | Additional keys: not allowed |
$ (anyOf 29).object | string | Optional | Must equal: block |
$ (anyOf 29).synced_block | object | Required within parent | Additional keys: not allowed |
$ (anyOf 29).synced_block.children | array | Optional | Maximum items: 100 |
$ (anyOf 29).synced_block.children[] | Model | Each item | Expand Create a page — request body — body content item object block, type tab tab children item paragraph children item |
$ (anyOf 29).synced_block.synced_from | object or null | Required within parent | Additional keys: not allowed |
$ (anyOf 29).synced_block.synced_from.block_id | string | Required within parent | |
$ (anyOf 29).synced_block.synced_from.type | string | Optional | Must equal: block_id |
$ (anyOf 29).type | string | Optional | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
children | array | Optional | Maximum items: 100 |
children[] | Model | Each item | Expand Create a page — request body — body content item object block, type tab tab children item paragraph children item |
color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
is_toggleable | boolean | Optional | |
rich_text | array | Required within parent | Maximum items: 100 |
rich_text[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
children | array | Optional | Maximum items: 100 |
children[] | Model | Each item | Expand Create a page — request body — body content item object block, type tab tab children item paragraph children item |
color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
rich_text | array | Required within parent | Maximum items: 100 |
rich_text[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
children | array | Required within parent | Maximum items: 100 Minimum items: 1 |
children[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
object | string | Optional | Must equal: block |
paragraph | Model | Required within parent | Expand Create a page — request body — body content item object block, type quote quote children item object block, type tab tab children item paragraph |
type | string | Optional | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
icon | Model | Optional | Expand Create a database — request body — body icon |
rich_text | array | Required within parent | Maximum items: 100 |
rich_text[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
children | array | Required within parent | Maximum items: 100 Minimum items: 1 |
children[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
object | string | Optional | Must equal: block |
paragraph | Model | Required within parent | Expand Create a page — request body — body content item object block, type tab tab children item paragraph |
type | string | Optional | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
children | array | Optional | Maximum items: 100 |
children[] | Model | Each item | Expand Create a page — request body — body content item object block, type tab tab children item paragraph children item |
color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
icon | Model | Optional | Expand Create a database — request body — body icon |
rich_text | array | Required within parent | Maximum items: 100 |
rich_text[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Additional keys: not allowed |
$ (anyOf 1).embed | JSON | Required within parent | |
$ (anyOf 1).embed (anyOf 1) | Model | Alternative | Expand Create a page — request body — body content item object block, type bookmark bookmark |
$ (anyOf 1).embed (anyOf 2) | Model | Alternative | Expand Create a page — request body — body content item object block, type embed embed type file upload |
$ (anyOf 1).object | string | Optional | Must equal: block |
$ (anyOf 1).type | string | Optional | Must equal: embed |
$ (anyOf 2) | object | Alternative | Additional keys: not allowed |
$ (anyOf 2).bookmark | Model | Required within parent | Expand Create a page — request body — body content item object block, type bookmark bookmark |
$ (anyOf 2).object | string | Optional | Must equal: block |
$ (anyOf 2).type | string | Optional | Must equal: bookmark |
$ (anyOf 3) | object | Alternative | Additional keys: not allowed |
$ (anyOf 3).image | Model | Required within parent | Expand Create a page — request body — body content item object block, type pdf pdf |
$ (anyOf 3).object | string | Optional | Must equal: block |
$ (anyOf 3).type | string | Optional | Must equal: image |
$ (anyOf 4) | object | Alternative | Additional keys: not allowed |
$ (anyOf 4).object | string | Optional | Must equal: block |
$ (anyOf 4).type | string | Optional | Must equal: video |
$ (anyOf 4).video | Model | Required within parent | Expand Create a page — request body — body content item object block, type pdf pdf |
$ (anyOf 5) | object | Alternative | Additional keys: not allowed |
$ (anyOf 5).object | string | Optional | Must equal: block |
$ (anyOf 5).pdf | Model | Required within parent | Expand Create a page — request body — body content item object block, type pdf pdf |
$ (anyOf 5).type | string | Optional | Must equal: pdf |
$ (anyOf 6) | object | Alternative | Additional keys: not allowed |
$ (anyOf 6).file | Model | Required within parent | Expand Create a page — request body — body content item object block, type file file |
$ (anyOf 6).object | string | Optional | Must equal: block |
$ (anyOf 6).type | string | Optional | Must equal: file |
$ (anyOf 7) | object | Alternative | Additional keys: not allowed |
$ (anyOf 7).audio | Model | Required within parent | Expand Create a page — request body — body content item object block, type pdf pdf |
$ (anyOf 7).object | string | Optional | Must equal: block |
$ (anyOf 7).type | string | Optional | Must equal: audio |
$ (anyOf 8) | Model | Alternative | Expand Create a page — request body — body content item object block, type code |
$ (anyOf 9) | object | Alternative | Additional keys: not allowed |
$ (anyOf 9).equation | Model | Required within parent | Expand Update a block — request body — body value type equation equation |
$ (anyOf 9).object | string | Optional | Must equal: block |
$ (anyOf 9).type | string | Optional | Must equal: equation |
$ (anyOf 10) | object | Alternative | Additional keys: not allowed |
$ (anyOf 10).divider | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
$ (anyOf 10).object | string | Optional | Must equal: block |
$ (anyOf 10).type | string | Optional | Must equal: divider |
$ (anyOf 11) | object | Alternative | Additional keys: not allowed |
$ (anyOf 11).breadcrumb | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
$ (anyOf 11).object | string | Optional | Must equal: block |
$ (anyOf 11).type | string | Optional | Must equal: breadcrumb |
$ (anyOf 12) | object | Alternative | Additional keys: not allowed |
$ (anyOf 12).object | string | Optional | Must equal: block |
$ (anyOf 12).tab | Model | Required within parent | Expand Update a block — request body — body value type tab tab |
$ (anyOf 12).type | string | Optional | Must equal: tab |
$ (anyOf 13) | object | Alternative | Additional keys: not allowed |
$ (anyOf 13).object | string | Optional | Must equal: block |
$ (anyOf 13).table_of_contents | object | Required within parent | Additional keys: not allowed |
$ (anyOf 13).table_of_contents.color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
$ (anyOf 13).type | string | Optional | Must equal: table_of_contents |
$ (anyOf 14) | Model | Alternative | Expand Create a page — request body — body content item object block, type link to page |
$ (anyOf 15) | object | Alternative | Additional keys: not allowed |
$ (anyOf 15).object | string | Optional | Must equal: block |
$ (anyOf 15).table_row | Model | Required within parent | Expand Update a block — request body — body value type table row table row |
$ (anyOf 15).type | string | Optional | Must equal: table_row |
$ (anyOf 16) | object | Alternative | Additional keys: not allowed |
$ (anyOf 16).heading_1 | Model | Required within parent | Expand Update a block — request body — body value type heading 1 heading 1 |
$ (anyOf 16).object | string | Optional | Must equal: block |
$ (anyOf 16).type | string | Optional | Must equal: heading_1 |
$ (anyOf 17) | object | Alternative | Additional keys: not allowed |
$ (anyOf 17).heading_2 | Model | Required within parent | Expand Update a block — request body — body value type heading 1 heading 1 |
$ (anyOf 17).object | string | Optional | Must equal: block |
$ (anyOf 17).type | string | Optional | Must equal: heading_2 |
$ (anyOf 18) | object | Alternative | Additional keys: not allowed |
$ (anyOf 18).heading_3 | Model | Required within parent | Expand Update a block — request body — body value type heading 1 heading 1 |
$ (anyOf 18).object | string | Optional | Must equal: block |
$ (anyOf 18).type | string | Optional | Must equal: heading_3 |
$ (anyOf 19) | object | Alternative | Additional keys: not allowed |
$ (anyOf 19).heading_4 | Model | Required within parent | Expand Update a block — request body — body value type heading 1 heading 1 |
$ (anyOf 19).object | string | Optional | Must equal: block |
$ (anyOf 19).type | string | Optional | Must equal: heading_4 |
$ (anyOf 20) | object | Alternative | Additional keys: not allowed |
$ (anyOf 20).object | string | Optional | Must equal: block |
$ (anyOf 20).paragraph | Model | Required within parent | Expand 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).type | string | Optional | Must equal: paragraph |
$ (anyOf 21) | object | Alternative | Additional keys: not allowed |
$ (anyOf 21).bulleted_list_item | Model | Required within parent | Expand Update a block — request body — body value type quote quote |
$ (anyOf 21).object | string | Optional | Must equal: block |
$ (anyOf 21).type | string | Optional | Must equal: bulleted_list_item |
$ (anyOf 22) | object | Alternative | Additional keys: not allowed |
$ (anyOf 22).numbered_list_item | Model | Required within parent | Expand Update a block — request body — body value type quote quote |
$ (anyOf 22).object | string | Optional | Must equal: block |
$ (anyOf 22).type | string | Optional | Must equal: numbered_list_item |
$ (anyOf 23) | object | Alternative | Additional keys: not allowed |
$ (anyOf 23).object | string | Optional | Must equal: block |
$ (anyOf 23).quote | Model | Required within parent | Expand Update a block — request body — body value type quote quote |
$ (anyOf 23).type | string | Optional | Must equal: quote |
$ (anyOf 24) | object | Alternative | Additional keys: not allowed |
$ (anyOf 24).object | string | Optional | Must equal: block |
$ (anyOf 24).to_do | object | Required within parent | Additional keys: not allowed |
$ (anyOf 24).to_do.checked | boolean | Optional | |
$ (anyOf 24).to_do.color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
$ (anyOf 24).to_do.rich_text | array | Required within parent | Maximum items: 100 |
$ (anyOf 24).to_do.rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
$ (anyOf 24).type | string | Optional | Must equal: to_do |
$ (anyOf 25) | object | Alternative | Additional keys: not allowed |
$ (anyOf 25).object | string | Optional | Must equal: block |
$ (anyOf 25).toggle | Model | Required within parent | Expand Update a block — request body — body value type quote quote |
$ (anyOf 25).type | string | Optional | Must equal: toggle |
$ (anyOf 26) | object | Alternative | Additional keys: not allowed |
$ (anyOf 26).object | string | Optional | Must equal: block |
$ (anyOf 26).template | Model | Required within parent | Expand Update a block — request body — body value type template template |
$ (anyOf 26).type | string | Optional | Must equal: template |
$ (anyOf 27) | object | Alternative | Additional keys: not allowed |
$ (anyOf 27).callout | object | Required within parent | Additional keys: not allowed |
$ (anyOf 27).callout.color | Model | Optional | Expand Update a block — request body — body value type quote quote color |
$ (anyOf 27).callout.icon | Model | Optional | Expand Create a database — request body — body icon |
$ (anyOf 27).callout.rich_text | array | Required within parent | Maximum items: 100 |
$ (anyOf 27).callout.rich_text[] | Model | Each item | Expand Create a database — request body — body title item |
$ (anyOf 27).object | string | Optional | Must equal: block |
$ (anyOf 27).type | string | Optional | Must equal: callout |
$ (anyOf 28) | object | Alternative | Additional keys: not allowed |
$ (anyOf 28).object | string | Optional | Must equal: block |
$ (anyOf 28).synced_block | object | Required within parent | Additional keys: not allowed |
$ (anyOf 28).synced_block.synced_from | object or null | Required within parent | Additional keys: not allowed |
$ (anyOf 28).synced_block.synced_from.block_id | string | Required within parent | |
$ (anyOf 28).synced_block.synced_from.type | string | Optional | Must equal: block_id |
$ (anyOf 28).type | string | Optional | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
children | array | Required within parent | Maximum items: 100 Minimum items: 1 |
children[] | Model | Each item | Expand Create a page — request body — body content item object block, type table table children item |
has_column_header | boolean | Optional | |
has_row_header | boolean | Optional | |
table_width | integer | Required within parent | Minimum: 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
object | string | Optional | Must equal: block |
table_row | Model | Required within parent | Expand Update a block — request body — body value type table row table row |
type | string | Optional | Must equal: table_row |
Referenced models: Update a block — request body — body value type table row table row
Create a page — request body — body position
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1).after_block | object | Required within parent | |
$ (anyOf 1).after_block.id | string | Required within parent | |
$ (anyOf 1).type | string | Required within parent | Must equal: after_block |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2).type | string | Required within parent | Must equal: page_start |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3).type | string | Required within parent | Must equal: page_end |
Retrieve a page as markdown — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
id | string | Required within parent | The ID of the page or block. Format: uuid |
markdown | string | Required within parent | The 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). |
object | string | Required within parent | The type of object, always 'page_markdown'. Must equal: page_markdown |
truncated | boolean | Required within parent | Whether the content was truncated due to exceeding the record count limit. |
unknown_block_ids | array | Required within parent | Block 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[] | string | Each item | Format: uuid |
warnings | array | Optional | Content warnings from a synchronous update. Returned only when there is at least one warning. Maximum items: 100 |
warnings[] | object | Each item | Additional keys: allowed |
warnings[].code | string | Required within parent | The warning category, for example `unsupported_tag` or `no_match`. |
warnings[].message | string | Required within parent | What the request changed, ignored, or could not match. |
Retrieve a page property item — response body — Property Item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
has_more | boolean | Required within parent | |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | |
next_cursor (anyOf 2) | null | Alternative | |
object | string | Required within parent | Must equal: list |
property_item | JSON | Required within parent | |
property_item (anyOf 1) | object | Alternative | |
property_item (anyOf 1).id | string | Required within parent | |
property_item (anyOf 1).next_url | JSON | Required within parent | |
property_item (anyOf 1).next_url (anyOf 1) | string | Alternative | |
property_item (anyOf 1).next_url (anyOf 2) | null | Alternative | |
property_item (anyOf 1).title | Model | Required within parent | Expand List views — response body — view |
property_item (anyOf 1).type | string | Required within parent | Must equal: title |
property_item (anyOf 2) | object | Alternative | |
property_item (anyOf 2).id | string | Required within parent | |
property_item (anyOf 2).next_url | JSON | Required within parent | |
property_item (anyOf 2).next_url (anyOf 1) | string | Alternative | |
property_item (anyOf 2).next_url (anyOf 2) | null | Alternative | |
property_item (anyOf 2).rich_text | Model | Required within parent | Expand List views — response body — view |
property_item (anyOf 2).type | string | Required within parent | Must equal: rich_text |
property_item (anyOf 3) | object | Alternative | |
property_item (anyOf 3).id | string | Required within parent | |
property_item (anyOf 3).next_url | JSON | Required within parent | |
property_item (anyOf 3).next_url (anyOf 1) | string | Alternative | |
property_item (anyOf 3).next_url (anyOf 2) | null | Alternative | |
property_item (anyOf 3).people | Model | Required within parent | Expand List views — response body — view |
property_item (anyOf 3).type | string | Required within parent | Must equal: people |
property_item (anyOf 4) | object | Alternative | |
property_item (anyOf 4).id | string | Required within parent | |
property_item (anyOf 4).next_url | JSON | Required within parent | |
property_item (anyOf 4).next_url (anyOf 1) | string | Alternative | |
property_item (anyOf 4).next_url (anyOf 2) | null | Alternative | |
property_item (anyOf 4).relation | Model | Required within parent | Expand List views — response body — view |
property_item (anyOf 4).type | string | Required within parent | Must equal: relation |
property_item (anyOf 5) | object | Alternative | |
property_item (anyOf 5).id | string | Required within parent | |
property_item (anyOf 5).next_url | JSON | Required within parent | |
property_item (anyOf 5).next_url (anyOf 1) | string | Alternative | |
property_item (anyOf 5).next_url (anyOf 2) | null | Alternative | |
property_item (anyOf 5).rollup | JSON | Required within parent | |
property_item (anyOf 5).rollup (anyOf 1) | Model | Alternative | Expand Retrieve a page property item — response body — value Rollup rollup type number |
property_item (anyOf 5).rollup (anyOf 2) | Model | Alternative | Expand Retrieve a page property item — response body — value Rollup rollup type date |
property_item (anyOf 5).rollup (anyOf 3) | Model | Alternative | Expand Retrieve a page property item — response body — value Rollup rollup type array |
property_item (anyOf 5).rollup (anyOf 4) | Model | Alternative | Expand Retrieve a page property item — response body — value Rollup rollup type unsupported |
property_item (anyOf 5).rollup (anyOf 5) | Model | Alternative | Expand Retrieve a page property item — response body — value Rollup rollup type incomplete |
property_item (anyOf 5).type | string | Required within parent | Must equal: rollup |
results | array | Required within parent | |
results[] | Model | Each item | Expand Retrieve a page property item — response body — value |
type | string | Required within parent | Must 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
button | Model | Required within parent | Expand List views — response body — view |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
type | string | Required within parent | Must equal: button |
Referenced models: List views — response body — view
Retrieve a page property item — response body — value Checkbox
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
checkbox | boolean | Required within parent | |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
type | string | Required within parent | Must equal: checkbox |
Retrieve a page property item — response body — value Created By
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_by | JSON | Required within parent | |
created_by (anyOf 1) | Model | Alternative | Expand Update page — response body — object page created by |
created_by (anyOf 2) | Model | Alternative | Expand Retrieve a user — response body |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
type | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_time | string | Required within parent | Format: date-time |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
type | string | Required within parent | Must equal: created_time |
Retrieve a page property item — response body — value Date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date | JSON | Required within parent | |
date (anyOf 1) | Model | Alternative | Expand Retrieve a page property item — response body — value Date date end, start, time zone |
date (anyOf 2) | null | Alternative | |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
type | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
end | JSON | Required within parent | The end date of the date object, if any. |
end (anyOf 1) | string | Alternative | Format: date |
end (anyOf 2) | string | Alternative | Format: 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) | string | Alternative | Pattern: ^\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) | null | Alternative | |
start | JSON | Required within parent | The start date of the date object. |
start (anyOf 1) | string | Alternative | Format: date |
start (anyOf 2) | string | Alternative | Format: 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) | string | Alternative | Pattern: ^\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_zone | JSON | Required within parent | The time zone of the date object. |
time_zone (anyOf 1) | string | Alternative | |
time_zone (anyOf 2) | null | Alternative |
Retrieve a page property item — response body — value Email
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | JSON | Required within parent | |
email (anyOf 1) | string | Alternative | |
email (anyOf 2) | null | Alternative | |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
type | string | Required within parent | Must equal: email |
Retrieve a page property item — response body — value Files
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
files | array | Required within parent | Maximum items: 100 |
files[] | Model | Each item | Expand Retrieve a page property item — response body — value Files files item |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
type | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Retrieve a page property item — response body — value Files files item name |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2) (anyOf 1) | Model | Alternative | Expand Retrieve a page property item — response body — value Files files item value File |
$ (allOf 2) (anyOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
name | string | Required within parent | The name of the file. |
Retrieve a page property item — response body — value Files files item value External
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
external | object | Required within parent | The external URL. Additional keys: allowed |
external.url | string | Required within parent | The URL of the external file or resource. |
type | string | Required within parent | Type of attachment. In this case, an external URL. Must equal: external |
Retrieve a page property item — response body — value Files files item value File
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
file | Model | Required within parent | Expand Get agent — response body — icon value File file The file URL. |
type | string | Required within parent | Type 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
formula | Model | Required within parent | Expand Retrieve a page property item — response body — value Formula formula |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
type | string | Required within parent | Must equal: formula |
Referenced models: Retrieve a page property item — response body — value Formula formula
Retrieve a page property item — response body — value Formula formula
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Retrieve a page property item — response body — value Formula formula String |
$ (anyOf 2) | Model | Alternative | Expand Retrieve a page property item — response body — value Formula formula Date |
$ (anyOf 3) | Model | Alternative | Expand Retrieve a page property item — response body — value Formula formula Number |
$ (anyOf 4) | Model | Alternative | Expand Retrieve a page property item — response body — value Formula formula Boolean |
$ (anyOf 5) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
boolean | JSON | Required within parent | |
boolean (anyOf 1) | boolean | Alternative | |
boolean (anyOf 2) | null | Alternative | |
type | string | Required within parent | Must equal: boolean |
Retrieve a page property item — response body — value Formula formula Date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date | JSON | Required within parent | |
date (anyOf 1) | Model | Alternative | Expand Retrieve a page property item — response body — value Date date end, start, time zone |
date (anyOf 2) | null | Alternative | |
type | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
number | JSON | Required within parent | |
number (anyOf 1) | JSON | Alternative | |
number (anyOf 1) (anyOf 1) | number | Alternative | |
number (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number (anyOf 2) | null | Alternative | |
type | string | Required within parent | Must equal: number |
Retrieve a page property item — response body — value Formula formula String
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
string | JSON | Required within parent | |
string (anyOf 1) | string | Alternative | |
string (anyOf 2) | null | Alternative | |
type | string | Required within parent | Must equal: string |
Retrieve a page property item — response body — value Formula formula Unsupported
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Required within parent | Must equal: unsupported |
unsupported | Model | Required within parent | Expand List views — response body — view |
Referenced models: List views — response body — view
Retrieve a page property item — response body — value Last Edited By
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
last_edited_by | JSON | Required within parent | |
last_edited_by (anyOf 1) | Model | Alternative | Expand Update page — response body — object page created by |
last_edited_by (anyOf 2) | Model | Alternative | Expand Retrieve a user — response body |
object | string | Required within parent | Must equal: property_item |
type | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
last_edited_time | string | Required within parent | Format: date-time |
object | string | Required within parent | Must equal: property_item |
type | string | Required within parent | Must equal: last_edited_time |
Retrieve a page property item — response body — value Multi Select
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
multi_select | array | Required within parent | Maximum items: 100 |
multi_select[] | Model | Each item | Expand Retrieve a page property item — response body — value Multi Select multi select item |
object | string | Required within parent | Must equal: property_item |
type | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
color | string | Required within parent | One of: `default`, `gray`, `brown`, `orange`, `yellow`, `green`, `blue`, `purple`, `pink`, `red` Known values: default, gray, brown, orange, yellow, green, blue, purple, pink, red |
id | string | Required within parent | |
name | string | Required within parent |
Retrieve a page property item — response body — value Number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
number | JSON | Required within parent | |
number (anyOf 1) | JSON | Alternative | |
number (anyOf 1) (anyOf 1) | number | Alternative | |
number (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number (anyOf 2) | null | Alternative | |
object | string | Required within parent | Must equal: property_item |
type | string | Required within parent | Must equal: number |
Retrieve a page property item — response body — value People
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
people | JSON | Required within parent | |
people (anyOf 1) | Model | Alternative | Expand Update page — response body — object page created by |
people (anyOf 2) | Model | Alternative | Expand Retrieve a user — response body |
type | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
phone_number | JSON | Required within parent | |
phone_number (anyOf 1) | string | Alternative | |
phone_number (anyOf 2) | null | Alternative | |
type | string | Required within parent | Must equal: phone_number |
Retrieve a page property item — response body — value Place
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
place | JSON | Required within parent | |
place (anyOf 1) | object | Alternative | |
place (anyOf 1).address | JSON | Optional | |
place (anyOf 1).address (anyOf 1) | string | Alternative | |
place (anyOf 1).address (anyOf 2) | null | Alternative | |
place (anyOf 1).aws_place_id | JSON | Optional | |
place (anyOf 1).aws_place_id (anyOf 1) | string | Alternative | |
place (anyOf 1).aws_place_id (anyOf 2) | null | Alternative | |
place (anyOf 1).google_place_id | JSON | Optional | |
place (anyOf 1).google_place_id (anyOf 1) | string | Alternative | |
place (anyOf 1).google_place_id (anyOf 2) | null | Alternative | |
place (anyOf 1).lat | JSON | Required within parent | |
place (anyOf 1).lat (anyOf 1) | number | Alternative | |
place (anyOf 1).lat (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
place (anyOf 1).lon | JSON | Required within parent | |
place (anyOf 1).lon (anyOf 1) | number | Alternative | |
place (anyOf 1).lon (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
place (anyOf 1).name | JSON | Optional | |
place (anyOf 1).name (anyOf 1) | string | Alternative | |
place (anyOf 1).name (anyOf 2) | null | Alternative | |
place (anyOf 2) | null | Alternative | |
place (anyOf 2).address | JSON | Optional | |
place (anyOf 2).address (anyOf 1) | string | Alternative | |
place (anyOf 2).address (anyOf 2) | null | Alternative | |
place (anyOf 2).aws_place_id | JSON | Optional | |
place (anyOf 2).aws_place_id (anyOf 1) | string | Alternative | |
place (anyOf 2).aws_place_id (anyOf 2) | null | Alternative | |
place (anyOf 2).google_place_id | JSON | Optional | |
place (anyOf 2).google_place_id (anyOf 1) | string | Alternative | |
place (anyOf 2).google_place_id (anyOf 2) | null | Alternative | |
place (anyOf 2).lat | JSON | Required within parent | |
place (anyOf 2).lat (anyOf 1) | number | Alternative | |
place (anyOf 2).lat (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
place (anyOf 2).lon | JSON | Required within parent | |
place (anyOf 2).lon (anyOf 1) | number | Alternative | |
place (anyOf 2).lon (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
place (anyOf 2).name | JSON | Optional | |
place (anyOf 2).name (anyOf 1) | string | Alternative | |
place (anyOf 2).name (anyOf 2) | null | Alternative | |
type | string | Required within parent | Must equal: place |
Retrieve a page property item — response body — value Relation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
relation | object | Required within parent | |
relation.id | string | Required within parent | Format: uuid |
type | string | Required within parent | Must equal: relation |
Retrieve a page property item — response body — value Rich Text
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
rich_text | Model | Required within parent | Expand Retrieve a page property item — response body — value Title title |
type | string | Required within parent | Must equal: rich_text |
Referenced models: Retrieve a page property item — response body — value Title title
Retrieve a page property item — response body — value Rollup
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
rollup | JSON | Required within parent | |
rollup (anyOf 1) | Model | Alternative | Expand Retrieve a page property item — response body — value Rollup rollup type number |
rollup (anyOf 2) | Model | Alternative | Expand Retrieve a page property item — response body — value Rollup rollup type date |
rollup (anyOf 3) | Model | Alternative | Expand Retrieve a page property item — response body — value Rollup rollup type array |
rollup (anyOf 4) | Model | Alternative | Expand Retrieve a page property item — response body — value Rollup rollup type unsupported |
rollup (anyOf 5) | Model | Alternative | Expand Retrieve a page property item — response body — value Rollup rollup type incomplete |
type | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
array | array | Required within parent | Maximum items: 100 |
array[] | Model | Each item | Expand List views — response body — view |
function | string | Required within parent | Known 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 |
type | string | Required within parent | Must equal: array |
Referenced models: List views — response body — view
Retrieve a page property item — response body — value Rollup rollup type date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date | JSON | Required within parent | |
date (anyOf 1) | Model | Alternative | Expand Retrieve a page property item — response body — value Date date end, start, time zone |
date (anyOf 2) | null | Alternative | |
function | string | Required within parent | Known 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 |
type | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
function | string | Required within parent | Known 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 |
incomplete | Model | Required within parent | Expand List views — response body — view |
type | string | Required within parent | Must equal: incomplete |
Referenced models: List views — response body — view
Retrieve a page property item — response body — value Rollup rollup type number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
function | string | Required within parent | Known 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 |
number | JSON | Required within parent | |
number (anyOf 1) | JSON | Alternative | |
number (anyOf 1) (anyOf 1) | number | Alternative | |
number (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
number (anyOf 2) | null | Alternative | |
type | string | Required within parent | Must equal: number |
Retrieve a page property item — response body — value Rollup rollup type unsupported
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
function | string | Required within parent | Known 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 |
type | string | Required within parent | Must equal: unsupported |
unsupported | Model | Required within parent | Expand List views — response body — view |
Referenced models: List views — response body — view
Retrieve a page property item — response body — value Select
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
select | JSON | Required within parent | |
select (anyOf 1) | Model | Alternative | Expand Retrieve a page property item — response body — value Multi Select multi select item |
select (anyOf 2) | null | Alternative | |
type | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
status | JSON | Required within parent | |
status (anyOf 1) | Model | Alternative | Expand Retrieve a page property item — response body — value Multi Select multi select item |
status (anyOf 2) | null | Alternative | |
type | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | |
object | string | Required within parent | Must equal: property_item |
title | Model | Required within parent | Expand Retrieve a page property item — response body — value Title title |
type | string | Required within parent | Must equal: title |
Referenced models: Retrieve a page property item — response body — value Title title
Retrieve a page property item — response body — value Title title
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Retrieve a page property item — response body — value Title title annotations, href, plain text |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 2) (anyOf 1) | Model | Alternative | Expand Retrieve a page property item — response body — value Title title value Text |
$ (allOf 2) (anyOf 2) | Model | Alternative | Expand Retrieve a page property item — response body — value Title title value Mention |
$ (allOf 2) (anyOf 3) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
annotations | Model | Required within parent | Expand 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. |
href | JSON | Required within parent | A URL that the rich text object links to or mentions. |
href (anyOf 1) | string | Alternative | |
href (anyOf 2) | null | Alternative | |
plain_text | string | Required within parent | The 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