List all users

Method

client.users.list(args: ListUsersParameters): Promise<ListUsersResponse>

Parameters

string

If supplied, this endpoint will return a page of results starting after the cursor provided. If not supplied, this endpoint will return the first page of results.

number

The number of items from the full list desired in the response. Maximum: 100.

string

Bearer token for authentication. If not provided, the client-level auth is used.

Response

string

Always "list".

string

Always "user".

array

An array of User objects.

string | null

A cursor to use in the next request to get the next page of results. If null, there are no more results.

boolean

Whether there are more results to fetch.

Example

const response = await client.users.list({
  page_size: 10,
})

console.log(response.results)

Pagination

Use the pagination helpers for easy iteration:

import { iteratePaginatedAPI } from "@notionhq/client"

for await (const user of iteratePaginatedAPI(client.users.list, {})) {
  console.log(user.name)
}

Client

Blocks

Pages

Databases

Data Sources

Users

Comments

File Uploads

Search & OAuth

Helpers

Errors

Method

Parameters

Response

Example

​Method

​Parameters

​Response

​Example

​Pagination

Method

Parameters

Response

Example

Pagination