Sign in
UserService

ListUsers retrieves a list of users.

Changed on
get/api/v2/users

Request

  • The document declares no server URL.
  • Auth: none declared

Query parameters

pageSizeinteger

The number of users to retrieve per page.

pageTokenstring

Pagination token for retrieving the next page of users.

skipinteger

The number of users to skip for pagination purposes.

orderBystring

The sorting criteria for the user list.

nameLikestring

Filter users by username using a "like" operation.

emailLikestring

Filter users by email using a "like" operation.

roleNamestring

Filter users by role name.

Response

A successful response.

nextPageTokenstring

Token for the next page of results.

totalSizeinteger

The total number of users that match the filter criteria.

Changes