Function: user.Get

Returns a filtered list of User Objects. Only for the UI the users will contain the password property though.

Syntax

{
	"method": "user.Get",
	"params": {
		"mode": "...",
		"include": "...",
		"filter": "...",
		"sort": "...",
		"offset": "...",
		"limit": "...",
		"select": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
get(mode?: DataMode | undefined, include?: DataMode | undefined, filter?: DataFilter | undefined, sort?: DataSortItem[] | undefined, offset?: number | undefined, limit?: number | undefined): Promise<UserGetResult>;

Parameters

mode : DataMode optional

View of the objects to return: raw or effective. Default is effective.

include : DataMode optional

Adds the other view to the result; only values that differ are added (under @meta.overlay).

filter : DataFilter optional

Filter definition which determines the result set.

sort : DataSortItem[] optional

Sorting definition as a list of properties with order.

offset : int optional

Offset of the first Object in the result set that should be returned. Used for direct pagination.

limit : int optional

Maximum amount of Objects that should be returned. (Max : 100000)

select : string[] optional

List of properties that should be contained in the result objects.

Result : UserGetResult

Contains result objects and pagination info, if present.

Errors

Data.InvalidFilterExpression

The provided filter expression has invalid syntax.

Remarks

This method requires API read access.