Sign in
Users

List Users

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

get/{databaseId}/users/list/

Path parameters

databaseIdstring required

ID of your database.

Query parameters

filterstring

Boolean-returning ReQL expression, which allows you to filter users to be listed. Only the users for which the expression is true will be returned.

countinteger

The number of users to be listed.

offsetinteger

Specifies the number of users to skip (ordered by userId).

returnPropertiesboolean

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"
    }
  ]
includedPropertiesstring[]

Allows specifying 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"
    }
  ]

Response

Successful operation.

userIdstring required

Id of the user

valuesobject

Property values of the user

Changes

No recorded changes to this endpoint across all 1 revision of this API.