index/interfaces/ListUsersOptions.md
Options for listing users with pagination and filters
Since
6.x.0
Extends
base pagination options
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
cursor? | string | Cursor token for fetching the next page (omit for first page) - for cursor-based pagination | BasePaginationOptions.cursor |
pageSize? | number | Page size for cursor-based pagination (defaults to 50, max 1000) | BasePaginationOptions.pageSize |
search? | string | Search query (searches by username, email, address) | - |
sortBy? | string | Sort field (username, email, joinedAt, activity) | - |
sortOrder? | "ASC" | "DESC" | "asc" | "desc" | Sort direction; the backend reads it case-insensitively | - |
base pagination options page size sort by order