SysGetPage

Retrieves first page of users from server based on the specified query context.

Note that for apps with > 10,000 users, it is recommended that doCount be set to false for better performance.

Searchable fields

The searchCriteria (and sortCriteria) may only reference fields in the app's allowed user search fields list. By default these are:

profileId, playerId, playerName, emailAddress, memberOf, plus the logical operators $and, $or and $nor.

Field names must match an entry exactly — any other field is rejected with an INVALID_WHERE error.

Service	Operation
user	SYS_GET_PAGE

Method Parameters

Parameter	Description
context	A context JSON object describing the pagination, searchCriteria and sortCriteria options

Usage

http://localhost:3000

C#

// Cloud Code only. To view example, switch to the Cloud Code tab

C++

// Cloud Code only. To view example, switch to the Cloud Code tab

Obj-C

// Cloud Code only. To view example, switch to the Cloud Code tab

Java

// Cloud Code only. To view example, switch to the Cloud Code tab

JavaScript

// Cloud Code only. To view example, switch to the Cloud Code tab

Dart

// Cloud Code only. To view example, switch to the Cloud Code tab

Roblox

-- N/A

GDScript

N/A

Lua

-- Cloud Code only. To view example, switch to the Cloud Code tab

Cloud Code

var context = {
  "pagination": {
    "rowsPerPage": 20,
    "pageNumber": 1,
    "doCount": false
  },
  "searchCriteria": {
    "playerName": {
      "$regex": "^Bat"
    }
  },
  "sortCriteria": {
  }
}

var userProxy = bridge.getUserServiceProxy();

var postResult = userProxy.sysGetPage( context );
if (postResult.status == 200) {
    // Success!
}

Raw

// Cloud Code only. To view example, switch to the Cloud Code tab

JSON Response

{
    "status": 200,
    "data": {
        "context": "eyJzZWFyY2hDcml0ZXJpYSI6eyJnYW1lSWQiOiIyMTc3NCxxx...",
        "results": {
            "count": 1,
            "page": 1,
            "items": [
                {
                    "profileId": "0b53155b-1fc8-4916-XXXX-298379efc67a",
                    "playerName": "Bats",
                    "countryCode": "CA",
                    "timeZoneOffset": -5,
                    "summaryFriendData": {
                        "favColor": "black"
                    },
                    "emailAddress": "bruce@wayneent.com"
                }
            ],
            "moreAfter": false,
            "moreBefore": false
        }
    }
}