Skip to contents

R6 Class for Databases Endpoint

Source: R/endpoints.R
DatabasesEndpoint.Rd

Handle all databases operations in the Notion API

Note: Access this endpoint through the client instance, e.g., notion$databases. Not to be instantiated directly.

Value

A list containing the parsed API response.

Methods

Public methods

Method new()

Initialise databases endpoint. Not to be called directly, e.g., use notion$databases instead.

Usage

DatabasesEndpoint$new(client)

Arguments

client

Notion Client instance

Method create()

Create a database

Usage

DatabasesEndpoint$create(
  parent,
  title = NULL,
  description = NULL,
  is_inline = NULL,
  initial_data_source = NULL,
  icon = NULL,
  cover = NULL
)

Arguments

parent

Named list (JSON object) (required). The parent page or workspace where the database will be created.

title

List of lists (JSON array). The title of the database.

description

List of lists (JSON array). The description of the database.

is_inline

Boolean. Whether the database should be displayed inline in the parent page. Defaults to false.

initial_data_source

Named list (JSON object). Initial data source configuration for the database

icon

Named list (JSON object). The icon for the database.

cover

Named list (JSON object). The cover image for the database.

Details

Endpoint documentation

Method retrieve()

Retrieve a database

Usage

DatabasesEndpoint$retrieve(database_id)

Arguments

database_id

String (required). The ID of a Notion database.

Details

Endpoint documentation

Method update()

Update a database

Usage

DatabasesEndpoint$update(
  database_id,
  parent = NULL,
  title = NULL,
  description = NULL,
  is_inline = NULL,
  icon = NULL,
  cover = NULL,
  in_trash = NULL,
  is_locked = NULL
)

Arguments

database_id

String (required). The ID of a Notion database.

parent

Named list (JSON object). The parent page or workspace to move the database to. If not provided, the database will not be moved.

title

List of lists (JSON array). The updated title of the database.

description

List of lists (JSON array). The updated description of the database.

is_inline

Boolean. Whether the database should be displayed in the parent page.

icon

Named list (JSON object). The updated icon for the database.

cover

Named list (JSON object). The updated cover image for the database.

in_trash

Boolean. Whether the database should be moved to or from the trash.

is_locked

Boolean. Whether the database should be locked from editing.

Details

Endpoint documentation

Examples

