Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://api.notion.com
/v1/blocks/{block_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| block_id | path | required | string | Identifier for a Notion block |
| Notion-Version | header | optional | string |
DELETE /v1/blocks/{block_id}
/v1/blocks/{block_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| block_id | path | required | string | Identifier for a Notion block |
| Notion-Version | header | optional | string |
GET /v1/blocks/{block_id}
/v1/blocks/{block_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| block_id | path | required | string | Identifier for a Notion block |
| Notion-Version | header | optional | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlockUpdateBlockByIdRequest"
}
}
}
}
PATCH /v1/blocks/{block_id}
/v1/blocks/{block_id}/children
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| block_id | path | required | string | Identifier for a [block](ref:block) |
| start_cursor | query | optional | string | If supplied, this endpoint will return a page of results starting after the cursor provided. If not supplied, this endpoint will return the first page of results. |
| page_size | query | optional | integer | The number of items from the full list desired in the response. Maximum: 100 |
| Notion-Version | header | required | string |
GET /v1/blocks/{block_id}/children
/v1/blocks/{block_id}/children
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| block_id | path | required | string | Identifier for a [block](ref:block). Also accepts a [page](ref:page) ID. |
| Notion-Version | header | required | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlockAppendChildrenRequest"
}
}
}
}
PATCH /v1/blocks/{block_id}/children
/v1/comments
Retrieves a list of un-resolved [Comment objects](ref:comment-object) from a page or block.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| Notion-Version | header | required | string | |
| block_id | query | required | string | Identifier for a Notion block or page |
| start_cursor | query | optional | string | If supplied, this endpoint will return a page of results starting after the cursor provided. If not supplied, this endpoint will return the first page of results. |
| page_size | query | optional | integer | The number of items from the full list desired in the response. Maximum: 100 |
GET /v1/comments
/v1/comments
Creates a comment in a page or existing discussion thread.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| Notion-Version | header | required | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentCreateNewRequest"
}
}
}
}
POST /v1/comments
/v1/databases
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| Notion-Version | header | required | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatabaseCreateNewDatabaseRequest"
}
}
}
}
POST /v1/databases
/v1/databases/{database_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| database_id | path | required | string | An identifier for the Notion database. |
| Notion-Version | header | required | string |
GET /v1/databases/{database_id}
/v1/databases/{database_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| database_id | path | required | string | identifier for a Notion database |
| Notion-Version | header | optional | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatabaseUpdateDatabaseRequest"
}
}
}
}
PATCH /v1/databases/{database_id}
/v1/databases/{database_id}/query
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| database_id | path | required | string | Identifier for a Notion database. |
| filter_properties | query | optional | string | A list of page property value IDs associated with the database. Use this param to limit the response to a specific page property value or values for pages that meet the `filter` criteria. |
| Notion-Version | header | required | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatabaseExecuteQueryRequest"
}
}
}
}
POST /v1/databases/{database_id}/query
/v1/pages
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| Notion-Version | header | required | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PageCreateNewPageRequest"
}
}
}
}
POST /v1/pages
/v1/pages/{page_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| page_id | path | required | string | Identifier for a Notion page |
| filter_properties | query | optional | string | A list of page property value IDs associated with the page. Use this param to limit the response to a specific page property value or values. To retrieve multiple properties, specify each page property ID. For example: `?filter_properties=iAk8&filter_properties=b7dh`. |
| Notion-Version | header | required | string |
GET /v1/pages/{page_id}
/v1/pages/{page_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| page_id | path | required | string | The identifier for the Notion page to be updated. |
| Notion-Version | header | optional | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PageUpdatePropertiesRequest"
}
}
}
}
PATCH /v1/pages/{page_id}
/v1/pages/{page_id}/properties/{property_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| page_id | path | required | string | Identifier for a Notion page |
| property_id | path | required | string | Identifier for a page [property](https://developers.notion.com/reference/page#all-property-values) |
| page_size | query | optional | integer | For paginated properties. The max number of property item objects on a page. The default size is 100 |
| start_cursor | query | optional | string | For paginated properties. |
| Notion-Version | header | optional | string |
GET /v1/pages/{page_id}/properties/{property_id}
/v1/search
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| Notion-Version | header | required | string |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchByTitleRequest"
}
}
}
}
POST /v1/search
/v1/oauth/token
Creates an access token that a third-party service can use to authenticate with Notion.
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenGenerateAccessRequest"
}
}
}
}
POST /v1/oauth/token
/v1/users
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| start_cursor | query | optional | string | If supplied, this endpoint will return a page of results starting after the cursor provided. If not supplied, this endpoint will return the first page of results. |
| page_size | query | optional | integer | The number of items from the full list desired in the response. Maximum: 100 |
| Notion-Version | header | required | string |
GET /v1/users
/v1/users/me
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| Notion-Version | header | required | string |
GET /v1/users/me
/v1/users/{user_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| user_id | path | required | string | Identifier for a Notion user |
| Notion-Version | header | required | string |
GET /v1/users/{user_id}
BlockAppendChildren400Response
{
"type": "object",
"properties": {}
}
BlockAppendChildrenRequest
{
"type": "object",
"required": [
"children"
],
"properties": {
"after": {
"type": "string",
"description": "The ID of the existing block that the new block should be appended after."
},
"children": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"description": "Child content to append to a container block as an array of [block objects](ref:block)"
}
}
}
BlockAppendChildrenResponse
{
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "block"
},
"block": {
"type": "object",
"properties": {}
},
"object": {
"type": "string",
"example": "list"
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "c02fc1d3-db8b-45c5-a222-27595b15aea7"
},
"type": {
"type": "string",
"example": "heading_2"
},
"object": {
"type": "string",
"example": "block"
},
"parent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "page_id"
},
"page_id": {
"type": "string",
"example": "59833787-2cf9-4fdf-8782-e53db20768a5"
}
}
},
"archived": {
"type": "boolean",
"default": true,
"example": false
},
"heading_2": {
"type": "object",
"properties": {
"color": {
"type": "string",
"example": "default"
},
"rich_text": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {},
"text": {
"type": "object",
"properties": {
"link": {},
"content": {
"type": "string",
"example": "Lacinato kale"
}
}
},
"type": {
"type": "string",
"example": "text"
},
"plain_text": {
"type": "string",
"example": "Lacinato kale"
},
"annotations": {
"type": "object",
"properties": {
"bold": {
"type": "boolean",
"default": true,
"example": false
},
"code": {
"type": "boolean",
"default": true,
"example": false
},
"color": {
"type": "string",
"example": "default"
},
"italic": {
"type": "boolean",
"default": true,
"example": false
},
"underline": {
"type": "boolean",
"default": true,
"example": false
},
"strikethrough": {
"type": "boolean",
"default": true,
"example": false
}
}
}
}
}
},
"is_toggleable": {
"type": "boolean",
"default": true,
"example": false
}
}
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "ee5f0f84-409a-440f-983a-a5315961c6e4"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"created_time": {
"type": "string",
"example": "2022-03-01T19:05:00.000Z"
},
"has_children": {
"type": "boolean",
"default": true,
"example": false
},
"last_edited_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "ee5f0f84-409a-440f-983a-a5315961c6e4"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"last_edited_time": {
"type": "string",
"example": "2022-07-06T19:41:00.000Z"
}
}
}
},
"has_more": {
"type": "boolean",
"default": true,
"example": false
},
"next_cursor": {}
}
}
BlockGetChildren400Response
{
"type": "object",
"properties": {}
}
BlockGetChildrenResponse
{
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "block"
},
"block": {
"type": "object",
"properties": {}
},
"object": {
"type": "string",
"example": "list"
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "c02fc1d3-db8b-45c5-a222-27595b15aea7"
},
"type": {
"type": "string",
"example": "heading_2"
},
"object": {
"type": "string",
"example": "block"
},
"parent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "page_id"
},
"page_id": {
"type": "string",
"example": "59833787-2cf9-4fdf-8782-e53db20768a5"
}
}
},
"archived": {
"type": "boolean",
"default": true,
"example": false
},
"heading_2": {
"type": "object",
"properties": {
"color": {
"type": "string",
"example": "default"
},
"rich_text": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {},
"text": {
"type": "object",
"properties": {
"link": {},
"content": {
"type": "string",
"example": "Lacinato kale"
}
}
},
"type": {
"type": "string",
"example": "text"
},
"plain_text": {
"type": "string",
"example": "Lacinato kale"
},
"annotations": {
"type": "object",
"properties": {
"bold": {
"type": "boolean",
"default": true,
"example": false
},
"code": {
"type": "boolean",
"default": true,
"example": false
},
"color": {
"type": "string",
"example": "default"
},
"italic": {
"type": "boolean",
"default": true,
"example": false
},
"underline": {
"type": "boolean",
"default": true,
"example": false
},
"strikethrough": {
"type": "boolean",
"default": true,
"example": false
}
}
}
}
}
},
"is_toggleable": {
"type": "boolean",
"default": true,
"example": false
}
}
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "ee5f0f84-409a-440f-983a-a5315961c6e4"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"created_time": {
"type": "string",
"example": "2022-03-01T19:05:00.000Z"
},
"has_children": {
"type": "boolean",
"default": true,
"example": false
},
"last_edited_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "ee5f0f84-409a-440f-983a-a5315961c6e4"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"last_edited_time": {
"type": "string",
"example": "2022-03-01T19:05:00.000Z"
}
}
}
},
"has_more": {
"type": "boolean",
"default": true,
"example": false
},
"next_cursor": {}
}
}
BlockGetDetails400Response
{
"type": "object",
"properties": {}
}
BlockGetDetailsResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "c02fc1d3-db8b-45c5-a222-27595b15aea7"
},
"type": {
"type": "string",
"example": "heading_2"
},
"object": {
"type": "string",
"example": "block"
},
"parent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "page_id"
},
"page_id": {
"type": "string",
"example": "59833787-2cf9-4fdf-8782-e53db20768a5"
}
}
},
"archived": {
"type": "boolean",
"default": true,
"example": false
},
"heading_2": {
"type": "object",
"properties": {
"color": {
"type": "string",
"example": "default"
},
"rich_text": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {},
"text": {
"type": "object",
"properties": {
"link": {},
"content": {
"type": "string",
"example": "Lacinato kale"
}
}
},
"type": {
"type": "string",
"example": "text"
},
"plain_text": {
"type": "string",
"example": "Lacinato kale"
},
"annotations": {
"type": "object",
"properties": {
"bold": {
"type": "boolean",
"default": true,
"example": false
},
"code": {
"type": "boolean",
"default": true,
"example": false
},
"color": {
"type": "string",
"example": "default"
},
"italic": {
"type": "boolean",
"default": true,
"example": false
},
"underline": {
"type": "boolean",
"default": true,
"example": false
},
"strikethrough": {
"type": "boolean",
"default": true,
"example": false
}
}
}
}
}
},
"is_toggleable": {
"type": "boolean",
"default": true,
"example": false
}
}
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "ee5f0f84-409a-440f-983a-a5315961c6e4"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"created_time": {
"type": "string",
"example": "2022-03-01T19:05:00.000Z"
},
"has_children": {
"type": "boolean",
"default": true,
"example": false
},
"last_edited_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "ee5f0f84-409a-440f-983a-a5315961c6e4"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"last_edited_time": {
"type": "string",
"example": "2022-03-01T19:05:00.000Z"
}
}
}
BlockRemoveBlockById400Response
{
"type": "object",
"properties": {}
}
BlockRemoveBlockByIdResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "7985540b-2e77-4ac6-8615-c3047e36f872"
},
"type": {
"type": "string",
"example": "paragraph"
},
"object": {
"type": "string",
"example": "block"
},
"parent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "page_id"
},
"page_id": {
"type": "string",
"example": "59833787-2cf9-4fdf-8782-e53db20768a5"
}
}
},
"archived": {
"type": "boolean",
"default": true,
"example": true
},
"paragraph": {
"type": "object",
"properties": {
"color": {
"type": "string",
"example": "default"
},
"rich_text": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
}
}
}
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "0c3e9826-b8f7-4f73-927d-2caaf86f1103"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"created_time": {
"type": "string",
"example": "2022-07-06T19:52:00.000Z"
},
"has_children": {
"type": "boolean",
"default": true,
"example": false
},
"last_edited_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "ee5f0f84-409a-440f-983a-a5315961c6e4"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"last_edited_time": {
"type": "string",
"example": "2022-07-06T19:52:00.000Z"
}
}
}
BlockUpdateBlockById400Response
{
"type": "object",
"properties": {}
}
BlockUpdateBlockByIdRequest
{
"type": "object",
"properties": {
"{type}": {
"type": "object",
"properties": {},
"description": "The [block object `type`](ref:block#block-object-keys) value with the properties to be updated. Currently only `text` (for supported block types) and `checked` (for `to_do` blocks) fields can be updated."
},
"archived": {
"type": "boolean",
"default": true,
"description": "Set to true to archive (delete) a block. Set to false to un-archive (restore) a block."
}
}
}
BlockUpdateBlockByIdResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "c02fc1d3-db8b-45c5-a222-27595b15aea7"
},
"type": {
"type": "string",
"example": "heading_2"
},
"object": {
"type": "string",
"example": "block"
},
"parent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "page_id"
},
"page_id": {
"type": "string",
"example": "59833787-2cf9-4fdf-8782-e53db20768a5"
}
}
},
"archived": {
"type": "boolean",
"default": true,
"example": false
},
"heading_2": {
"type": "object",
"properties": {
"color": {
"type": "string",
"example": "default"
},
"rich_text": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {},
"text": {
"type": "object",
"properties": {
"link": {},
"content": {
"type": "string",
"example": "Lacinato kale"
}
}
},
"type": {
"type": "string",
"example": "text"
},
"plain_text": {
"type": "string",
"example": "Lacinato kale"
},
"annotations": {
"type": "object",
"properties": {
"bold": {
"type": "boolean",
"default": true,
"example": false
},
"code": {
"type": "boolean",
"default": true,
"example": false
},
"color": {
"type": "string",
"example": "green"
},
"italic": {
"type": "boolean",
"default": true,
"example": false
},
"underline": {
"type": "boolean",
"default": true,
"example": false
},
"strikethrough": {
"type": "boolean",
"default": true,
"example": false
}
}
}
}
}
},
"is_toggleable": {
"type": "boolean",
"default": true,
"example": false
}
}
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "ee5f0f84-409a-440f-983a-a5315961c6e4"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"created_time": {
"type": "string",
"example": "2022-03-01T19:05:00.000Z"
},
"has_children": {
"type": "boolean",
"default": true,
"example": false
},
"last_edited_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "ee5f0f84-409a-440f-983a-a5315961c6e4"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"last_edited_time": {
"type": "string",
"example": "2022-07-06T19:41:00.000Z"
}
}
}
CommentCreateNew403Response
{
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "restricted_resource"
},
"object": {
"type": "string",
"example": "error"
},
"status": {
"type": "integer",
"default": 0,
"example": 403
},
"message": {
"type": "string",
"example": "Insufficient permissions for this endpoint."
}
}
}
CommentCreateNewRequest
{
"type": "object",
"required": [
"rich_text"
],
"properties": {
"parent": {
"type": "string",
"format": "json",
"description": "A [page parent](/reference/database#page-parent). Either this or a discussion_id is required (not both)"
},
"rich_text": {
"type": "string",
"format": "json",
"description": "A [rich text object](ref:rich-text)"
},
"discussion_id": {
"type": "string",
"description": "A UUID identifier for a discussion thread. Either this or a parent object is required (not both)"
}
}
}
CommentCreateNewResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "b52b8ed6-e029-4707-a671-832549c09de3"
},
"object": {
"type": "string",
"example": "comment"
},
"parent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "page_id"
},
"page_id": {
"type": "string",
"example": "5c6a2821-6bb1-4a7e-b6e1-c50111515c3d"
}
}
},
"rich_text": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {},
"text": {
"type": "object",
"properties": {
"link": {},
"content": {
"type": "string",
"example": "Hello world"
}
}
},
"type": {
"type": "string",
"example": "text"
},
"plain_text": {
"type": "string",
"example": "Hello world"
},
"annotations": {
"type": "object",
"properties": {
"bold": {
"type": "boolean",
"default": true,
"example": false
},
"code": {
"type": "boolean",
"default": true,
"example": false
},
"color": {
"type": "string",
"example": "default"
},
"italic": {
"type": "boolean",
"default": true,
"example": false
},
"underline": {
"type": "boolean",
"default": true,
"example": false
},
"strikethrough": {
"type": "boolean",
"default": true,
"example": false
}
}
}
}
}
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "067dee40-6ebd-496f-b446-093c715fb5ec"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"created_time": {
"type": "string",
"example": "2022-07-15T20:53:00.000Z"
},
"discussion_id": {
"type": "string",
"example": "f1407351-36f5-4c49-a13c-49f8ba11776d"
},
"last_edited_time": {
"type": "string",
"example": "2022-07-15T20:53:00.000Z"
}
}
}
CommentGetList403Response
{
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "restricted_resource"
},
"object": {
"type": "string",
"example": "error"
},
"status": {
"type": "integer",
"default": 0,
"example": 403
},
"message": {
"type": "string",
"example": "Insufficient permissions for this endpoint."
}
}
}
CommentGetListResponse
{
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "comment"
},
"object": {
"type": "string",
"example": "list"
},
"comment": {
"type": "object",
"properties": {}
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "94cc56ab-9f02-409d-9f99-1037e9fe502f"
},
"object": {
"type": "string",
"example": "comment"
},
"parent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "page_id"
},
"page_id": {
"type": "string",
"example": "5c6a2821-6bb1-4a7e-b6e1-c50111515c3d"
}
}
},
"rich_text": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {},
"text": {
"type": "object",
"properties": {
"link": {},
"content": {
"type": "string",
"example": "Single comment"
}
}
},
"type": {
"type": "string",
"example": "text"
},
"plain_text": {
"type": "string",
"example": "Single comment"
},
"annotations": {
"type": "object",
"properties": {
"bold": {
"type": "boolean",
"default": true,
"example": false
},
"code": {
"type": "boolean",
"default": true,
"example": false
},
"color": {
"type": "string",
"example": "default"
},
"italic": {
"type": "boolean",
"default": true,
"example": false
},
"underline": {
"type": "boolean",
"default": true,
"example": false
},
"strikethrough": {
"type": "boolean",
"default": true,
"example": false
}
}
}
}
}
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "9b15170a-9941-4297-8ee6-83fa7649a87a"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"created_time": {
"type": "string",
"example": "2022-07-15T16:52:00.000Z"
},
"discussion_id": {
"type": "string",
"example": "f1407351-36f5-4c49-a13c-49f8ba11776d"
},
"last_edited_time": {
"type": "string",
"example": "2022-07-15T19:16:00.000Z"
}
}
}
},
"has_more": {
"type": "boolean",
"default": true,
"example": false
},
"next_cursor": {}
}
}
DatabaseCreateNewDatabase400Response
{
"type": "object",
"properties": {}
}
DatabaseCreateNewDatabaseRequest
{
"type": "object",
"required": [
"parent",
"properties"
],
"properties": {
"title": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"description": "Title of database as it appears in Notion. An array of [rich text objects](ref:rich-text)."
},
"parent": {
"type": "string",
"format": "json",
"description": "A [page parent](/reference/database#page-parent)"
},
"properties": {
"type": "string",
"format": "json",
"description": "Property schema of database. The keys are the names of properties as they appear in Notion and the values are [property schema objects](https://developers.notion.com/reference/property-schema-object)."
}
}
}
DatabaseCreateNewDatabaseResponse
{
"type": "string",
"example": "{\n \"object\": \"database\",\n \"id\": \"bc1211ca-e3f1-4939-ae34-5260b16f627c\",\n \"created_time\": \"2021-07-08T23:50:00.000Z\",\n \"last_edited_time\": \"2021-07-08T23:50:00.000Z\",\n \"icon\": {\n \"type\": \"emoji\",\n \"emoji\": \"🎉\"\n },\n \"cover\": {\n \"type\": \"external\",\n \"external\": {\n \"url\": \"https://website.domain/images/image.png\"\n }\n },\n \"url\": \"https://www.notion.so/bc1211cae3f14939ae34260b16f627c\",\n \"title\": [\n {\n \"type\": \"text\",\n \"text\": {\n \"content\": \"Grocery List\",\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\": \"Grocery List\",\n \"href\": null\n }\n ],\n \"properties\": {\n \"+1\": {\n \"id\": \"Wp%3DC\",\n \"name\": \"+1\",\n \"type\": \"people\",\n \"people\": {}\n },\n \"In stock\": {\n \"id\": \"fk%5EY\",\n \"name\": \"In stock\",\n \"type\": \"checkbox\",\n \"checkbox\": {}\n },\n \"Price\": {\n \"id\": \"evWq\",\n \"name\": \"Price\",\n \"type\": \"number\",\n \"number\": {\n \"format\": \"dollar\"\n }\n },\n \"Description\": {\n \"id\": \"V}lX\",\n \"name\": \"Description\",\n \"type\": \"rich_text\",\n \"rich_text\": {}\n },\n \"Last ordered\": {\n \"id\": \"eVnV\",\n \"name\": \"Last ordered\",\n \"type\": \"date\",\n \"date\": {}\n },\n \"Meals\": {\n \"id\": \"%7DWA~\",\n \"name\": \"Meals\",\n \"type\": \"relation\",\n \"relation\": {\n \"database_id\": \"668d797c-76fa-4934-9b05-ad288df2d136\",\n \"single_property\": {}\n }\n },\n \"Number of meals\": {\n \"id\": \"Z\\\\Eh\",\n \"name\": \"Number of meals\",\n \"type\": \"rollup\",\n \"rollup\": {\n \"rollup_property_name\": \"Name\",\n \"relation_property_name\": \"Meals\",\n \"rollup_property_id\": \"title\",\n \"relation_property_id\": \"mxp^\",\n \"function\": \"count\"\n }\n },\n \"Store availability\": {\n \"id\": \"s}Kq\",\n \"name\": \"Store availability\",\n \"type\": \"multi_select\",\n \"multi_select\": {\n \"options\": [\n {\n \"id\": \"cb79b393-d1c1-4528-b517-c450859de766\",\n \"name\": \"Duc Loi Market\",\n \"color\": \"blue\"\n },\n {\n \"id\": \"58aae162-75d4-403b-a793-3bc7308e4cd2\",\n \"name\": \"Rainbow Grocery\",\n \"color\": \"gray\"\n },\n {\n \"id\": \"22d0f199-babc-44ff-bd80-a9eae3e3fcbf\",\n \"name\": \"Nijiya Market\",\n \"color\": \"purple\"\n },\n {\n \"id\": \"0d069987-ffb0-4347-bde2-8e4068003dbc\",\n \"name\": \"Gus's Community Market\",\n \"color\": \"yellow\"\n }\n ]\n }\n },\n \"Photo\": {\n \"id\": \"yfiK\",\n \"name\": \"Photo\",\n \"type\": \"files\",\n \"files\": {}\n },\n \"Food group\": {\n \"id\": \"CM%3EH\",\n \"name\": \"Food group\",\n \"type\": \"select\",\n \"select\": {\n \"options\": [\n {\n \"id\": \"6d4523fa-88cb-4ffd-9364-1e39d0f4e566\",\n \"name\": \"🥦Vegetable\",\n \"color\": \"green\"\n },\n {\n \"id\": \"268d7e75-de8f-4c4b-8b9d-de0f97021833\",\n \"name\": \"🍎Fruit\",\n \"color\": \"red\"\n },\n {\n \"id\": \"1b234a00-dc97-489c-b987-829264cfdfef\",\n \"name\": \"💪Protein\",\n \"color\": \"yellow\"\n }\n ]\n }\n },\n \"Name\": {\n \"id\": \"title\",\n \"name\": \"Name\",\n \"type\": \"title\",\n \"title\": {}\n }\n },\n \"parent\": {\n \"type\": \"page_id\",\n \"page_id\": \"98ad959b-2b6a-4774-80ee-00246fb0ea9b\"\n },\n \"archived\": false\n}{\n \"object\": \"database\",\n \"id\": \"bc1211ca-e3f1-4939-ae34-5260b16f627c\",\n \"created_time\": \"2021-07-08T23:50:00.000Z\",\n \"last_edited_time\": \"2021-07-08T23:50:00.000Z\",\n \"icon\": {\n \"type\": \"emoji\",\n \"emoji\": \"🎉\"\n },\n \"cover\": {\n \"type\": \"external\",\n \"external\": {\n \"url\": \"https://website.domain/images/image.png\"\n }\n },\n \"url\": \"https://www.notion.so/bc1211cae3f14939ae34260b16f627c\",\n \"title\": [\n {\n \"type\": \"text\",\n \"text\": {\n \"content\": \"Grocery List\",\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\": \"Grocery List\",\n \"href\": null\n }\n ],\n \"properties\": {\n \"+1\": {\n \"id\": \"Wp%3DC\",\n \"name\": \"+1\",\n \"type\": \"people\",\n \"people\": {}\n },\n \"In stock\": {\n \"id\": \"fk%5EY\",\n \"name\": \"In stock\",\n \"type\": \"checkbox\",\n \"checkbox\": {}\n },\n \"Price\": {\n \"id\": \"evWq\",\n \"name\": \"Price\",\n \"type\": \"number\",\n \"number\": {\n \"format\": \"dollar\"\n }\n },\n \"Description\": {\n \"id\": \"V}lX\",\n \"name\": \"Description\",\n \"type\": \"rich_text\",\n \"rich_text\": {}\n },\n \"Last ordered\": {\n \"id\": \"eVnV\",\n \"name\": \"Last ordered\",\n \"type\": \"date\",\n \"date\": {}\n },\n \"Meals\": {\n \"id\": \"%7DWA~\",\n \"name\": \"Meals\",\n \"type\": \"relation\",\n \"relation\": {\n \"database_id\": \"668d797c-76fa-4934-9b05-ad288df2d136\",\n \"synced_property_name\": \"Related to Grocery List (Meals)\"\n }\n },\n \"Number of meals\": {\n \"id\": \"Z\\\\Eh\",\n \"name\": \"Number of meals\",\n \"type\": \"rollup\",\n \"rollup\": {\n \"rollup_property_name\": \"Name\",\n \"relation_property_name\": \"Meals\",\n \"rollup_property_id\": \"title\",\n \"relation_property_id\": \"mxp^\",\n \"function\": \"count\"\n }\n },\n \"Store availability\": {\n \"id\": \"s}Kq\",\n \"name\": \"Store availability\",\n \"type\": \"multi_select\",\n \"multi_select\": {\n \"options\": [\n {\n \"id\": \"cb79b393-d1c1-4528-b517-c450859de766\",\n \"name\": \"Duc Loi Market\",\n \"color\": \"blue\"\n },\n {\n \"id\": \"58aae162-75d4-403b-a793-3bc7308e4cd2\",\n \"name\": \"Rainbow Grocery\",\n \"color\": \"gray\"\n },\n {\n \"id\": \"22d0f199-babc-44ff-bd80-a9eae3e3fcbf\",\n \"name\": \"Nijiya Market\",\n \"color\": \"purple\"\n },\n {\n \"id\": \"0d069987-ffb0-4347-bde2-8e4068003dbc\",\n \"name\": \"Gus's Community Market\",\n \"color\": \"yellow\"\n }\n ]\n }\n },\n \"Photo\": {\n \"id\": \"yfiK\",\n \"name\": \"Photo\",\n \"type\": \"files\",\n \"files\": {}\n },\n \"Food group\": {\n \"id\": \"CM%3EH\",\n \"name\": \"Food group\",\n \"type\": \"select\",\n \"select\": {\n \"options\": [\n {\n \"id\": \"6d4523fa-88cb-4ffd-9364-1e39d0f4e566\",\n \"name\": \"🥦Vegetable\",\n \"color\": \"green\"\n },\n {\n \"id\": \"268d7e75-de8f-4c4b-8b9d-de0f97021833\",\n \"name\": \"🍎Fruit\",\n \"color\": \"red\"\n },\n {\n \"id\": \"1b234a00-dc97-489c-b987-829264cfdfef\",\n \"name\": \"💪Protein\",\n \"color\": \"yellow\"\n }\n ]\n }\n },\n \"Name\": {\n \"id\": \"title\",\n \"name\": \"Name\",\n \"type\": \"title\",\n \"title\": {}\n }\n },\n \"parent\": {\n \"type\": \"page_id\",\n \"page_id\": \"98ad959b-2b6a-4774-80ee-00246fb0ea9b\"\n },\n \"archived\": false,\n \"is_inline\": false\n}"
}
DatabaseExecuteQuery400Response
{
"type": "object",
"properties": {}
}
DatabaseExecuteQueryRequest
{
"type": "object",
"properties": {
"sorts": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"description": "When supplied, orders the results based on the provided [sort criteria](ref:post-database-query-sort)."
},
"filter": {
"type": "string",
"format": "json",
"description": "When supplied, limits which pages are returned based on the [filter conditions](ref:post-database-query-filter)."
},
"page_size": {
"type": "integer",
"format": "int32",
"default": 100,
"description": "The number of items from the full list desired in the response. Maximum: 100"
},
"start_cursor": {
"type": "string",
"description": "When supplied, returns a page of results starting after the cursor provided. If not supplied, this endpoint will return the first page of results."
}
}
}
DatabaseExecuteQueryResponse
{
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "page_or_database"
},
"object": {
"type": "string",
"example": "list"
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "59833787-2cf9-4fdf-8782-e53db20768a5"
},
"url": {
"type": "string",
"example": "https://www.notion.so/Tuscan-kale-598337872cf94fdf8782e53db20768a5"
},
"icon": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "emoji"
},
"emoji": {
"type": "string",
"example": "🥬"
}
}
},
"cover": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "external"
},
"external": {
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "https://upload.wikimedia.org/wikipedia/commons/6/62/Tuscankale.jpg"
}
}
}
}
},
"object": {
"type": "string",
"example": "page"
},
"parent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "database_id"
},
"database_id": {
"type": "string",
"example": "d9824bdc-8445-4327-be8b-5b47500af6ce"
}
}
},
"archived": {
"type": "boolean",
"default": true,
"example": false
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "ee5f0f84-409a-440f-983a-a5315961c6e4"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"properties": {
"type": "object",
"properties": {
"Name": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "title"
},
"type": {
"type": "string",
"example": "title"
},
"title": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {},
"text": {
"type": "object",
"properties": {
"link": {},
"content": {
"type": "string",
"example": "Tuscan kale"
}
}
},
"type": {
"type": "string",
"example": "text"
},
"plain_text": {
"type": "string",
"example": "Tuscan kale"
},
"annotations": {
"type": "object",
"properties": {
"bold": {
"type": "boolean",
"default": true,
"example": false
},
"code": {
"type": "boolean",
"default": true,
"example": false
},
"color": {
"type": "string",
"example": "default"
},
"italic": {
"type": "boolean",
"default": true,
"example": false
},
"underline": {
"type": "boolean",
"default": true,
"example": false
},
"strikethrough": {
"type": "boolean",
"default": true,
"example": false
}
}
}
}
}
}
}
},
"Photo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "%7DF_L"
},
"url": {
"type": "string",
"example": "https://i.insider.com/612fb23c9ef1e50018f93198?width=1136&format=jpeg"
},
"type": {
"type": "string",
"example": "url"
}
}
},
"Price": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "BJXS"
},
"type": {
"type": "string",
"example": "number"
},
"number": {
"type": "number",
"default": 0,
"example": 2.5
}
}
},
"Recipes": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "YfIu"
},
"type": {
"type": "string",
"example": "relation"
},
"has_more": {
"type": "boolean",
"default": true,
"example": false
},
"relation": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "90eeeed8-2cdd-4af4-9cc1-3d24aff5f63c"
}
}
}
}
}
},
"In stock": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "%60%5Bq%3F"
},
"type": {
"type": "string",
"example": "checkbox"
},
"checkbox": {
"type": "boolean",
"default": true,
"example": true
}
}
},
"Food group": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "A%40Hk"
},
"type": {
"type": "string",
"example": "select"
},
"select": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "5e8e7e8f-432e-4d8a-8166-1821e10225fc"
},
"name": {
"type": "string",
"example": "🥬 Vegetable"
},
"color": {
"type": "string",
"example": "pink"
}
}
}
}
},
"Description": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "_Tc_"
},
"type": {
"type": "string",
"example": "rich_text"
},
"rich_text": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {},
"text": {
"type": "object",
"properties": {
"link": {},
"content": {
"type": "string",
"example": "A dark "
}
}
},
"type": {
"type": "string",
"example": "text"
},
"plain_text": {
"type": "string",
"example": "A dark "
},
"annotations": {
"type": "object",
"properties": {
"bold": {
"type": "boolean",
"default": true,
"example": false
},
"code": {
"type": "boolean",
"default": true,
"example": false
},
"color": {
"type": "string",
"example": "default"
},
"italic": {
"type": "boolean",
"default": true,
"example": false
},
"underline": {
"type": "boolean",
"default": true,
"example": false
},
"strikethrough": {
"type": "boolean",
"default": true,
"example": false
}
}
}
}
}
}
}
},
"Last ordered": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Jsfb"
},
"date": {
"type": "object",
"properties": {
"end": {},
"start": {
"type": "string",
"example": "2022-02-22"
},
"time_zone": {}
}
},
"type": {
"type": "string",
"example": "date"
}
}
},
"Number of meals": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "zag~"
},
"type": {
"type": "string",
"example": "rollup"
},
"rollup": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "number"
},
"number": {
"type": "integer",
"default": 0,
"example": 2
},
"function": {
"type": "string",
"example": "count"
}
}
}
}
},
"Cost of next trip": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "WOd%3B"
},
"type": {
"type": "string",
"example": "formula"
},
"formula": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "number"
},
"number": {
"type": "integer",
"default": 0,
"example": 0
}
}
}
}
},
"Responsible Person": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Iowm"
},
"type": {
"type": "string",
"example": "people"
},
"people": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "cbfe3c6e-71cf-4cd3-b6e7-02f38f371bcc"
},
"name": {
"type": "string",
"example": "Cristina Cordova"
},
"type": {
"type": "string",
"example": "person"
},
"object": {
"type": "string",
"example": "user"
},
"person": {
"type": "object",
"properties": {
"email": {
"type": "string",
"example": "cristina@makenotion.com"
}
}
},
"avatar_url": {
"type": "string",
"example": "https://lh6.googleusercontent.com/-rapvfCoTq5A/AAAAAAAAAAI/AAAAAAAAAAA/AKF05nDKmmUpkpFvWNBzvu9rnZEy7cbl8Q/photo.jpg"
}
}
}
}
}
},
"Store availability": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "%3AUPp"
},
"type": {
"type": "string",
"example": "multi_select"
},
"multi_select": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "t|O@"
},
"name": {
"type": "string",
"example": "Gus's Community Market"
},
"color": {
"type": "string",
"example": "yellow"
}
}
}
}
}
}
}
},
"created_time": {
"type": "string",
"example": "2022-03-01T19:05:00.000Z"
},
"last_edited_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "0c3e9826-b8f7-4f73-927d-2caaf86f1103"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"last_edited_time": {
"type": "string",
"example": "2022-07-06T20:25:00.000Z"
}
}
}
},
"has_more": {
"type": "boolean",
"default": true,
"example": false
},
"next_cursor": {},
"page_or_database": {
"type": "object",
"properties": {}
}
}
}
DatabaseGetDatabase400Response
{
"type": "object",
"properties": {}
}
DatabaseGetDatabase404Response
{
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "object_not_found"
},
"object": {
"type": "string",
"example": "error"
},
"status": {
"type": "integer",
"default": 0,
"example": 404
},
"message": {
"type": "string",
"example": "Could not find database with ID: a1d8501e-1ac1-43e9-a6bd-ea9fe6c8822c. Make sure the relevant pages and databases are shared with your integration."
}
}
}
DatabaseGetDatabase429Response
{
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "rate_limited"
},
"object": {
"type": "string",
"example": "error"
},
"status": {
"type": "integer",
"default": 0,
"example": 429
},
"message": {
"type": "string",
"example": "You have been rate limited. Please try again in a few minutes."
}
}
}
DatabaseGetDatabaseResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "bc1211ca-e3f1-4939-ae34-5260b16f627c"
},
"url": {
"type": "string",
"example": "https://www.notion.so/bc1211cae3f14939ae34260b16f627c"
},
"icon": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "emoji"
},
"emoji": {
"type": "string",
"example": "🎉"
}
}
},
"cover": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "external"
},
"external": {
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "https://website.domain/images/image.png"
}
}
}
}
},
"title": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {},
"text": {
"type": "object",
"properties": {
"link": {},
"content": {
"type": "string",
"example": "Grocery List"
}
}
},
"type": {
"type": "string",
"example": "text"
},
"plain_text": {
"type": "string",
"example": "Grocery List"
},
"annotations": {
"type": "object",
"properties": {
"bold": {
"type": "boolean",
"default": true,
"example": false
},
"code": {
"type": "boolean",
"default": true,
"example": false
},
"color": {
"type": "string",
"example": "default"
},
"italic": {
"type": "boolean",
"default": true,
"example": false
},
"underline": {
"type": "boolean",
"default": true,
"example": false
},
"strikethrough": {
"type": "boolean",
"default": true,
"example": false
}
}
}
}
}
},
"object": {
"type": "string",
"example": "database"
},
"parent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "page_id"
},
"page_id": {
"type": "string",
"example": "98ad959b-2b6a-4774-80ee-00246fb0ea9b"
}
}
},
"archived": {
"type": "boolean",
"default": true,
"example": false
},
"is_inline": {
"type": "boolean",
"default": true,
"example": false
},
"properties": {
"type": "object",
"properties": {
"+1": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Wp%3DC"
},
"name": {
"type": "string",
"example": "+1"
},
"type": {
"type": "string",
"example": "people"
},
"people": {
"type": "object",
"properties": {}
}
}
},
"Name": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "title"
},
"name": {
"type": "string",
"example": "Name"
},
"type": {
"type": "string",
"example": "title"
},
"title": {
"type": "object",
"properties": {}
}
}
},
"Meals": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "%7DWA~"
},
"name": {
"type": "string",
"example": "Meals"
},
"type": {
"type": "string",
"example": "relation"
},
"relation": {
"type": "object",
"properties": {
"database_id": {
"type": "string",
"example": "668d797c-76fa-4934-9b05-ad288df2d136"
},
"synced_property_name": {
"type": "string",
"example": "Related to Grocery List (Meals)"
}
}
}
}
},
"Photo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "yfiK"
},
"name": {
"type": "string",
"example": "Photo"
},
"type": {
"type": "string",
"example": "files"
},
"files": {
"type": "object",
"properties": {}
}
}
},
"Price": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "evWq"
},
"name": {
"type": "string",
"example": "Price"
},
"type": {
"type": "string",
"example": "number"
},
"number": {
"type": "object",
"properties": {
"format": {
"type": "string",
"example": "dollar"
}
}
}
}
},
"In stock": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "fk%5EY"
},
"name": {
"type": "string",
"example": "In stock"
},
"type": {
"type": "string",
"example": "checkbox"
},
"checkbox": {
"type": "object",
"properties": {}
}
}
},
"Food group": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "CM%3EH"
},
"name": {
"type": "string",
"example": "Food group"
},
"type": {
"type": "string",
"example": "select"
},
"select": {
"type": "object",
"properties": {
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "6d4523fa-88cb-4ffd-9364-1e39d0f4e566"
},
"name": {
"type": "string",
"example": "🥦Vegetable"
},
"color": {
"type": "string",
"example": "green"
}
}
}
}
}
}
}
},
"Description": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "V}lX"
},
"name": {
"type": "string",
"example": "Description"
},
"type": {
"type": "string",
"example": "rich_text"
},
"rich_text": {
"type": "object",
"properties": {}
}
}
},
"Last ordered": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "eVnV"
},
"date": {
"type": "object",
"properties": {}
},
"name": {
"type": "string",
"example": "Last ordered"
},
"type": {
"type": "string",
"example": "date"
}
}
},
"Number of meals": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Z\\Eh"
},
"name": {
"type": "string",
"example": "Number of meals"
},
"type": {
"type": "string",
"example": "rollup"
},
"rollup": {
"type": "object",
"properties": {
"function": {
"type": "string",
"example": "count"
},
"rollup_property_id": {
"type": "string",
"example": "title"
},
"relation_property_id": {
"type": "string",
"example": "mxp^"
},
"rollup_property_name": {
"type": "string",
"example": "Name"
},
"relation_property_name": {
"type": "string",
"example": "Meals"
}
}
}
}
},
"Store availability": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "s}Kq"
},
"name": {
"type": "string",
"example": "Store availability"
},
"type": {
"type": "string",
"example": "multi_select"
},
"multi_select": {
"type": "object",
"properties": {
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "cb79b393-d1c1-4528-b517-c450859de766"
},
"name": {
"type": "string",
"example": "Duc Loi Market"
},
"color": {
"type": "string",
"example": "blue"
}
}
}
}
}
}
}
}
}
},
"public_url": {},
"description": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {},
"text": {
"type": "object",
"properties": {
"link": {},
"content": {
"type": "string",
"example": "Grocery list for just kale 🥬"
}
}
},
"type": {
"type": "string",
"example": "text"
},
"plain_text": {
"type": "string",
"example": "Grocery list for just kale 🥬"
},
"annotations": {
"type": "object",
"properties": {
"bold": {
"type": "boolean",
"default": true,
"example": false
},
"code": {
"type": "boolean",
"default": true,
"example": false
},
"color": {
"type": "string",
"example": "default"
},
"italic": {
"type": "boolean",
"default": true,
"example": false
},
"underline": {
"type": "boolean",
"default": true,
"example": false
},
"strikethrough": {
"type": "boolean",
"default": true,
"example": false
}
}
}
}
}
},
"created_time": {
"type": "string",
"example": "2021-07-08T23:50:00.000Z"
},
"last_edited_time": {
"type": "string",
"example": "2021-07-08T23:50:00.000Z"
}
}
}
DatabaseUpdateDatabase400Response
{
"oneOf": [
{
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "invalid_json"
},
"object": {
"type": "string",
"example": "error"
},
"status": {
"type": "integer",
"default": 0,
"example": 400
},
"message": {
"type": "string",
"example": "Error parsing JSON body."
}
}
},
{
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "validation_error"
},
"object": {
"type": "string",
"example": "error"
},
"status": {
"type": "integer",
"default": 0,
"example": 400
},
"message": {
"type": "string",
"example": "body failed validation: body.title[0].text.content.length should be ≤ `2000`, instead was `2022`."
}
}
}
]
}
DatabaseUpdateDatabase404Response
{
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "object_not_found"
},
"object": {
"type": "string",
"example": "error"
},
"status": {
"type": "integer",
"default": 0,
"example": 404
},
"message": {
"type": "string",
"example": "Could not find database with ID: a1d8501e-1ac1-43e9-a6bd-ea9fe6c8822c. Make sure the relevant pages and databases are shared with your integration."
}
}
}
DatabaseUpdateDatabase429Response
{
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "rate_limited"
},
"object": {
"type": "string",
"example": "error"
},
"status": {
"type": "integer",
"default": 0,
"example": 429
},
"message": {
"type": "string",
"example": "You have been rate limited. Please try again in a few minutes."
}
}
}
DatabaseUpdateDatabaseRequest
{
"type": "object",
"properties": {
"title": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"description": "An array of [rich text objects](https://developers.notion.com/reference/rich-text) that represents the title of the database that is displayed in the Notion UI. If omitted, then the database title remains unchanged."
},
"properties": {
"type": "string",
"format": "json",
"description": "The properties of a database to be changed in the request, in the form of a JSON object. If updating an existing property, then the keys are the names or IDs of the properties as they appear in Notion, and the values are [property schema objects](ref:property-schema-object). If adding a new property, then the key is the name of the new database property and the value is a [property schema object](ref:property-schema-object)."
},
"description": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"description": "An array of [rich text objects](https://developers.notion.com/reference/rich-text) that represents the description of the database that is displayed in the Notion UI. If omitted, then the database description remains unchanged."
}
}
}
DatabaseUpdateDatabaseResponse
{
"type": "string",
"example": "{\n \"object\": \"database\",\n \"id\": \"668d797c-76fa-4934-9b05-ad288df2d136\",\n \"created_time\": \"2020-03-17T19:10:00.000Z\",\n \"last_edited_time\": \"2021-08-11T17:26:00.000Z\",\n \"parent\": {\n \"type\": \"page_id\",\n \"page_id\": \"48f8fee9-cd79-4180-bc2f-ec0398253067\"\n }, \n \"icon\": {\n \"type\": \"emoji\",\n \"emoji\": \"📝\"\n \t},\n \"cover\": {\n \t\"type\": \"external\",\n \"external\": {\n \t\"url\": \"https://website.domain/images/image.png\"\n }\n },\n \"url\": \"https://www.notion.so/668d797c76fa49349b05ad288df2d136\",\n \"title\": [\n {\n \"type\": \"text\",\n \"text\": {\n \"content\": \"Today'\\''s grocery list\",\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\": \"Today'\\''s grocery list\",\n \"href\": null\n }\n ],\n \"description\": [\n {\n \"type\": \"text\",\n \"text\": {\n \"content\": \"Grocery list for just kale 🥬\",\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\": \"Grocery list for just kale 🥬\",\n \"href\": null\n }\n ],\n \"properties\": {\n \"Name\": {\n \"id\": \"title\",\n\t\t\t\"name\": \"Name\",\n \"type\": \"title\",\n \"title\": {}\n },\n \"Description\": {\n \"id\": \"J@cS\",\n\t\t\t\"name\": \"Description\",\n \"type\": \"rich_text\",\n \"rich_text\": {}\n },\n \"In stock\": {\n \"id\": \"{xY`\",\n\t\t\t\"name\": \"In stock\",\n \"type\": \"checkbox\",\n \"checkbox\": {}\n },\n \"Food group\": {\n \"id\": \"TJmr\",\n\t\t\t\"name\": \"Food group\",\n \"type\": \"select\",\n \"select\": {\n \"options\": [\n {\n \"id\": \"96eb622f-4b88-4283-919d-ece2fbed3841\",\n \"name\": \"🥦Vegetable\",\n \"color\": \"green\"\n },\n {\n \"id\": \"bb443819-81dc-46fb-882d-ebee6e22c432\",\n \"name\": \"🍎Fruit\",\n \"color\": \"red\"\n },\n {\n \"id\": \"7da9d1b9-8685-472e-9da3-3af57bdb221e\",\n \"name\": \"💪Protein\",\n \"color\": \"yellow\"\n }\n ]\n }\n },\n \"Price\": {\n \"id\": \"cU^N\",\n\t\t\t\"name\": \"Price\",\n \"type\": \"number\",\n \"number\": {\n \"format\": \"dollar\"\n }\n },\n \"Cost of next trip\": {\n \"id\": \"p:sC\",\n\t\t\t\"name\": \"Cost of next trip\",\n \"type\": \"formula\",\n \"formula\": {\n \"value\": \"if(prop(\\\"In stock\\\"), 0, prop(\\\"Price\\\"))\"\n }\n },\n \"Last ordered\": {\n \"id\": \"]\\\\R[\",\n\t\t\t\"name\": \"Last ordered\",\n \"type\": \"date\",\n \"date\": {}\n },\n \"Meals\": {\n\t\t\t\"id\": \"gqk%60\",\n \"name\": \"Meals\",\n \"type\": \"relation\",\n \"relation\": {\n \"database\": \"668d797c-76fa-4934-9b05-ad288df2d136\",\n \"synced_property_name\": null\n }\n },\n \"Number of meals\": {\n \"id\": \"Z\\\\Eh\",\n\t\t\t\"name\": \"Number of meals\",\n \"type\": \"rollup\",\n \"rollup\": {\n \"rollup_property_name\": \"Name\",\n \"relation_property_name\": \"Meals\",\n \"rollup_property_id\": \"title\",\n \"relation_property_id\": \"mxp^\",\n \"function\": \"count\"\n }\n },\n \"Store availability\": {\n\t\t\t\"id\": \"G%7Dji\",\n \"name\": \"Store availability\",\n \"type\": \"multi_select\",\n \"multi_select\": {\n \"options\": [\n [\n {\n \"id\": \"d209b920-212c-4040-9d4a-bdf349dd8b2a\",\n \"name\": \"Duc Loi Market\",\n \"color\": \"blue\"\n },\n {\n \"id\": \"70104074-0f91-467b-9787-00d59e6e1e41\",\n \"name\": \"Rainbow Grocery\",\n \"color\": \"gray\"\n },\n {\n \"id\": \"6c3867c5-d542-4f84-b6e9-a420c43094e7\",\n \"name\": \"Gus's Community Market\",\n \"color\": \"yellow\"\n },\n {\n\t\t\t\t\t\t\t\"id\": \"a62fbb5f-fed4-44a4-8cac-cba5f518c1a1\",\n \"name\": \"The Good Life Grocery\",\n \"color\": \"orange\"\n }\n ]\n ]\n }\n }\n \"Photo\": {\n \"id\": \"aTIT\",\n\t\t\t\"name\": \"Photo\",\n \"type\": \"url\",\n \"url\": {}\n }\n },\n \"is_inline\": false\n}"
}
PageCreateNewPage400Response
{
"type": "object",
"properties": {}
}
PageCreateNewPage404Response
{
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "object_not_found"
},
"object": {
"type": "string",
"example": "error"
},
"status": {
"type": "integer",
"default": 0,
"example": 404
},
"message": {
"type": "string",
"example": "Could not find page with ID: 4cc3b486-0b48-4cfe-8ce9-67c47100eb6a. Make sure the relevant pages and databases are shared with your integration."
}
}
}
PageCreateNewPage429Response
{
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "rate_limited"
},
"object": {
"type": "string",
"example": "error"
},
"status": {
"type": "integer",
"default": 0,
"example": 429
},
"message": {
"type": "string",
"example": "You have been rate limited. Please try again in a few minutes."
}
}
}
PageCreateNewPageRequest
{
"type": "object",
"required": [
"parent",
"properties"
],
"properties": {
"icon": {
"type": "string",
"format": "json",
"description": "The icon of the new page. Either an [emoji object](https://developers.notion.com/reference/emoji-object) or an [external file object](https://developers.notion.com/reference/file-object).."
},
"cover": {
"type": "string",
"format": "json",
"description": "The cover image of the new page, represented as a [file object](https://developers.notion.com/reference/file-object)."
},
"parent": {
"type": "string",
"format": "json",
"description": "The parent page or database where the new page is inserted, represented as a JSON object with a `page_id` or `database_id` key, and the corresponding ID."
},
"children": {
"type": "array",
"items": {
"type": "string"
},
"description": "The content to be rendered on the new page, represented as an array of [block objects](https://developers.notion.com/reference/block)."
},
"properties": {
"type": "string",
"format": "json",
"description": "The values of the page’s properties. If the `parent` is a database, then the schema must match the parent database’s properties. If the `parent` is a page, then the only valid object key is `title`."
}
}
}
PageCreateNewPageResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "59833787-2cf9-4fdf-8782-e53db20768a5"
},
"url": {
"type": "string",
"example": "https://www.notion.so/Tuscan-Kale-598337872cf94fdf8782e53db20768a5"
},
"icon": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "emoji"
},
"emoji": {
"type": "string",
"example": "🥬"
}
}
},
"cover": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "external"
},
"external": {
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "https://upload.wikimedia.org/wikipedia/commons/6/62/Tuscankale.jpg"
}
}
}
}
},
"object": {
"type": "string",
"example": "page"
},
"parent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "database_id"
},
"database_id": {
"type": "string",
"example": "d9824bdc-8445-4327-be8b-5b47500af6ce"
}
}
},
"archived": {
"type": "boolean",
"default": true,
"example": false
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "ee5f0f84-409a-440f-983a-a5315961c6e4"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"properties": {
"type": "object",
"properties": {
"Name": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "title"
}
}
},
"Photo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "%7DF_L"
}
}
},
"Price": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "BJXS"
}
}
},
"Recipes": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "YfIu"
}
}
},
"In stock": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "%60%5Bq%3F"
}
}
},
"Food group": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "A%40Hk"
}
}
},
"Description": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "_Tc_"
}
}
},
"Last ordered": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Jsfb"
}
}
},
"Number of meals": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "zag~"
}
}
},
"Cost of next trip": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "WOd%3B"
}
}
},
"Responsible Person": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Iowm"
}
}
},
"Store availability": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "%3AUPp"
}
}
}
}
},
"created_time": {
"type": "string",
"example": "2022-03-01T19:05:00.000Z"
},
"last_edited_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "ee5f0f84-409a-440f-983a-a5315961c6e4"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"last_edited_time": {
"type": "string",
"example": "2022-07-06T19:16:00.000Z"
}
}
}
PageGetPage400Response
{
"type": "object",
"properties": {}
}
PageGetPageResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "59833787-2cf9-4fdf-8782-e53db20768a5"
},
"url": {
"type": "string",
"example": "https://www.notion.so/Tuscan-kale-598337872cf94fdf8782e53db20768a5"
},
"icon": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "emoji"
},
"emoji": {
"type": "string",
"example": "🥬"
}
}
},
"cover": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "external"
},
"external": {
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "https://upload.wikimedia.org/wikipedia/commons/6/62/Tuscankale.jpg"
}
}
}
}
},
"object": {
"type": "string",
"example": "page"
},
"parent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "database_id"
},
"database_id": {
"type": "string",
"example": "d9824bdc-8445-4327-be8b-5b47500af6ce"
}
}
},
"archived": {
"type": "boolean",
"default": true,
"example": false
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "ee5f0f84-409a-440f-983a-a5315961c6e4"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"properties": {
"type": "object",
"properties": {
"Name": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "title"
},
"type": {
"type": "string",
"example": "title"
},
"title": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {},
"text": {
"type": "object",
"properties": {
"link": {},
"content": {
"type": "string",
"example": "Tuscan kale"
}
}
},
"type": {
"type": "string",
"example": "text"
},
"plain_text": {
"type": "string",
"example": "Tuscan kale"
},
"annotations": {
"type": "object",
"properties": {
"bold": {
"type": "boolean",
"default": true,
"example": false
},
"code": {
"type": "boolean",
"default": true,
"example": false
},
"color": {
"type": "string",
"example": "default"
},
"italic": {
"type": "boolean",
"default": true,
"example": false
},
"underline": {
"type": "boolean",
"default": true,
"example": false
},
"strikethrough": {
"type": "boolean",
"default": true,
"example": false
}
}
}
}
}
}
}
},
"Photo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "%7DF_L"
},
"url": {
"type": "string",
"example": "https://i.insider.com/612fb23c9ef1e50018f93198?width=1136&format=jpeg"
},
"type": {
"type": "string",
"example": "url"
}
}
},
"Price": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "BJXS"
},
"type": {
"type": "string",
"example": "number"
},
"number": {
"type": "number",
"default": 0,
"example": 2.5
}
}
},
"Recipes": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "YfIu"
},
"type": {
"type": "string",
"example": "relation"
},
"has_more": {
"type": "boolean",
"default": true,
"example": false
},
"relation": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "90eeeed8-2cdd-4af4-9cc1-3d24aff5f63c"
}
}
}
}
}
},
"In stock": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "%60%5Bq%3F"
},
"type": {
"type": "string",
"example": "checkbox"
},
"checkbox": {
"type": "boolean",
"default": true,
"example": true
}
}
},
"Food group": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "A%40Hk"
},
"type": {
"type": "string",
"example": "select"
},
"select": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "5e8e7e8f-432e-4d8a-8166-1821e10225fc"
},
"name": {
"type": "string",
"example": "🥬 Vegetable"
},
"color": {
"type": "string",
"example": "pink"
}
}
}
}
},
"Description": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "_Tc_"
},
"type": {
"type": "string",
"example": "rich_text"
},
"rich_text": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {},
"text": {
"type": "object",
"properties": {
"link": {},
"content": {
"type": "string",
"example": "A dark "
}
}
},
"type": {
"type": "string",
"example": "text"
},
"plain_text": {
"type": "string",
"example": "A dark "
},
"annotations": {
"type": "object",
"properties": {
"bold": {
"type": "boolean",
"default": true,
"example": false
},
"code": {
"type": "boolean",
"default": true,
"example": false
},
"color": {
"type": "string",
"example": "default"
},
"italic": {
"type": "boolean",
"default": true,
"example": false
},
"underline": {
"type": "boolean",
"default": true,
"example": false
},
"strikethrough": {
"type": "boolean",
"default": true,
"example": false
}
}
}
}
}
}
}
},
"Last ordered": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Jsfb"
},
"date": {
"type": "object",
"properties": {
"end": {},
"start": {
"type": "string",
"example": "2022-02-22"
},
"time_zone": {}
}
},
"type": {
"type": "string",
"example": "date"
}
}
},
"Number of meals": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "zag~"
},
"type": {
"type": "string",
"example": "rollup"
},
"rollup": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "number"
},
"number": {
"type": "integer",
"default": 0,
"example": 2
},
"function": {
"type": "string",
"example": "count"
}
}
}
}
},
"Cost of next trip": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "WOd%3B"
},
"type": {
"type": "string",
"example": "formula"
},
"formula": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "number"
},
"number": {
"type": "integer",
"default": 0,
"example": 0
}
}
}
}
},
"Responsible Person": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Iowm"
},
"type": {
"type": "string",
"example": "people"
},
"people": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "cbfe3c6e-71cf-4cd3-b6e7-02f38f371bcc"
},
"name": {
"type": "string",
"example": "Cristina Cordova"
},
"type": {
"type": "string",
"example": "person"
},
"object": {
"type": "string",
"example": "user"
},
"person": {
"type": "object",
"properties": {
"email": {
"type": "string",
"example": "cristina@makenotion.com"
}
}
},
"avatar_url": {
"type": "string",
"example": "https://lh6.googleusercontent.com/-rapvfCoTq5A/AAAAAAAAAAI/AAAAAAAAAAA/AKF05nDKmmUpkpFvWNBzvu9rnZEy7cbl8Q/photo.jpg"
}
}
}
}
}
},
"Store availability": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "%3AUPp"
},
"type": {
"type": "string",
"example": "multi_select"
},
"multi_select": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "t|O@"
},
"name": {
"type": "string",
"example": "Gus's Community Market"
},
"color": {
"type": "string",
"example": "yellow"
}
}
}
}
}
}
}
},
"public_url": {},
"created_time": {
"type": "string",
"example": "2022-03-01T19:05:00.000Z"
},
"last_edited_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "0c3e9826-b8f7-4f73-927d-2caaf86f1103"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"last_edited_time": {
"type": "string",
"example": "2022-07-06T20:25:00.000Z"
}
}
}
PageGetPropertyItemResponse
{
"type": "string",
"example": "{\n \"object\": \"property_item\",\n \"id\" \"kjPO\",\n \"type\": \"number\",\n \"number\": 2\n}"
}
PageUpdateProperties400Response
{
"type": "object",
"properties": {}
}
PageUpdateProperties404Response
{
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "object_not_found"
},
"object": {
"type": "string",
"example": "error"
},
"status": {
"type": "integer",
"default": 0,
"example": 404
},
"message": {
"type": "string",
"example": "Could not find page with ID: 4cc3b486-0b48-4cfe-8ce9-67c47100eb6a. Make sure the relevant pages and databases are shared with your integration."
}
}
}
PageUpdateProperties429Response
{
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "rate_limited"
},
"object": {
"type": "string",
"example": "error"
},
"status": {
"type": "integer",
"default": 0,
"example": 429
},
"message": {
"type": "string",
"example": "You have been rate limited. Please try again in a few minutes."
}
}
}
PageUpdatePropertiesRequest
{
"type": "object",
"properties": {
"icon": {
"type": "string",
"format": "json",
"description": "A page icon for the page. Supported types are [external file object](https://developers.notion.com/reference/file-object) or [emoji object](https://developers.notion.com/reference/emoji-object)."
},
"cover": {
"type": "string",
"format": "json",
"description": "A cover image for the page. Only [external file objects](https://developers.notion.com/reference/file-object) are supported."
},
"archived": {
"type": "boolean",
"description": "Whether the page is archived (deleted). Set to true to archive a page. Set to false to un-archive (restore) a page."
},
"properties": {
"type": "string",
"format": "json",
"description": "The property values to update for the page. The keys are the names or IDs of the property and the values are property values. If a page property ID is not included, then it is not changed."
}
}
}
PageUpdatePropertiesResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "59833787-2cf9-4fdf-8782-e53db20768a5"
},
"url": {
"type": "string",
"example": "https://www.notion.so/Tuscan-Kale-598337872cf94fdf8782e53db20768a5"
},
"icon": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "emoji"
},
"emoji": {
"type": "string",
"example": "🥬"
}
}
},
"cover": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "external"
},
"external": {
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "https://upload.wikimedia.org/wikipedia/commons/6/62/Tuscankale.jpg"
}
}
}
}
},
"object": {
"type": "string",
"example": "page"
},
"parent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "database_id"
},
"database_id": {
"type": "string",
"example": "d9824bdc-8445-4327-be8b-5b47500af6ce"
}
}
},
"archived": {
"type": "boolean",
"default": true,
"example": false
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "ee5f0f84-409a-440f-983a-a5315961c6e4"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"properties": {
"type": "object",
"properties": {
"Name": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "title"
}
}
},
"Photo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "%7DF_L"
}
}
},
"Price": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "BJXS"
}
}
},
"Recipes": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "YfIu"
}
}
},
"In stock": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "%60%5Bq%3F"
}
}
},
"Food group": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "A%40Hk"
}
}
},
"Description": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "_Tc_"
}
}
},
"Last ordered": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Jsfb"
}
}
},
"Number of meals": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "zag~"
}
}
},
"Cost of next trip": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "WOd%3B"
}
}
},
"Responsible Person": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Iowm"
}
}
},
"Store availability": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "%3AUPp"
}
}
}
}
},
"created_time": {
"type": "string",
"example": "2022-03-01T19:05:00.000Z"
},
"last_edited_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "ee5f0f84-409a-440f-983a-a5315961c6e4"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"last_edited_time": {
"type": "string",
"example": "2022-07-06T19:16:00.000Z"
}
}
}
SearchByTitle400Response
{
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "invalid_json"
},
"object": {
"type": "string",
"example": "error"
},
"status": {
"type": "integer",
"default": 0,
"example": 400
},
"message": {
"type": "string",
"example": "Error parsing JSON body."
}
}
}
SearchByTitle429Response
{
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "rate_limited"
},
"object": {
"type": "string",
"example": "error"
},
"status": {
"type": "integer",
"default": 0,
"example": 429
},
"message": {
"type": "string",
"example": "You have been rate limited. Please try again in a few minutes."
}
}
}
SearchByTitleRequest
{
"type": "object",
"properties": {
"sort": {
"type": "object",
"properties": {
"direction": {
"type": "string",
"description": "The direction to sort. Possible values include `ascending` and `descending`."
},
"timestamp": {
"type": "string",
"description": "The name of the timestamp to sort against. Possible values include `last_edited_time`."
}
},
"description": "A set of criteria, `direction` and `timestamp` keys, that orders the results. The **only** supported timestamp value is `\"last_edited_time\"`. Supported `direction` values are `\"ascending\"` and `\"descending\"`. If `sort` is not provided, then the most recently edited results are returned first."
},
"query": {
"type": "string",
"description": "The text that the API compares page and database titles against."
},
"filter": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The value of the property to filter the results by. Possible values for object type include `page` or `database`. **Limitation**: Currently the only filter allowed is `object` which will filter by type of object (either `page` or `database`)"
},
"property": {
"type": "string",
"description": "The name of the property to filter by. Currently the only property you can filter by is the object type. Possible values include `object`. Limitation: Currently the only filter allowed is `object` which will filter by type of object (either `page` or `database`)"
}
},
"description": "A set of criteria, `value` and `property` keys, that limits the results to either only pages or only databases. Possible `value` values are `\"page\"` or `\"database\"`. The only supported `property` value is `\"object\"`."
},
"page_size": {
"type": "integer",
"format": "int32",
"default": 100,
"description": "The number of items from the full list to include in the response. Maximum: `100`."
},
"start_cursor": {
"type": "string",
"description": "A `cursor` value returned in a previous response that If supplied, limits the response to results starting after the `cursor`. If not supplied, then the first page of results is returned. Refer to [pagination](https://developers.notion.com/reference/intro#pagination) for more details."
}
}
}
SearchByTitleResponse
{
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "page_or_database"
},
"object": {
"type": "string",
"example": "list"
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "954b67f9-3f87-41db-8874-23b92bbd31ee"
},
"url": {
"type": "string",
"example": "https://www.notion.so/Tuscan-kale-954b67f93f8741db887423b92bbd31ee"
},
"icon": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "emoji"
},
"emoji": {
"type": "string",
"example": "🥬"
}
}
},
"cover": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "external"
},
"external": {
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "https://upload.wikimedia.org/wikipedia/commons/6/62/Tuscankale.jpg"
}
}
}
}
},
"object": {
"type": "string",
"example": "page"
},
"parent": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "database_id"
},
"database_id": {
"type": "string",
"example": "d9824bdc-8445-4327-be8b-5b47500af6ce"
}
}
},
"archived": {
"type": "boolean",
"default": true,
"example": false
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "ee5f0f84-409a-440f-983a-a5315961c6e4"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"properties": {
"type": "object",
"properties": {
"Name": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "title"
},
"type": {
"type": "string",
"example": "title"
},
"title": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {},
"text": {
"type": "object",
"properties": {
"link": {},
"content": {
"type": "string",
"example": "Tuscan kale"
}
}
},
"type": {
"type": "string",
"example": "text"
},
"plain_text": {
"type": "string",
"example": "Tuscan kale"
},
"annotations": {
"type": "object",
"properties": {
"bold": {
"type": "boolean",
"default": true,
"example": false
},
"code": {
"type": "boolean",
"default": true,
"example": false
},
"color": {
"type": "string",
"example": "default"
},
"italic": {
"type": "boolean",
"default": true,
"example": false
},
"underline": {
"type": "boolean",
"default": true,
"example": false
},
"strikethrough": {
"type": "boolean",
"default": true,
"example": false
}
}
}
}
}
}
}
},
"Photo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "%7DF_L"
},
"url": {},
"type": {
"type": "string",
"example": "url"
}
}
},
"Price": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "BJXS"
},
"type": {
"type": "string",
"example": "number"
},
"number": {}
}
},
"Recipes": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "YfIu"
},
"type": {
"type": "string",
"example": "relation"
},
"relation": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
}
}
}
},
"In stock": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "%60%5Bq%3F"
},
"type": {
"type": "string",
"example": "checkbox"
},
"checkbox": {
"type": "boolean",
"default": true,
"example": false
}
}
},
"Food group": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "A%40Hk"
},
"type": {
"type": "string",
"example": "select"
},
"select": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "5e8e7e8f-432e-4d8a-8166-1821e10225fc"
},
"name": {
"type": "string",
"example": "🥬 Vegetable"
},
"color": {
"type": "string",
"example": "pink"
}
}
}
}
},
"Description": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "_Tc_"
},
"type": {
"type": "string",
"example": "rich_text"
},
"rich_text": {
"type": "array",
"items": {
"type": "object",
"properties": {
"href": {},
"text": {
"type": "object",
"properties": {
"link": {},
"content": {
"type": "string",
"example": "A dark green leafy vegetable"
}
}
},
"type": {
"type": "string",
"example": "text"
},
"plain_text": {
"type": "string",
"example": "A dark green leafy vegetable"
},
"annotations": {
"type": "object",
"properties": {
"bold": {
"type": "boolean",
"default": true,
"example": false
},
"code": {
"type": "boolean",
"default": true,
"example": false
},
"color": {
"type": "string",
"example": "default"
},
"italic": {
"type": "boolean",
"default": true,
"example": false
},
"underline": {
"type": "boolean",
"default": true,
"example": false
},
"strikethrough": {
"type": "boolean",
"default": true,
"example": false
}
}
}
}
}
}
}
},
"Last ordered": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Jsfb"
},
"date": {},
"type": {
"type": "string",
"example": "date"
}
}
},
"Number of meals": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "zag~"
},
"type": {
"type": "string",
"example": "rollup"
},
"rollup": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "number"
},
"number": {
"type": "integer",
"default": 0,
"example": 0
},
"function": {
"type": "string",
"example": "count"
}
}
}
}
},
"Cost of next trip": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "WOd%3B"
},
"type": {
"type": "string",
"example": "formula"
},
"formula": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "number"
},
"number": {}
}
}
}
},
"Responsible Person": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Iowm"
},
"type": {
"type": "string",
"example": "people"
},
"people": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
}
}
}
},
"Store availability": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "%3AUPp"
},
"type": {
"type": "string",
"example": "multi_select"
},
"multi_select": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
}
}
}
}
}
},
"created_time": {
"type": "string",
"example": "2022-07-06T19:30:00.000Z"
},
"last_edited_by": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "ee5f0f84-409a-440f-983a-a5315961c6e4"
},
"object": {
"type": "string",
"example": "user"
}
}
},
"last_edited_time": {
"type": "string",
"example": "2022-07-06T19:30:00.000Z"
}
}
}
},
"has_more": {
"type": "boolean",
"default": true,
"example": false
},
"next_cursor": {},
"page_or_database": {
"type": "object",
"properties": {}
}
}
}
TokenGenerateAccess400Response
{
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "invalid_request"
},
"error_description": {
"type": "string",
"example": "body failed validation: body.redirect_uri should be defined, instead was `undefined`."
}
}
}
TokenGenerateAccessRequest
{
"type": "object",
"required": [
"code",
"grant_type",
"redirect_uri"
],
"properties": {
"code": {
"type": "string",
"description": "A unique random code that Notion generates to authenticate with your service, generated when a user initiates the OAuth flow."
},
"grant_type": {
"type": "string",
"default": "\"authorization_code\"",
"description": "A constant string: \"authorization_code\"."
},
"redirect_uri": {
"type": "string",
"description": "The `\"redirect_uri\"` that was provided in the OAuth Domain & URI section of the integration's Authorization settings. Do not include this field if a `\"redirect_uri\"` query param was not included in the Authorization URL provided to users. In most cases, this field is required."
},
"external_account": {
"type": "object",
"properties": {},
"description": "Required if and only when building [Link Preview](https://developers.notion.com/docs/link-previews) integrations (otherwise ignored). An object with `key` and `name` properties. `key` should be a unique identifier for the account. Notion uses the `key` to determine whether or not the user is re-connecting the same account. `name` should be some way for the user to know which account they used to authenticate with your service. If a user has authenticated Notion with your integration before and `key` is the same but `name` is different, then Notion updates the `name` associated with your integration."
}
}
}
TokenGenerateAccessResponse
{
"type": "object",
"properties": {
"owner": {
"type": "object",
"properties": {
"workspace": {
"type": "boolean",
"default": true,
"example": true
}
}
},
"bot_id": {
"type": "string",
"example": "b3414d659-1224-5ty7-6ffr-cc9d8773drt601288f"
},
"access_token": {
"type": "string",
"example": "e202e8c9-0990-40af-855f-ff8f872b1ec6c"
},
"workspace_id": {
"type": "string",
"example": "j565j4d7x3-2882-61bs-564a-jj9d9ui-c36hxfr7x"
},
"workspace_icon": {
"type": "string",
"example": "https://website.domain/images/image.png"
},
"workspace_name": {
"type": "string",
"example": "Ada's Notion Workspace"
},
"duplicated_template_id": {}
}
}
UserGetTokenBotUser400Response
{
"type": "object",
"properties": {}
}
UserGetTokenBotUserResponse
{
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "16d84278-ab0e-484c-9bdd-b35da3bd8905"
},
"bot": {
"type": "object",
"properties": {
"owner": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "user"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "5389a034-eb5c-47b5-8a9e-f79c99ef166c"
},
"name": {
"type": "string",
"example": "christine makenotion"
},
"type": {
"type": "string",
"example": "person"
},
"object": {
"type": "string",
"example": "user"
},
"person": {
"type": "object",
"properties": {
"email": {
"type": "string",
"example": "christine@makenotion.com"
}
}
},
"avatar_url": {}
}
}
}
}
}
},
"name": {
"type": "string",
"example": "pied piper"
},
"type": {
"type": "string",
"example": "bot"
},
"object": {
"type": "string",
"example": "user"
},
"avatar_url": {}
}
}
UserGetUserById400Response
{
"type": "object",
"properties": {}
}
UserGetUserByIdResponse
{
"type": "string",
"example": "{\n \"object\": \"user\",\n \"id\": \"d40e767c-d7af-4b18-a86d-55c61f1e39a4\",\n \"type\": \"person\",\n\t\"person\": {\n\t\t\"email\": \"avo@example.org\",\n\t},\n \"name\": \"Avocado Lovelace\",\n \"avatar_url\": \"https://secure.notion-static.com/e6a352a8-8381-44d0-a1dc-9ed80e62b53d.jpg\",\n}"
}
UserListAllUsers400Response
{
"type": "object",
"properties": {}
}
UserListAllUsersResponse
{
"type": "string",
"example": "{\n \"results\": [\n {\n \"object\": \"user\",\n \"id\": \"d40e767c-d7af-4b18-a86d-55c61f1e39a4\",\n \"type\": \"person\",\n \"person\": {\n \"email\": \"avo@example.org\",\n },\n \"name\": \"Avocado Lovelace\",\n \"avatar_url\": \"https://secure.notion-static.com/e6a352a8-8381-44d0-a1dc-9ed80e62b53d.jpg\",\n },\n {\n \"object\": \"user\",\n \"id\": \"9a3b5ae0-c6e6-482d-b0e1-ed315ee6dc57\",\n \"type\": \"bot\",\n \"bot\": {},\n \"name\": \"Doug Engelbot\",\n \"avatar_url\": \"https://secure.notion-static.com/6720d746-3402-4171-8ebb-28d15144923c.jpg\",\n }\n ],\n \"next_cursor\": \"fe2cc560-036c-44cd-90e8-294d5a74cebc\",\n \"has_more\": true\n}"
}