PagesEndpoint: R6 Class for Pages Endpoint

In notionapi: Client for the 'Notion API'

R6 Class for Pages Endpoint

Description

Handle all pages operations in the Notion API

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

Value

A list containing the parsed API response.

Public fields

properties

Pages properties endpoint

Methods

Public methods

• PagesEndpoint$new()

• PagesEndpoint$create()

• PagesEndpoint$retrieve()

• PagesEndpoint$move()

• PagesEndpoint$update()

• PagesEndpoint$retrieve_markdown()

• PagesEndpoint$update_markdown()

---

Method new()

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

Usage

PagesEndpoint$new(client)

Arguments

client

Notion Client instance

---

Method create()

Create a page

Usage

PagesEndpoint$create(
  parent,
  properties = NULL,
  icon = NULL,
  cover = NULL,
  content = NULL,
  children = NULL,
  markdown = NULL,
  template = NULL,
  position = NULL
)

Arguments

parent

Named list (JSON object) (required). The parent under which the new page is created.

properties

Named list (JSON object). Key-value pairs representing the page's properties.

icon

Named list (JSON object). The page icon.

cover

Named list (JSON object). The page cover image.

content

List of lists (JSON array). Block objects to append as children to the page.

children

List of lists (JSON array). Block objects to append as children to the page.

markdown

Character. Page content as Notion-flavored Markdown. Mutually exclusive with content/children.

template

Named list (JSON object). A data source template apply to the new page. Cannot be combined with children.

position

Named list (JSON object). Controls where new blocks are inserted among parent's children. Defaults to end of parent block's children when omitted.

Details

Endpoint documentation

---

Method retrieve()

Retrieve page properties

Usage

PagesEndpoint$retrieve(page_id, filter_properties = NULL)

Arguments

page_id

Character (required). The ID for a Notion page.

filter_properties

Character vector. Page property value IDs to include in the response schema. If NULL (default), all properties are returned.

Details

Endpoint documentation

---

Method move()

Move a page

Usage

PagesEndpoint$move(page_id, parent)

Arguments

page_id

Character (required). The ID of the page to move.

parent

Named list (JSON object) (required). The new parent location for the page.

Details

Endpoint documentation

---

Method update()

Update attributes of a Notion page

Usage

PagesEndpoint$update(
  page_id,
  properties = NULL,
  icon = NULL,
  cover = NULL,
  is_locked = NULL,
  template = NULL,
  erase_content = NULL,
  in_trash = NULL,
  is_archived = NULL
)

Arguments

page_id

Character (required). The ID for a Notion page.

properties

Named list (JSON object). Key-value pairs representing the page's properties.

icon

Named list (JSON object). The page icon.

cover

Named list (JSON object). The page cover image.

is_locked

Boolean. Whether the page should be locked from editing.

template

Named list (JSON object). A template to apply to the page.

erase_content

Boolean. Whether to erase all existing content from the page. Irreversible via the API.

in_trash

Boolean. Set to TRUE to trash (delete) the page. Set to FALSE to restore the page.

is_archived

Boolean. Deprecated alias for in_trash. Use in_trash for new integrations.

Details

Endpoint documentation

---

Method retrieve_markdown()

Retrieve a page as markdown

Usage

PagesEndpoint$retrieve_markdown(page_id, include_transcript = NULL)

Arguments

page_id

Character (required). The ID of the page (or block) to to retrieve as markdown.

include_transcript

Boolean. Whether to include meeting note transcripts. Defaults to false.

Details

Endpoint documentation

---

Method update_markdown()

Update a page's content as markdown

Usage

PagesEndpoint$update_markdown(
  page_id,
  type,
  update_content = NULL,
  replace_content = NULL,
  insert_content = NULL,
  replace_content_range = NULL
)

Arguments

page_id

Character (required). The ID of the page to update.

type

Character (required). The update command type. One of "update_content", "replace_content", "insert_content" and "replace_content_range". The first two are recommended.

update_content

Named list (JSON object). Update specific content using search-and-replace operations.

replace_content

Named list (JSON object). Replace the entire page content with new markdown.

insert_content

Named list (JSON object). Insert new content into the page.

replace_content_range

Named list (JSON object). Replace a range of content in the page.

Details

Endpoint documentation

Examples

notion <- notion_client()

# ----- Create a page
notion$pages$create(
  list(page_id = "22f33ea0c1e480b99c77d1ab72aedff9"),
  list(
    title = list(list(
      text = list(
        content = "Test Page for notionapi"
      )
    ))
  )
)


# ----- Retrieve a page
notion$pages$retrieve("34033ea0-c1e4-81c4-afa0-d1ec98de4bec")


# ----- Move page into a database
notion$pages$move(
  "34033ea0-c1e4-81c4-afa0-d1ec98de4bec",
  list(
    data_source_id = "34033ea0-c1e4-8112-bc3a-000bc940aa45"
  )
)


# ----- Update a page
notion$pages$update(
  "34033ea0-c1e4-81c4-afa0-d1ec98de4bec",
  icon = list(
    icon = list(
      name = "pizza",
      color = "blue"
    )
  )
)


# ----- Use `NA` to send JSON `null` — below removes the page's icon
notion$pages$update(
  "34033ea0-c1e4-81c4-afa0-d1ec98de4bec",
  icon = NA
)


# ----- Retrieve a page as markdown
notion$pages$retrieve_markdown("34033ea0-c1e4-81c4-afa0-d1ec98de4bec")


# ----- Update/replace a page content
notion$pages$update_markdown(
  "34033ea0-c1e4-81c4-afa0-d1ec98de4bec",
  "replace_content",
  replace_content = list(
    new_str = '## Updated Test Heading\nUsed markdown{color="blue"}'
  )
)


# ----- Trash a page
notion$pages$update(
  "34033ea0-c1e4-81c4-afa0-d1ec98de4bec",
  in_trash = TRUE
)

notionapi documentation built on April 13, 2026, 9:07 a.m.