Class: ListUsers

ListUsers(optional)

Gets a list of IDs of users currently present in the catalog.

Constructor

new ListUsers(optional)

Construct the request
Parameters:
Name Type Description
optional Object Optional parameters given as an object with structure name of the parameter: value - Allowed parameters: - *filter* - Type: string - Description: Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to filter users to be listed. Only the users for which the expression is *true* will be returned. - *count* - Type: number - Description: The number of users to be listed. - *offset* - Type: number - Description: Specifies the number of users to skip (ordered by `userId`). - *returnProperties* - Type: boolean - Description: With `returnProperties=true`, property values of the listed users are returned along with their IDs in a JSON dictionary. Example response: ``` [ { "userId": "user-81", "country": "US", "sex": "M" }, { "userId": "user-314", "country": "CAN", "sex": "F" } ] ``` - *includedProperties* - Type: string[] - Description: Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. Example response for `includedProperties=country`: ``` [ { "userId": "user-81", "country": "US" }, { "userId": "user-314", "country": "CAN" } ] ```
Source:

Methods

bodyParameters() → {Object}

Get body parameters
Source:
Returns:
The values of body parameters (name of parameter: value of the parameter)
Type
Object

queryParameters() → {Object}

Get query parameters
Source:
Returns:
The values of query parameters (name of parameter: value of the parameter)
Type
Object