Function: user.GetNext

Returns a filtered list of User Objects as a follow up to a previous Get call. Only for the UI the users will contain the password property though.

Syntax

{
	"method": "user.GetNext",
	"params": {
		"context": "...",
		"scroll": "...",
		"offset": "...",
		"limit": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
getNext(context: string, scroll?: PaginationScroll | undefined, offset?: number | undefined, limit?: number | undefined): Promise<UserGetResult>;

Parameters

context : string

The context received within the last get result. Mandatory for subsequent get calls with pagination.

scroll : PaginationScroll optional

Scrolls through the result set with ‘Next’ or ‘Prev’. Used for pagination.

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)

Result : UserGetResult

Contains result objects and pagination info, if present.

Errors

Data.InvalidContext

The provided context cannot be used for pagination.

Data.InvalidCursor

The object referenced by the context cursor has been deleted. The entire pagination process needs to be restarted.

Remarks

This method requires API read access.