R6 Class for Pages Properties Endpoint

Handle all pages properties operations in the Notion API

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

Value

A list containing the parsed API response.

Methods

Public methods

• PagesPropertiesEndpoint$new()

• PagesPropertiesEndpoint$retrieve()

---

Method new()

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

Usage

PagesPropertiesEndpoint$new(client)

Arguments

client

Notion Client instance

---

Method retrieve()

Retrieve a page property item

Usage

PagesPropertiesEndpoint$retrieve(
  page_id,
  property_id,
  start_cursor = NULL,
  page_size = NULL
)

Arguments

page_id

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

property_id

Character (required). The ID of the property to retrieve.

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.

Details

Endpoint documentation

Examples

notion <- notion_client()
# ----- Retrieve a page property
notion$pages$properties$retrieve(
  "34033ea0-c1e4-81c4-afa0-d1ec98de4bec",
  "%60w%5CX"
)
#> {
#>   "object": "property_item",
#>   "type": "status",
#>   "id": "%60w%5CX",
#>   "status": {
#>     "id": "c8f1b3f9-4927-44c4-9901-f94d31e7c351",
#>     "name": "To do",
#>     "color": "red"
#>   },
#>   "request_id": "9e3ed29e-1368-4f33-8d71-1dd83a52020d"
#> }