Skip to main content

Function: listUsers()

listUsers(client, props): Promise<{ rows: object[]; rowCount: number; }>

Lists users with optional search and pagination.

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

query​

{ pageOffset?: number; pageSize?: number; sortBy?: "email" | "name" | "createdAt" | "fullName"; sortDir?: "asc" | "desc"; searchText?: string; } = listUsersQuerySchema

Query parameters for filtering, pagination, and sorting

query.pageOffset?​

number = ...

query.pageSize?​

number = ...

query.sortBy?​

"email" | "name" | "createdAt" | "fullName" = ...

query.sortDir?​

"asc" | "desc" = ...

query.searchText?​

string = ...

Returns​

Promise<{ rows: object[]; rowCount: number; }>

Promise resolving to a paginated list of users

Operation Id​

list-users

Example​

const users = await listUsers(client, {
  query: { searchText: 'john', pageOffset: 0, pageSize: 20 }
});