UsersEndpoint: R6 Class for Users Endpoint

In notionapi: Client for the 'Notion API'

R6 Class for Users Endpoint

Description

Handle all users operations in the Notion API

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

Value

A list containing the parsed API response.

Methods

Public methods

• UsersEndpoint$new()

• UsersEndpoint$list()

• UsersEndpoint$retrieve()

• UsersEndpoint$me()

---

Method new()

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

Usage

UsersEndpoint$new(client)

Arguments

client

Notion Client instance

---

Method list()

List all users

Usage

UsersEndpoint$list(start_cursor = NULL, page_size = NULL)

Arguments

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

---

Method retrieve()

Retrieve a user

Usage

UsersEndpoint$retrieve(user_id)

Arguments

user_id

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

Details

Endpoint documentation

---

Method me()

Retrieve the bot User associated with the API token

Usage

UsersEndpoint$me()

Details

Endpoint documentation

Examples

notion <- notion_client()

# ----- List all users
notion$users$list()


# ----- Retrieve a user
notion$users$retrieve("fda12729-108d-4eb5-bbfb-a8f0886794d1")


# ----- Retrieve the bot User associated with the API token
notion$users$me()

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