UsersAPI
Defined in: src/api/users.api.ts:16
Users API client for working with Notion users.
Extends
Section titled “Extends”BaseAPI<NotionUser,User>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new UsersAPI(
client):UsersAPI
Defined in: src/api/users.api.ts:23
Parameters
Section titled “Parameters”client
Section titled “client”NotionClient
Returns
Section titled “Returns”UsersAPI
Overrides
Section titled “Overrides”BaseAPI<NotionUser, User>.constructor
Methods
Section titled “Methods”list()
Section titled “list()”list(
params?):Promise<PaginatedList<User>>
Defined in: src/api/users.api.ts:47
List all users in the workspace (paginated).
Parameters
Section titled “Parameters”params?
Section titled “params?”Pagination parameters
Returns
Section titled “Returns”Promise<PaginatedList<User>>
Paginated list of users
https://developers.notion.com/reference/get-users
me():
Promise<User>
Defined in: src/api/users.api.ts:60
Retrieve the bot user associated with the API token.
Returns
Section titled “Returns”Promise<User>
The bot user wrapped in a User model
https://developers.notion.com/reference/get-self
retrieve()
Section titled “retrieve()”retrieve(
userId):Promise<User>
Defined in: src/api/users.api.ts:35
Retrieve a user by ID.
Parameters
Section titled “Parameters”userId
Section titled “userId”string
The ID of the user to retrieve
Returns
Section titled “Returns”Promise<User>
The user wrapped in a User model