notion <- notion_client()
# ----- Create a database
notion$databases$create(
  list(
    type = "page_id",
    page_id = "22f33ea0c1e480b99c77d1ab72aedff9"
  ),
  title = list(list(
    text = list(
      content = "Test Database"
    )
  ))
)
#> {
#>   "object": "database",
#>   "id": "ffec20ee-1450-4da8-9904-f4babba0e9c0",
#>   "title": [
#>     {
#>       "type": "text",
#>       "text": {
#>         "content": "Test Database",
#>         "link": {}
#>       },
#>       "annotations": {
#>         "bold": false,
#>         "italic": false,
#>         "strikethrough": false,
#>         "underline": false,
#>         "code": false,
#>         "color": "default"
#>       },
#>       "plain_text": "Test Database",
#>       "href": {}
#>     }
#>   ],
#>   "description": [],
#>   "parent": {
#>     "type": "page_id",
#>     "page_id": "22f33ea0-c1e4-80b9-9c77-d1ab72aedff9"
#>   },
#>   "is_inline": false,
#>   "in_trash": false,
#>   "is_locked": false,
#>   "created_time": "2026-04-12T21:18:49.084+00:00",
#>   "last_edited_time": "2026-04-12T21:18:49.084+00:00",
#>   "data_sources": [
#>     {
#>       "id": "b55b16c7-12f3-4e1c-bfbf-759e9cd08f91",
#>       "name": "Test Database"
#>     }
#>   ],
#>   "icon": {},
#>   "cover": {},
#>   "url": "https://www.notion.so/ffec20ee14504da89904f4babba0e9c0",
#>   "public_url": {},
#>   "request_id": "90bcb8d7-d204-4e7b-bbae-8b623fc4cebd"
#> } 
# ----- Retrieve a database
notion$databases$retrieve("ffec20ee-1450-4da8-9904-f4babba0e9c0")
#> {
#>   "object": "database",
#>   "id": "ffec20ee-1450-4da8-9904-f4babba0e9c0",
#>   "title": [
#>     {
#>       "type": "text",
#>       "text": {
#>         "content": "Test Database",
#>         "link": {}
#>       },
#>       "annotations": {
#>         "bold": false,
#>         "italic": false,
#>         "strikethrough": false,
#>         "underline": false,
#>         "code": false,
#>         "color": "default"
#>       },
#>       "plain_text": "Test Database",
#>       "href": {}
#>     }
#>   ],
#>   "description": [],
#>   "parent": {
#>     "type": "page_id",
#>     "page_id": "22f33ea0-c1e4-80b9-9c77-d1ab72aedff9"
#>   },
#>   "is_inline": false,
#>   "in_trash": false,
#>   "is_locked": false,
#>   "created_time": "2026-04-12T21:18:49.084+00:00",
#>   "last_edited_time": "2026-04-12T21:18:49.084+00:00",
#>   "data_sources": [
#>     {
#>       "id": "b55b16c7-12f3-4e1c-bfbf-759e9cd08f91",
#>       "name": "Test Database"
#>     }
#>   ],
#>   "icon": {},
#>   "cover": {},
#>   "url": "https://www.notion.so/ffec20ee14504da89904f4babba0e9c0",
#>   "public_url": {},
#>   "request_id": "b1c53cf5-7ec6-4d58-883a-825b8b388dc6"
#> } 
# ----- Update a database
notion$databases$update(
  "ffec20ee-1450-4da8-9904-f4babba0e9c0",
  description = list(list(
    text = list(
      content = "For testing purposes"
    )
  )),
  icon = list(
    icon = list(
      name = "calendar",
      color = "gray"
    )
  )
)
#> {
#>   "object": "database",
#>   "id": "ffec20ee-1450-4da8-9904-f4babba0e9c0",
#>   "title": [
#>     {
#>       "type": "text",
#>       "text": {
#>         "content": "Test Database",
#>         "link": {}
#>       },
#>       "annotations": {
#>         "bold": false,
#>         "italic": false,
#>         "strikethrough": false,
#>         "underline": false,
#>         "code": false,
#>         "color": "default"
#>       },
#>       "plain_text": "Test Database",
#>       "href": {}
#>     }
#>   ],
#>   "description": [
#>     {
#>       "type": "text",
#>       "text": {
#>         "content": "For testing purposes",
#>         "link": {}
#>       },
#>       "annotations": {
#>         "bold": false,
#>         "italic": false,
#>         "strikethrough": false,
#>         "underline": false,
#>         "code": false,
#>         "color": "default"
#>       },
#>       "plain_text": "For testing purposes",
#>       "href": {}
#>     }
#>   ],
#>   "parent": {
#>     "type": "page_id",
#>     "page_id": "22f33ea0-c1e4-80b9-9c77-d1ab72aedff9"
#>   },
#>   "is_inline": false,
#>   "in_trash": false,
#>   "is_locked": false,
#>   "created_time": "2026-04-12T21:18:49.084+00:00",
#>   "last_edited_time": "2026-04-12T21:18:49.084+00:00",
#>   "data_sources": [
#>     {
#>       "id": "b55b16c7-12f3-4e1c-bfbf-759e9cd08f91",
#>       "name": "Test Database"
#>     }
#>   ],
#>   "icon": {
#>     "type": "icon",
#>     "icon": {
#>       "name": "calendar",
#>       "color": "gray"
#>     }
#>   },
#>   "cover": {},
#>   "url": "https://www.notion.so/ffec20ee14504da89904f4babba0e9c0",
#>   "public_url": {},
#>   "request_id": "3da849db-72e8-4a9d-855a-4322af514f22"
#> }