@udus/notion-renderer
Version:
50 lines • 53 kB
JSON
{
"object": "block",
"id": "0ef6015c-4d37-4922-9014-fe40b526c7e3",
"parent": {
"type": "page_id",
"page_id": "2712e341-754a-41ae-a9ce-4c0bb4b18c52"
},
"created_time": "2023-03-18T12:21:00.000Z",
"last_edited_time": "2023-10-07T07:04:00.000Z",
"created_by": {
"object": "user",
"id": "e0446ede-dde6-457c-b535-d2b19f40b45a"
},
"last_edited_by": {
"object": "user",
"id": "e0446ede-dde6-457c-b535-d2b19f40b45a"
},
"has_children": false,
"archived": false,
"type": "bookmark",
"bookmark": {
"caption": [
{
"type": "text",
"text": {
"content": "this is bookmark caption",
"link": null
},
"annotations": {
"bold": false,
"italic": false,
"strikethrough": false,
"underline": false,
"code": false,
"color": "default"
},
"plain_text": "this is bookmark caption",
"href": null
}
],
"url": "https://developers.notion.com/reference/block#block-type-objects",
"site_meta": {
"url": "https://developers.notion.com/reference/block",
"title": "Start building with the Notion API",
"description": "A block object represents a piece of content within Notion. The API translates the headings, toggles, paragraphs, lists, media, and more that you can interact with in the Notion UI as different block type...",
"links": [
"https://developers.notion.com/reference/block"
],
"image": "https://files.readme.io/a507683-developer-portal-meta.png",
"content": "<div><p>A block object represents a piece of content within Notion. The API translates the headings, toggles, paragraphs, lists, media, and more that you can interact with in the Notion UI as different <a target=\"_blank\" href=\"https://developers.notion.com/reference/block#block-type-objects\">block type objects</a>. </p>\n<p> For example, the following block object represents a <code>Heading 2</code> in the Notion UI:</p>\n<div><pre><code>{\n\t\"object\": \"block\",\n\t\"id\": \"c02fc1d3-db8b-45c5-a222-27595b15aea7\",\n\t\"parent\": {\n\t\t\"type\": \"page_id\",\n\t\t\"page_id\": \"59833787-2cf9-4fdf-8782-e53db20768a5\"\n\t},\n\t\"created_time\": \"2022-03-01T19:05:00.000Z\",\n\t\"last_edited_time\": \"2022-07-06T19:41:00.000Z\",\n\t\"created_by\": {\n\t\t\"object\": \"user\",\n\t\t\"id\": \"ee5f0f84-409a-440f-983a-a5315961c6e4\"\n\t},\n\t\"last_edited_by\": {\n\t\t\"object\": \"user\",\n\t\t\"id\": \"ee5f0f84-409a-440f-983a-a5315961c6e4\"\n\t},\n\t\"has_children\": false,\n\t\"archived\": false,\n\t\"type\": \"heading_2\",\n\t\"heading_2\": {\n\t\t\"rich_text\": [\n\t\t\t{\n\t\t\t\t\"type\": \"text\",\n\t\t\t\t\"text\": {\n\t\t\t\t\t\"content\": \"Lacinato kale\",\n\t\t\t\t\t\"link\": null\n\t\t\t\t},\n\t\t\t\t\"annotations\": {\n\t\t\t\t\t\"bold\": false,\n\t\t\t\t\t\"italic\": false,\n\t\t\t\t\t\"strikethrough\": false,\n\t\t\t\t\t\"underline\": false,\n\t\t\t\t\t\"code\": false,\n\t\t\t\t\t\"color\": \"green\"\n\t\t\t\t},\n\t\t\t\t\"plain_text\": \"Lacinato kale\",\n\t\t\t\t\"href\": null\n\t\t\t}\n\t\t],\n\t\t\"color\": \"default\",\n \"is_toggleable\": false\n\t}\n}\n</code></pre></div>\n<p>Use the <a target=\"_blank\" href=\"https://developers.notion.com/reference/get-block-children\">Retrieve block children</a> endpoint to list all of the blocks on a page. </p>\n<blockquote><p><span>📘</span></p><p>Fields marked with an * are available to integrations with any capabilities. Other properties require read content capabilities in order to be returned from the Notion API. Consult the <a target=\"_blank\" href=\"https://developers.notion.com/reference/capabilities\">integration capabilities reference</a> for details.</p></blockquote>\n<p>Some block types contain nested blocks. The following block types support child blocks: </p>\n<ul>\n<li><a target=\"_blank\" href=\"https://developers.notion.com/reference/block#bulleted-list-item\">Bulleted list item</a></li>\n<li><a target=\"_blank\" href=\"https://developers.notion.com/reference/block#callout\">Callout</a> </li>\n<li><a target=\"_blank\" href=\"https://developers.notion.com/reference/block#child-database\">Child database</a></li>\n<li><a target=\"_blank\" href=\"https://developers.notion.com/reference/block#child-page\">Child page</a></li>\n<li><a target=\"_blank\" href=\"https://developers.notion.com/reference/block#column-list-and-column\">Column</a></li>\n<li><a target=\"_blank\" href=\"https://developers.notion.com/reference/block#heading-1\">Heading 1</a>, when the <code>is_toggleable</code> property is <code>true</code></li>\n<li><a target=\"_blank\" href=\"https://developers.notion.com/reference/block#heading-2\">Heading 2</a>, when the <code>is_toggleable</code> property is <code>true</code></li>\n<li><a target=\"_blank\" href=\"https://developers.notion.com/reference/block#heading-3\">Heading 3</a>, when the <code>is_toggleable</code> property is <code>true</code></li>\n<li><a target=\"_blank\" href=\"https://developers.notion.com/reference/block#numbered-list-item\">Numbered list item</a></li>\n<li><a target=\"_blank\" href=\"https://developers.notion.com/reference/block#paragraph\">Paragraph</a> </li>\n<li><a target=\"_blank\" href=\"https://developers.notion.com/reference/block#quote\">Quote</a></li>\n<li><a target=\"_blank\" href=\"https://developers.notion.com/reference/block#synced-block\">Synced block</a></li>\n<li><a target=\"_blank\" href=\"https://developers.notion.com/reference/block#table\">Table</a></li>\n<li><a target=\"_blank\" href=\"https://developers.notion.com/reference/block#template\">Template</a></li>\n<li><a target=\"_blank\" href=\"https://developers.notion.com/reference/block#to-do\">To do</a></li>\n<li><a target=\"_blank\" href=\"https://developers.notion.com/reference/block#toggle-blocks\">Toggle</a> </li>\n</ul>\n<blockquote><p><span>📘</span></p><p>The API does not support all block types.</p><p>Only the block type objects listed in the reference below are supported. Any unsupported block types appear in the structure, but contain a <code>type</code> set to <code>\"unsupported\"</code>.</p></blockquote>\n<p>Every block object has a key corresponding to the value of <code>type</code>. Under the key is an object with type-specific block information.</p>\n<blockquote><p><span>📘</span></p><p>Many block types support rich text. In cases where it is supported, a <a target=\"_blank\" href=\"https://developers.notion.com/reference/rich-text\"><code>rich_text</code> object</a> will be included in the block <code>type</code> object. All <code>rich_text</code> objects will include a <code>plain_text</code> property, which provides a convenient way for developers to access unformatted text from the Notion block.</p></blockquote>\n<p>Bookmark block objects contain the following information within the <code>bookmark</code> property:</p>\n<div><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>caption</code></td><td>array of <a target=\"_blank\" href=\"https://developers.notion.com/reference/rich-text\">rich text objects</a> text</td><td>The caption for the bookmark.</td></tr><tr><td><code>url</code></td><td>string</td><td>The link for the bookmark.</td></tr></tbody></table></div>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"bookmark\",\n //...other keys excluded\n \"bookmark\": {\n \"caption\": [],\n \"url\": \"https://companywebsite.com\"\n }\n}\n</code></pre></div>\n<p>Breadcrumb block objects do not contain any information within the <code>breadcrumb</code> property.</p>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"breadcrumb\",\n //...other keys excluded\n \"breadcrumb\": {}\n}\n</code></pre></div>\n<p>Bulleted list item block objects contain the following information within the <code>bulleted_list_item</code> property:</p>\n<div><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>rich_text</code></td><td><code>array</code> of <a target=\"_blank\" href=\"https://developers.notion.com/reference/rich-text\">rich text objects</a></td><td>The rich text in the <code>bulleted_list_item</code> block.</td></tr><tr><td><code>color</code></td><td><code>string</code> (enum)</td><td>The color of the block. Possible values are:<p>\n- <code>\"blue\"</code><br />\n- <code>\"blue_background\"</code><br />\n- <code>\"brown\"</code><br />\n- <code>\"brown_background\"</code><br />\n- <code>\"default\"</code><br />\n- <code>\"gray\"</code><br />\n- <code>\"gray_background\"</code><br />\n- <code>\"green\"</code><br />\n- <code>\"green_background\"</code><br />\n- <code>\"orange\"</code><br />\n- <code>\"orange_background\"</code><br />\n- <code>\"yellow\"</code><br />\n- <code>\"green\"</code><br />\n- <code>\"pink\"</code><br />\n- <code>\"pink_background\"</code><br />\n- <code>\"purple\"</code><br />\n- <code>\"purple_background\"</code><br />\n- <code>\"red\"</code><br />\n- <code>\"red_background\"</code><br />\n- <code>\"yellow_background\"</code></p></td></tr><tr><td><code>children</code></td><td><code>array</code> of <a target=\"_blank\" href=\"https://developers.notion.com/reference/block\">block objects</a></td><td>The nested child blocks (if any) of the <code>bulleted_list_item</code> block.</td></tr></tbody></table></div>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"bulleted_list_item\",\n //...other keys excluded\n \"bulleted_list_item\": {\n \"rich_text\": [{\n \"type\": \"text\",\n \"text\": {\n \"content\": \"Lacinato kale\",\n \"link\": null\n }\n // ..other keys excluded\n }],\n \"color\": \"default\",\n \"children\":[{\n \"type\": \"paragraph\"\n // ..other keys excluded\n }]\n }\n}\n</code></pre></div>\n<p>Callout block objects contain the following information within the <code>callout</code> property:</p>\n<div><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>rich_text</code></td><td><code>array</code> of <a target=\"_blank\" href=\"https://developers.notion.com/reference/rich-text\">rich text objects</a></td><td>The rich text in the <code>callout</code> block.</td></tr><tr><td><code>icon</code></td><td><code>object</code></td><td>An <a target=\"_blank\" href=\"https://developers.notion.com/reference/emoji-object\">emoji</a> or <a target=\"_blank\" href=\"https://developers.notion.com/reference/file-object\">file</a> object that represents the callout's icon. If the callout does not have an icon.</td></tr><tr><td><code>color</code></td><td><code>string</code> (enum)</td><td>The color of the block. Possible values are:<p>\n- <code>\"blue\"</code><br />\n- <code>\"blue_background\"</code><br />\n- <code>\"brown\"</code><br />\n- <code>\"brown_background\"</code><br />\n- <code>\"default\"</code><br />\n- <code>\"gray\"</code><br />\n- <code>\"gray_background\"</code><br />\n- <code>\"green\"</code><br />\n- <code>\"green_background\"</code><br />\n- <code>\"orange\"</code><br />\n- <code>\"orange_background\"</code><br />\n- <code>\"yellow\"</code><br />\n- <code>\"green\"</code><br />\n- <code>\"pink\"</code><br />\n- <code>\"pink_background\"</code><br />\n- <code>\"purple\"</code><br />\n- <code>\"purple_background\"</code><br />\n- <code>\"red\"</code><br />\n- <code>\"red_background\"</code><br />\n- <code>\"yellow_background\"</code></p></td></tr></tbody></table></div>\n<div><pre><code>{\n //...other keys excluded\n\t\"type\": \"callout\",\n // ..other keys excluded\n \"callout\": {\n \t\"rich_text\": [{\n \"type\": \"text\",\n \"text\": {\n \"content\": \"Lacinato kale\",\n \"link\": null\n }\n // ..other keys excluded\n }],\n \"icon\": {\n \"emoji\": \"⭐\"\n },\n \"color\": \"default\"\n }\n}\n</code></pre></div>\n<p>Child database block objects contain the following information within the <code>child_database</code> property:</p>\n<div><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>title</code></td><td><code>string</code></td><td>The plain text title of the database.</td></tr></tbody></table></div>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"child_database\",\n //...other keys excluded\n \"child_database\": {\n \"title\": \"My database\"\n }\n}\n</code></pre></div>\n<blockquote><p><span>📘</span></p><p>Creating and updating <code>child_database</code> blocks</p><p>To create or update <code>child_database</code> type blocks, use the <a target=\"_blank\" href=\"https://developers.notion.com/reference/create-a-database\">Create a database</a> and the <a target=\"_blank\" href=\"https://developers.notion.com/reference/update-a-database\">Update a database</a> endpoints, specifying the ID of the parent page in the <code>parent</code> body param.</p></blockquote>\n<p>Child page block objects contain the following information within the <code>child_page</code> property:</p>\n<div><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>title</code></td><td><code>string</code></td><td>The plain text <code>title</code> of the page.</td></tr></tbody></table></div>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"child_page\",\n //...other keys excluded\n \"child_page\": {\n \"title\": \"Lacinato kale\"\n }\n}\n</code></pre></div>\n<blockquote><p><span>📘</span></p><p>Creating and updating <code>child_page</code> blocks</p><p>To create or update <code>child_page</code> type blocks, use the <a target=\"_blank\" href=\"https://developers.notion.com/reference/post-page\">Create a page</a> and the <a target=\"_blank\" href=\"https://developers.notion.com/reference/patch-page\">Update page</a> endpoints, specifying the ID of the parent page in the <code>parent</code> body param.</p></blockquote>\n<p>Code block objects contain the following information within the <code>code</code> property:</p>\n<div><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>caption</code></td><td><code>array</code> of <a target=\"_blank\" href=\"https://developers.notion.com/reference/rich-text\">Rich text object</a> text objects</td><td>The rich text in the caption of the code block.</td></tr><tr><td><code>rich_text</code></td><td><code>array</code> of <a target=\"_blank\" href=\"https://developers.notion.com/reference/rich-text\">Rich text object</a> text objects</td><td>The rich text in the code block.</td></tr><tr><td><code>language</code></td><td>- <code>\"abap\"</code><br />\n- <code>\"arduino\"</code><br />\n- <code>\"bash\"</code><br />\n- <code>\"basic\"</code><br />\n- <code>\"c\"</code><br />\n- <code>\"clojure\"</code><br />\n- <code>\"coffeescript\"</code><br />\n- <code>\"c++\"</code><br />\n- <code>\"c#\"</code><br />\n- <code>\"css\"</code><br />\n- <code>\"dart\"</code><br />\n- <code>\"diff\"</code><br />\n- <code>\"docker\"</code><br />\n- <code>\"elixir\"</code><br />\n- <code>\"elm\"</code><br />\n- <code>\"erlang\"</code><br />\n- <code>\"flow\"</code><br />\n- <code>\"fortran\"</code><br />\n- <code>\"f#\"</code><br />\n- <code>\"gherkin\"</code><br />\n- <code>\"glsl\"</code><br />\n- <code>\"go\"</code><br />\n- <code>\"graphql\"</code><br />\n- <code>\"groovy\"</code><br />\n- <code>\"haskell\"</code><br />\n- <code>\"html\"</code><br />\n- <code>\"java\"</code><br />\n- <code>\"javascript\"</code><br />\n- <code>\"json\"</code><br />\n- <code>\"julia\"</code><br />\n- <code>\"kotlin\"</code><br />\n- <code>\"latex\"</code><br />\n- <code>\"less\"</code><br />\n- <code>\"lisp\"</code><br />\n- <code>\"livescript\"</code><br />\n- <code>\"lua\"</code><br />\n- <code>\"makefile\"</code><br />\n- <code>\"markdown\"</code><br />\n- <code>\"markup\"</code><br />\n- <code>\"matlab\"</code><br />\n- <code>\"mermaid\"</code><br />\n- <code>\"nix\"</code><br />\n- <code>\"objective-c\"</code><br />\n- <code>\"ocaml\"</code><br />\n- <code>\"pascal\"</code><br />\n- <code>\"perl\"</code><br />\n- <code>\"php\"</code><br />\n- <code>\"plain text\"</code><br />\n- <code>\"powershell\"</code><br />\n- <code>\"prolog\"</code><br />\n- <code>\"protobuf\"</code><br />\n- <code>\"python\"</code><br />\n- <code>\"r\"</code><br />\n- <code>\"reason\"</code><br />\n- <code>\"ruby\"</code><br />\n- <code>\"rust\"</code><br />\n- <code>\"sass\"</code><br />\n- <code>\"scala\"</code><br />\n- <code>\"scheme\"</code><br />\n- <code>\"scss\"</code><br />\n- <code>\"shell\"</code><br />\n- <code>\"sql\"</code><br />\n- <code>\"swift\"</code><br />\n- <code>\"typescript\"</code><br />\n- <code>\"vb.net\"</code><br />\n- <code>\"verilog\"</code><br />\n- <code>\"vhdl\"</code><br />\n- <code>\"visual basic\"</code><br />\n- <code>\"webassembly\"</code><br />\n- <code>\"xml\"</code><br />\n- <code>\"yaml\"</code><br />\n- <code>\"java/c/c++/c#\"</code></td><td>The language of the code contained in the code block.</td></tr></tbody></table></div>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"code\",\n //...other keys excluded\n \"code\": {\n \t\"caption\": [],\n \t\t\"rich_text\": [{\n \"type\": \"text\",\n \"text\": {\n \"content\": \"const a = 3\"\n }\n }],\n \"language\": \"javascript\"\n }\n}\n</code></pre></div>\n<p>Column lists are parent blocks for columns. They do not contain any information within the <code>column_list</code> property. </p>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"column_list\",\n //...other keys excluded\n \"column_list\": {}\n}\n</code></pre></div>\n<p>Columns are parent blocks for any block types listed in this reference except for other <code>column</code>s. They do not contain any information within the <code>column</code> property. They can only be appended to <code>column_list</code>s.</p>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"column\",\n //...other keys excluded\n \"column\": {}\n}\n</code></pre></div>\n<p>When creating a <code>column_list</code> block via <a target=\"_blank\" href=\"https://developers.notion.com/reference/patch-block-children\">Append block children</a>, the <code>column_list</code> must have at least two <code>column</code>s, and each <code>column</code> must have at least one child.</p>\n<p>Follow these steps to fetch the content in a <code>column_list</code>: </p>\n<ol>\n<li>\n<p>Get the <code>column_list</code> ID from a query to <a target=\"_blank\" href=\"https://developers.notion.com/reference/get-block-children\">Retrieve block children</a> for the parent page. </p>\n</li>\n<li>\n<p>Get the <code>column</code> children from a query to Retrieve block children for the <code>column_list</code>. </p>\n</li>\n<li>\n<p>Get the content in each individual <code>column</code> from a query to Retrieve block children for the unique <code>column</code> ID. </p>\n</li>\n</ol>\n<p>Divider block objects do not contain any information within the <code>divider</code> property.</p>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"divider\",\n //...other keys excluded\n \"divider\": {}\n}\n</code></pre></div>\n<p>Embed block objects include information about another website displayed within the Notion UI. The <code>embed</code> property contains the following information:</p>\n<div><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>url</code></td><td><code>string</code></td><td>The link to the website that the embed block displays.</td></tr></tbody></table></div>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"embed\",\n //...other keys excluded\n \"embed\": {\n \"url\": \"https://companywebsite.com\"\n }\n}\n</code></pre></div>\n<blockquote><p><span>🚧</span></p><p>Differences in embed blocks between the Notion app and the API</p><p>The Notion app uses a 3rd-party service, iFramely, to validate and request metadata for embeds given a URL. This works well in a web app because Notion can kick off an asynchronous request for URL information, which might take seconds or longer to complete, and then update the block with the metadata in the UI after receiving a response from iFramely.</p><p>We chose not to call iFramely when creating embed blocks in the API because the API needs to be able to return faster than the UI, and because the response from iFramely could actually cause us to change the block type. This would result in a slow and potentially confusing experience as the block in the response would not match the block sent in the request.</p><p>The result is that embed blocks created via the API may not look exactly like their counterparts created in the Notion app.</p></blockquote>\n<blockquote><p><span>👍</span></p><p>Vimeo video links can be embedded in a Notion page via the public API using the embed block type.</p><p>For example, the following object can be passed to the <a target=\"_blank\" href=\"https://developers.notion.com/reference/patch-block-children\">Append block children endpoint</a>:</p><div><pre><code>{\n \"children\": [\n {\n \"embed\": {\n \"url\": \"https://player.vimeo.com/video/226053498?h=a1599a8ee9\"\n }\n }\n ]\n}\n</code></pre></div><p>For other video sources, see <a target=\"_blank\" href=\"https://developers.notion.com/reference/block#supported-video-types\">Supported video types</a>.</p></blockquote>\n<p>Equation block objects are represented as children of <a target=\"_blank\" href=\"https://developers.notion.com/reference/block#paragraph\">paragraph</a> blocks. They are nested within a <a target=\"_blank\" href=\"https://developers.notion.com/reference/rich-text\">rich text object</a> and contain the following information within the <code>equation</code> property:</p>\n<div><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>expression</code></td><td><code>string</code></td><td>A KaTeX compatible string.</td></tr></tbody></table></div>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"equation\",\n //...other keys excluded\n \"equation\": {\n \"expression\": \"e=mc^2\"\n }\n}\n</code></pre></div>\n<p>File block objects contain the following information within the <code>file</code> property: </p>\n<div><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>caption</code></td><td><code>array</code> of <a target=\"_blank\" href=\"https://developers.notion.com/reference/rich-text\">rich text objects</a></td><td>The caption of the file block.</td></tr><tr><td><code>type</code></td><td><code>\"file\"</code><p><code>\"external\"</code></p></td><td>A constant string.</td></tr><tr><td><code>file</code></td><td><a target=\"_blank\" href=\"https://developers.notion.com/reference/file-object\">file object</a></td><td>A file object that details information about the file contained in the block.</td></tr></tbody></table></div>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"file\",\n //...other keys excluded\n \"file\": {\n\t\t\"caption\": [],\n \"type\": \"external\",\n \"external\": {\n \t \t\"url\": \"https://companywebsite.com/files/doc.txt\"\n }\n }\n}\n</code></pre></div>\n<p>All heading block objects, <code>heading_1</code>, <code>heading_2</code>, and <code>heading_3</code>, contain the following information within their corresponding objects:</p>\n<div><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>rich_text</code></td><td><code>array</code> of <a target=\"_blank\" href=\"https://developers.notion.com/reference/rich-text\">rich text objects</a></td><td>The rich text of the heading.</td></tr><tr><td><code>color</code></td><td><code>string</code> (enum)</td><td>The color of the block. Possible values are:<p>\n- <code>\"blue\"</code><br />\n- <code>\"blue_background\"</code><br />\n- <code>\"brown\"</code><br />\n- <code>\"brown_background\"</code><br />\n- <code>\"default\"</code><br />\n- <code>\"gray\"</code><br />\n- <code>\"gray_background\"</code><br />\n- <code>\"green\"</code><br />\n- <code>\"green_background\"</code><br />\n- <code>\"orange\"</code><br />\n- <code>\"orange_background\"</code><br />\n- <code>\"yellow\"</code><br />\n- <code>\"green\"</code><br />\n- <code>\"pink\"</code><br />\n- <code>\"pink_background\"</code><br />\n- <code>\"purple\"</code><br />\n- <code>\"purple_background\"</code><br />\n- <code>\"red\"</code><br />\n- <code>\"red_background\"</code><br />\n- <code>\"yellow_background\"</code></p></td></tr><tr><td><code>is_toggleable</code></td><td><code>boolean</code></td><td>Whether or not the heading block is a toggle heading or not. If <code>true</code>, then the heading block toggles and can support children. If <code>false</code>, then the heading block is a static heading block.</td></tr></tbody></table></div>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"heading_1\",\n //...other keys excluded\n \"heading_1\": {\n \"rich_text\": [{\n \"type\": \"text\",\n \"text\": {\n \"content\": \"Lacinato kale\",\n \"link\": null\n }\n }],\n \"color\": \"default\",\n \"is_toggleable\": false\n }\n}\n</code></pre></div>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"heading_2\",\n //...other keys excluded\n \"heading_2\": {\n \"rich_text\": [{\n \"type\": \"text\",\n \"text\": {\n \"content\": \"Lacinato kale\",\n \"link\": null\n }\n }],\n \"color\": \"default\",\n \"is_toggleable\": false\n }\n}\n</code></pre></div>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"heading_3\",\n //...other keys excluded\n \"heading_3\": {\n \"rich_text\": [{\n \"type\": \"text\",\n \"text\": {\n \"content\": \"Lacinato kale\",\n \"link\": null\n }\n }],\n \"color\": \"default\",\n \"is_toggleable\": false\n }\n}\n</code></pre></div>\n<p>Image block objects contain a <a target=\"_blank\" href=\"https://developers.notion.com/reference/file-object\">file object</a> detailing information about the image. </p>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"image\",\n //...other keys excluded\n \"image\": {\n \"type\": \"external\",\n \"external\": {\n \t \t\"url\": \"https://website.domain/images/image.png\"\n }\n }\n}\n</code></pre></div>\n<p>The image must be directly hosted. In other words, the <code>url</code> cannot point to a service that retrieves the image. The following image types are supported: </p>\n<ul>\n<li><code>.bmp</code></li>\n<li><code>.gif</code></li>\n<li><code>.heic</code></li>\n<li><code>.jpeg</code></li>\n<li><code>.jpg</code></li>\n<li><code>.png</code></li>\n<li><code>.svg</code></li>\n<li><code>.tif</code></li>\n<li><code>.tiff</code></li>\n</ul>\n<p><a target=\"_blank\" href=\"https://developers.notion.com/docs/link-previews\">Link Preview</a> block objects contain the originally pasted <code>url</code>:</p>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"link_preview\",\n //...other keys excluded\n \"link_preview\": {\n \"url\": \"https://github.com/example/example-repo/pull/1234\"\n }\n}\n</code></pre></div>\n<blockquote><p><span>🚧</span></p><p>The <code>link_preview</code> block can only be returned as part of a response. The API does not support creating or appending <code>link_preview</code> blocks.</p></blockquote>\n<p>A mention block object is a child of a <a target=\"_blank\" href=\"https://developers.notion.com/reference/rich-text\">rich text object</a> that is nested within a <a target=\"_blank\" href=\"https://developers.notion.com/reference/block#paragraph\">paragraph block object</a>. This block type represents any <code>@</code> tag in the Notion UI, for a user, date, Notion page, Notion database, or a miniaturized version of a <a target=\"_blank\" href=\"https://developers.notion.com/reference/unfurl-attribute-object\">Link Preview</a>. </p>\n<p>A mention block object contains the following fields: </p>\n<div><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>type</code></td><td><code>\"database\"</code><p><code>\"date\"</code></p><p><code>\"link_preview\"</code></p><p><code>\"page\"</code></p><p><code>\"user\"</code></p></td><td>A constant string representing the type of the mention.</td></tr><tr><td><code>\"database\"</code><p><code>\"date\"</code></p><p><code>\"link_preview\"</code></p><p><code>\"page\"</code></p><p><code>\"user\"</code></p></td><td><code>object</code></td><td>An object with type-specific information about the mention.</td></tr></tbody></table></div>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"page\",\n \"page\": {\n \"id\": \"3c612f56-fdd0-4a30-a4d6-bda7d7426309\"\n }\n}\n</code></pre></div>\n<p>Numbered list item block objects contain the following information within the <code>numbered_list_item</code> property:</p>\n<div><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>rich_text</code></td><td><code>array</code> of <a target=\"_blank\" href=\"https://developers.notion.com/reference/rich-text\">rich text objects</a></td><td>The rich text displayed in the <code>numbered_list_item</code> block.</td></tr><tr><td><code>color</code></td><td><code>string</code> (enum)</td><td>The color of the block. Possible values are:<p>\n- <code>\"blue\"</code><br />\n- <code>\"blue_background\"</code><br />\n- <code>\"brown\"</code><br />\n- <code>\"brown_background\"</code><br />\n- <code>\"default\"</code><br />\n- <code>\"gray\"</code><br />\n- <code>\"gray_background\"</code><br />\n- <code>\"green\"</code><br />\n- <code>\"green_background\"</code><br />\n- <code>\"orange\"</code><br />\n- <code>\"orange_background\"</code><br />\n- <code>\"yellow\"</code><br />\n- <code>\"green\"</code><br />\n- <code>\"pink\"</code><br />\n- <code>\"pink_background\"</code><br />\n- <code>\"purple\"</code><br />\n- <code>\"purple_background\"</code><br />\n- <code>\"red\"</code><br />\n- <code>\"red_background\"</code><br />\n- <code>\"yellow_background\"</code></p></td></tr><tr><td><code>children</code></td><td><code>array</code> of <a target=\"_blank\" href=\"https://developers.notion.com/reference/block\">block objects</a></td><td>The nested child blocks (if any) of the <code>numbered_list_item</code> block.</td></tr></tbody></table></div>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"numbered_list_item\",\n \"numbered_list_item\": {\n \"rich_text\": [\n {\n \"type\": \"text\",\n \"text\": {\n \"content\": \"Finish reading the docs\",\n \"link\": null\n }\n }\n ],\n \"color\": \"default\"\n }\n}\n</code></pre></div>\n<p>Paragraph block objects contain the following information within the <code>paragraph</code> property:</p>\n<div><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>rich_text</code></td><td><code>array</code> of <a target=\"_blank\" href=\"https://developers.notion.com/reference/rich-text\">rich text objects</a></td><td>The rich text displayed in the paragraph block.</td></tr><tr><td><code>color</code></td><td><code>string</code> (enum)</td><td>The color of the block. Possible values are:<p>\n- <code>\"blue\"</code><br />\n- <code>\"blue_background\"</code><br />\n- <code>\"brown\"</code><br />\n- <code>\"brown_background\"</code><br />\n- <code>\"default\"</code><br />\n- <code>\"gray\"</code><br />\n- <code>\"gray_background\"</code><br />\n- <code>\"green\"</code><br />\n- <code>\"green_background\"</code><br />\n- <code>\"orange\"</code><br />\n- <code>\"orange_background\"</code><br />\n- <code>\"yellow\"</code><br />\n- <code>\"green\"</code><br />\n- <code>\"pink\"</code><br />\n- <code>\"pink_background\"</code><br />\n- <code>\"purple\"</code><br />\n- <code>\"purple_background\"</code><br />\n- <code>\"red\"</code><br />\n- <code>\"red_background\"</code><br />\n- <code>\"yellow_background\"</code></p></td></tr><tr><td><code>children</code></td><td><code>array</code> of <a target=\"_blank\" href=\"https://developers.notion.com/reference/block\">block objects</a></td><td>The nested child blocks (if any) of the <code>paragraph</code> block.</td></tr></tbody></table></div>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"paragraph\",\n //...other keys excluded\n \"paragraph\": {\n \"rich_text\": [{\n \"type\": \"text\",\n \"text\": {\n \"content\": \"Lacinato kale\",\n \"link\": null\n }\n }],\n \"color\": \"default\"\n}\n</code></pre></div>\n<div><pre><code>{\n//...other keys excluded\n\t\"type\": \"paragraph\",\n \t\"paragraph\":{\n \t\t\"rich_text\": [\n \t\t{\n \t\t\"type\": \"mention\",\n \t\t\"mention\": {\n \t\t\"type\": \"date\",\n \t\t\"date\": {\n \t\t\"start\": \"2023-03-01\",\n \t\t\"end\": null,\n \t\t\"time_zone\": null\n \t\t}\n \t\t},\n \t\t\"annotations\": {\n \t\t\"bold\": false,\n \t\t\"italic\": false,\n \t\t\"strikethrough\": false,\n \t\t\"underline\": false,\n \t\t\"code\": false,\n \t\t\"color\": \"default\"\n \t\t},\n \t\t\"plain_text\": \"2023-03-01\",\n \t\t\"href\": null\n \t\t},\n \t\t{\n \"type\": \"text\",\n \t\t\"text\": {\n \t\t\"content\": \" \",\n \t\t\"link\": null\n \t\t},\n \t\t\"annotations\": {\n \t\t\"bold\": false,\n \t\t\"italic\": false,\n \t\t\"strikethrough\": false,\n \t\t\"underline\": false,\n \t\t\"code\": false,\n \t\t\"color\": \"default\"\n \t\t},\n \t\t\"plain_text\": \" \",\n \t\t\"href\": null\n \t\t}\n \t\t],\n \t\t\"color\": \"default\"\n \t}\n}\n</code></pre></div>\n<p>A PDF block object represents a PDF that has been embedded within a Notion page. It contains the following fields:</p>\n<div><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>caption</code></td><td><code>array</code> of <a target=\"_blank\" href=\"https://developers.notion.com/reference/rich-text\">rich text objects</a></td><td>A caption, if provided, for the PDF block.</td></tr><tr><td><code>type</code></td><td><code>\"external\"</code><p><code>\"file\"</code></p></td><td>A constant string representing the type of PDF. <code>file</code> indicates a Notion-hosted file, and <code>external</code> represents a third-party link.</td></tr><tr><td><code>external</code><p><code>file</code></p></td><td><a target=\"_blank\" href=\"https://developers.notion.com/reference/file-object\">file object</a></td><td>An object containing type-specific information about the PDF.</td></tr></tbody></table></div>\n<div><pre><code>{\n //...other keys excluded\n\t\"type\": \"pdf\",\n //...other keys excluded\n \"pdf\": {\n \"type\": \"external\",\n \"external\": {\n \t \t\"url\": \"https://website.domain/files/doc.pdf\"\n }\n }\n}\n</code></pre></div>\n<p>Quote block objects contain the following information within the <code>quote</code> property:</p>\n<div><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>rich_text</code></td><td><code>array</code> of <a target=\"_blank\" href=\"https://developers.notion.com/reference/rich-text\">rich text objects</a></td><td>The rich text displayed in the quote block.</td></tr><tr><td><code>color</code></td><td><code>string</code> (enum)</td><td>The color of the block. Possible values are:<p>\n- <code>\"blue\"</code><br />\n- <code>\"blue_background\"</code><br />\n- <code>\"brown\"</code><br />\n- <code>\"brown_background\"</code><br />\n- <code>\"default\"</code><br />\n- <code>\"gray\"</code><br />\n- <code>\"gray_background\"</code><br />\n- <code>\"green\"</code><br />\n- <code>\"green_background\"</code><br />\n- <code>\"orange\"</code><br />\n- <code>\"orange_background\"</code><br />\n- <code>\"yellow\"</code><br />\n- <code>\"green\"</code><br />\n- <code>\"pink\"</code><br />\n- <code>\"pink_background\"</code><br />\n- <code>\"purple\"</code><br />\n- <code>\"purple_background\"</code><br />\n- <code>\"red\"</code><br />\n- <code>\"red_background\"</code><br />\n- <code>\"yellow_background\"</code></p></td></tr><tr><td><code>children</code></td><td><code>array</code> of <a target=\"_blank\" href=\"https://developers.notion.com/reference/block\">block objects</a></td><td>The nested child blocks, if any, of the quote block.</td></tr></tbody></table></div>\n<div><pre><code>{\n\t//...other keys excluded\n\t\"type\": \"quote\",\n //...other keys excluded\n \"quote\": {\n \t\"rich_text\": [{\n \"type\": \"text\",\n \"text\": {\n \"content\": \"To be or not to be...\",\n \"link\": null\n },\n \t//...other keys excluded\n }],\n //...other keys excluded\n \"color\": \"default\"\n }\n}\n</code></pre></div>\n<p>Similar to the Notion UI, there are two versions of a <code>synced_block</code> object: the original block that was created first and doesn't yet sync with anything else, and the duplicate block or blocks synced to the original.</p>\n<blockquote><p><span>📘</span></p><p>An original synced block must be created before corresponding duplicate block or blocks can be made.</p></blockquote>\n<p>Original synced block objects contain the following information within the <code>synced_block</code> property: </p>\n<div><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>synced_from</code></td><td><code>null</code></td><td>The value is always <code>null</code> to signify that this is an original synced block that does not refer to another block.</td></tr><tr><td><code>children</code></td><td><code>array</code> of <a target=\"_blank\" href=\"https://developers.notion.com/reference/block\">block objects</a></td><td>The nested child blocks, if any, of the <code>synced_block</code> block. These blocks will be mirrored in the duplicate <code>synced_block</code>.</td></tr></tbody></table></div>\n<div><pre><code>{\n //...other keys excluded\n \t\"type\": \"synced_block\",\n \"synced_block\": {\n \"synced_from\": null,\n \"children\": [\n {\n \"callout\": {\n \"rich_text\": [\n {\n \"type\": \"text\",\n \"text\": {\n \"content\": \"Callout in synced block\"\n }\n }\n ]\n }\n }\n ]\n }\n}\n</code></pre></div>\n<p>Duplicate synced block objects contain the following information within the <code>synced_from</code> object: </p>\n<div><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>type</code></td><td><code>string</code> (enum)</td><td>The type of the synced from object.<p>\nPossible values are:<br />\n- <code>\"block_id\"</code></p></td></tr><tr><td><code>block_id</code></td><td><code>string</code> (UUIDv4)</td><td>An identifier for the original <code>synced_block</code>.</td></tr></tbody></table></div>\n<div><pre><code>{\n //...other keys excluded\n \t\"type\": \"synced_block\",\n \"synced_block\": {\n \"synced_from\": {\n \"block_id\": \"original_synced_block_id\"\n }\n }\n}\n</code></pre></div>\n<blockquote><p><span>🚧</span></p><p>The API does not supported updating synced block content.</p></blockquote>\n<p>Table block objects are parent blocks for table row children. Table block objects contain the following fields within the <code>table</code> property: </p>\n<div><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>table_width</code></td><td><code>integer</code></td><td>The number of columns in the table.<p><strong>Note that this cannot be changed via the public API once a table is created.</strong></p></td></tr><tr><td><code>has_column_header</code></td><td><code>boolean</code></td><td>Whether the table has a column header. If <code>true</code>, then the first row in the table appears visually distinct from the other rows.</td></tr><tr><td><code>has_row_header</code></td><td><code>boolean</code></td><td>Whether the table has a header row. If <code>true</code>, then the first column in the table appears visually distinct from the other columns.</td></tr></tbody></table></div>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"table\",\n \"table\": {\n \"table_width\": 2,\n \"has_column_header\": false,\n \"has_row_header\": false\n }\n}\n</code></pre></div>\n<blockquote><p><span>🚧</span></p><p><code>table_width</code> can only be set when the table is first created.</p><p>Note that the number of columns in a table can only be set when the table is first created. Calls to the Update block endpoint to update <code>table_width</code> fail.</p></blockquote>\n<p>Follow these steps to fetch the <code>table_row</code>s of a <code>table</code>: </p>\n<ol>\n<li>\n<p>Get the <code>table</code> ID from a query to <a target=\"_blank\" href=\"https://developers.notion.com/reference/get-block-children\">Retrieve block children</a> for the parent page. </p>\n</li>\n<li>\n<p>Get the <code>table_rows</code> from a query to Retrieve block children for the <code>table</code>. </p>\n</li>\n</ol>\n<p>A <code>table_row</code> block object contains the following fields within the <code>table_row</code> property:</p>\n<div><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>cells</code></td><td><code>array</code> of array of <a target=\"_blank\" href=\"https://developers.notion.com/reference/rich-text\">rich text objects</a></td><td>An array of cell contents in horizontal display order. Each cell is an array of rich text objects.</td></tr></tbody></table></div>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"table_row\",\n \"table_row\": {\n \"cells\": [\n [\n {\n \"type\": \"text\",\n \"text\": {\n \"content\": \"column 1 content\",\n \"link\": null\n },\n \"annotations\": {\n \"bold\": false,\n \"italic\": false,\n \"strikethrough\": false,\n \"underline\": false,\n \"code\": false,\n \"color\": \"default\"\n },\n \"plain_text\": \"column 1 content\",\n \"href\": null\n }\n ],\n [\n {\n \"type\": \"text\",\n \"text\": {\n \"content\": \"column 2 content\",\n \"link\": null\n },\n \"annotations\": {\n \"bold\": false,\n \"italic\": false,\n \"strikethrough\": false,\n \"underline\": false,\n \"code\": false,\n \"color\": \"default\"\n },\n \"plain_text\": \"column 2 content\",\n \"href\": null\n }\n ],\n [\n {\n \"type\": \"text\",\n \"text\": {\n \"content\": \"column 3 content\",\n \"link\": null\n },\n \"annotations\": {\n \"bold\": false,\n \"italic\": false,\n \"strikethrough\": false,\n \"underline\": false,\n \"code\": false,\n \"color\": \"default\"\n },\n \"plain_text\": \"column 3 content\",\n \"href\": null\n }\n ]\n ]\n }\n}\n</code></pre></div>\n<blockquote><p><span>📘</span></p><p>When creating a table block via the <a target=\"_blank\" href=\"https://developers.notion.com/reference/patch-block-children\">Append block children</a> endpoint, the <code>table</code> must have at least one <code>table_row</code> whose <code>cells</code> array has the same length as the <code>table_width</code>.</p></blockquote>\n<p>Table of contents block objects contain the following information within the <code>table_of_contents</code> property:</p>\n<div><table><thead><tr><th>Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>color</code></td><td><code>string</code> (enum)</td><td>The color of the block. Possible values are:<p>\n- <code>\"blue\"</code><br />\n- <code>\"blue_background\"</code><br />\n- <code>\"brown\"</code><br />\n- <code>\"brown_background\"</code><br />\n- <code>\"default\"</code><br />\n- <code>\"gray\"</code><br />\n- <code>\"gray_background\"</code><br />\n- <code>\"green\"</code><br />\n- <code>\"green_background\"</code><br />\n- <code>\"orange\"</code><br />\n- <code>\"orange_background\"</code><br />\n- <code>\"yellow\"</code><br />\n- <code>\"green\"</code><br />\n- <code>\"pink\"</code><br />\n- <code>\"pink_background\"</code><br />\n- <code>\"purple\"</code><br />\n- <code>\"purple_background\"</code><br />\n- <code>\"red\"</code><br />\n- <code>\"red_background\"</code><br />\n- <code>\"yellow_background\"</code></p></td></tr></tbody></table></div>\n<div><pre><code>{\n //...other keys excluded\n\t\"type\": \"table_of_contents\",\n \"table_of_contents\": {\n \t\"color\": \"default\"\n }\n}\n</code></pre></div>\n<blockquote><p><span>❗️</span></p><p>Deprecation Notice</p><p>As of March 27, 2023 creation of template blocks will no longer be supported.</p></blockquote>\n<p>Template blocks represent <a target=\"_blank\" href=\"https://www.notion.so/help/template-buttons\">template buttons</a> in the Notion UI.</p>\n<p>Template block objects contain the following information within the <code>template</code> property:</p>\n<div><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>rich_text</code></td><td><code>array</code> of <a target=\"_blank\" href=\"https://developers.notion.com/reference/rich-text\">rich text objects</a></td><td>The rich text displayed in the title of the template.</td></tr><tr><td><code>children</code></td><td><code>array</code> of <a target=\"_blank\" href=\"https://developers.notion.com/reference/block\">block objects</a></td><td>The nested child blocks, if any, of the template block. These blocks are duplicated when the template block is used in the UI.</td></tr></tbody></table></div>\n<div><pre><code>{\n //...other keys excluded\n \"template\": {\n \"rich_text\": [\n {\n \"type\": \"text\",\n \"text\": {\n \"content\": \"Add a new to-do\",\n \"link\": null\n },\n \"annotations\": {\n //...other keys excluded\n },\n \"plain_text\": \"Add a new to-do\",\n \"href\": null\n }\n ]\n }\n}\n</code></pre></div>\n<p>To do block objects contain the following information within the <code>to_do</code> property:</p>\n<div><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>rich_text</code></td><td><code>array</code> of <a target=\"_blank\" href=\"https://developers.notion.com/reference/rich-text\">rich text objects</a></td><td>The rich text displayed in the To do block.</td></tr><tr><td><code>checked</code></td><td><code>boolean</code> (optional)</td><td>Whether the To do is checked.</td></tr><tr><td><code>color</code></td><td><code>string</code> (enum)</td><td>The color of the block. Possible values are:<p>\n- <code>\"blue\"</code><br />\n- <code>\"blue_background\"</code><br />\n- <code>\"brown\"</code><br />\n- <code>\"brown_background\"</code><br />\n- <code>\"default\"</code><br />\n- <code>\"gray\"</code><br />\n- <code>\"gray_background\"</code><br />\n- <code>\"green\"</code><br />\n- <code>\"green_background\"</code><br />\n- <code>\"orange\"</code><br />\n- <code>\"orange_background\"</code><br />\n- <code>\"yellow\"</code><br />\n- <code>\"green\"</code><br />\n- <code>\"pink\"</code><br />\n- <code>\"pink_background\"</code><br />\n- <code>\"purple\"</code><br />\n- <code>\"purple_background\"</code><br />\n- <code>\"red\"</code><br />\n- <code>\"red_background\"</code><br />\n- <code>\"yellow_background\"</code></p></td></tr><tr><td><code>children</code></td><td><code>array</code> of <a target=\"_blank\" href=\"https://developers.notion.com/reference/block\">block objects</a></td><td>The nested child blocks, if any, of the To do block.</td></tr></tbody></table></div>\n<div><pre><code>{\n //...other keys excluded\n \"type\": \"to_do\",\n \"to_do\": {\n \"rich_text\": [{\n \"type\": \"text\",\n \"text\": {\n \"content\": \"Finish Q3 goals\",\n \"link\": null\n }\n }],\n \"checked\": false,\n \"color\": \"default\",\n \"children\":[{\n \"type\": \"paragraph\"\n // ..other keys excluded\n }]\n }\n}\n</code></pre></div>\n<p>Toggle block objects contain the following information within the <code>toggle</code> property:</p>\n<div><table><thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>rich_text</code></td><td><code>array</code> of <a target=\"_blank\" href=\"https://developers.notion.com/reference/rich-text\">rich text objects</a></td><td>The rich text displayed in the Toggle block.</td></tr><tr><td><code>color</code></td><td><code>string</code> (enum)</td><td>The color of the block. Possible values are:<p>\n- <code>\"blue\"</code><br />\n- <code>\"blue_background\"</code><br />\n-