getUsers

Retrieves a paginated and searchable list of all users.

Return

A Users.Response object containing the list of users and pagination metadata.

Parameters

request

The request object containing search, page, and pageSize parameters.


suspend fun Umami.getUsers(search: String? = null, page: Int? = null, pageSize: Int? = null): Users.Response

Retrieves a paginated and searchable list of all users. This is a convenience function that creates a Users.Request object.

Return

A Users.Response object containing the list of users and pagination metadata.

Parameters

search

Optional search query to filter users by name or other attributes.

page

Optional page number for pagination (1-indexed).

pageSize

Optional number of users per page.