Skip to main content

index/interfaces/ListUsersOptions.md

Options for listing users with pagination and filters

Since​

6.x.0

Extends​

Properties​

PropertyTypeDescriptionInherited from
cursor?stringCursor token for fetching the next page (omit for first page) - for cursor-based paginationBasePaginationOptions.cursor
pageSize?numberPage size for cursor-based pagination (defaults to 50, max 1000)BasePaginationOptions.pageSize
search?stringSearch query (searches by username, email, address)-
sortBy?stringSort field (username, email, joinedAt, activity)-
sortOrder?"ASC" | "DESC" | "asc" | "desc"Sort direction; the backend reads it case-insensitively-