DataSourcesEndpoint: R6 Class for DataSources Endpoint

In notionapi: Client for the 'Notion API'

R6 Class for DataSources Endpoint

Description

Handle all data sources operations in the Notion API

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

Value

A list containing the parsed API response.

Methods

Public methods

• DataSourcesEndpoint$new()

• DataSourcesEndpoint$create()

• DataSourcesEndpoint$retrieve()

• DataSourcesEndpoint$list_templates()

• DataSourcesEndpoint$update()

• DataSourcesEndpoint$query()

---

Method new()

Initialise data sources endpoint. Not to be called directly, e.g., use notion$datasources instead.

Usage

DataSourcesEndpoint$new(client)

Arguments

client

Notion Client instance

---

Method create()

Create a data source

Usage

DataSourcesEndpoint$create(parent, properties, title = NULL, icon = NULL)

Arguments

parent

Named list (JSON object) (required). An object specifying the parent of the new data source to be created.

properties

Named list (JSON object) (required). Property schema of data source.

title

List of lists (JSON array). Title of data source.

icon

Named list (JSON object). Page icon.

Details

Endpoint documentation

---

Method retrieve()

Retrieve a data source

Usage

DataSourcesEndpoint$retrieve(data_source_id)

Arguments

data_source_id

Character (required). ID of a Notion data source.

Details

Endpoint documentation

---

Method list_templates()

List page templates available for a data source

Usage

DataSourcesEndpoint$list_templates(
  data_source_id,
  name = NULL,
  start_cursor = NULL,
  page_size = NULL
)

Arguments

data_source_id

Character (required). ID of a Notion data source.

name

Character. Name to filter templates by.

start_cursor

Character. For pagination. If provided, returns results starting from this cursor. If NULL, returns the first page of results.

page_size

Integer. Number of items to return per page (1-100). Defaults to 100

---

Method update()

Update a data source

Usage

DataSourcesEndpoint$update(
  data_source_id,
  title = NULL,
  icon = NULL,
  properties = NULL,
  in_trash = NULL,
  parent = NULL
)

Arguments

data_source_id

Character (required). ID of a Notion data source.

title

List of lists (JSON array). Title of data source.

icon

Named list (JSON object). Page icon.'

properties

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

in_trash

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

parent

Named list (JSON object). The parent of the data source, when moving it to a different database.

---

Method query()

Query a data source

Usage

DataSourcesEndpoint$query(
  data_source_id,
  filter_properties = NULL,
  sorts = NULL,
  filter = NULL,
  start_cursor = NULL,
  page_size = NULL,
  in_trash = NULL,
  result_type = NULL
)

Arguments

data_source_id

Character (required). ID of a Notion data source.

filter_properties

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

sorts

List of lists (JSON array). Sort conditions to apply to the query

filter

List of lists (JSON array). Filter conditions to apply. to the query

start_cursor

Character. For pagination. If provided, returns results starting from this cursor. If NULL, returns the first page of results.

page_size

Integer. Number of items to return per page (1-100). Defaults to 100

in_trash

Boolean. If TRUE, trashed pages are included in the results alongside non-trashed pages. If FALSE or NULL (default), only non-trashed pages are returned.

result_type

Character. Filter results by type. Available options are "page" and "data_source". If NULL (default), all result types are returned.

Examples

notion <- notion_client()

# ----- Create a data source
notion$data_sources$create(
  list(
    database_id = "ffec20ee-1450-4da8-9904-f4babba0e9c0"
  ),
  properties = list(
    Title = list(
      title = no_config()
    )
  ),
  title = list(list(
    text = list(
      content = "Test data source"
    )
  ))
)


# ----- Update data source
notion$data_sources$update(
  "34033ea0-c1e4-8112-bc3a-000bc940aa45",
  properties = list(
    Status = list(
      status = list(
        options = list(
          list(
            name = "To do",
            color = "red"
          ),
          list(
            name = "Done",
            color = "green"
          )
        )
      )
    )
  )
)


# ----- Retrieve a data source
notion$data_sources$retrieve("34033ea0-c1e4-8112-bc3a-000bc940aa45")


# ----- List data source templates
notion$data_sources$list_templates("34033ea0-c1e4-8112-bc3a-000bc940aa45")


# ----- Query a data source
notion$data_sources$query(
  "34033ea0-c1e4-8112-bc3a-000bc940aa45",
  filter = list(
    property = "Status",
    status = list(
      equals = "To do"
    )
  )
)

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