listUsers()

Lists users, newest first by default.

function listUsers(params?: ListUsersParams): Promise<Paginated<User>>

Parameters

Name	Type	Description
`limit`	`number`	How many to return, 1–500. Default 10.
`offset`	`number`	How many to skip.
`query`	`string`	Match email, phone, name or ID.
`orderBy`	`string`	`created_at`, `-created_at`, `last_sign_in_at` …

keyward is the backend client. Create it once with createKeywardClient({ secretKey }) and reuse it.

const { data, totalCount } = await keyward.users.listUsers({ limit: 20, orderBy: "-created_at" });

{ data: User[], totalCount: number }.

Updated Oct 12, 2026

Was this page helpful?

Lists users, newest first by default.

function listUsers(params?: ListUsersParams): Promise<Paginated<User>>

Name	Type	Description
`limit`	`number`	How many to return, 1–500. Default 10.
`offset`	`number`	How many to skip.
`query`	`string`	Match email, phone, name or ID.
`orderBy`	`string`	`created_at`, `-created_at`, `last_sign_in_at` …

keyward is the backend client. Create it once with createKeywardClient({ secretKey }) and reuse it.

const { data, totalCount } = await keyward.users.listUsers({ limit: 20, orderBy: "-created_at" });

{ data: User[], totalCount: number }.

Updated Oct 12, 2026

Was this page helpful?