Skip to content
RallyHere Docs

Get Players Paged

GET
/users/v2/player:iterate

Iterate over all players. This is a paginated API, so you will need to call it multiple times to get all players. There is no guaranteed ordering of players. So if you need to run multiple iterations for comparison, you will need to sort the results.

Required Permissions:

  • For any player (including themselves) any of: user:*, user:player:iterate

Authorizations

Parameters

Query Parameters

cursor

Cursor to continue iteration. Leaving this empty will begin a new query

string
"" <= 4096 characters

cursor to continue iteration. Leaving this empty will begin a new query

page_size

Number of players to return

integer
default: 100 >= 1 <= 1000

number of players to return

Responses

200

Successful Response

Response from the player iteration API

object
players

List of players. An empty list means iteration is complete

Array<object>
default:

Response for getting a player’s info

object
player_id
required

Player ID DEPRECATED use player_uuid instead

integer
player_uuid
required

Player UUID

string format: uuid
cursor

Cursor to continue iteration

string
""

400

Bad Request

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

403

Error Codes:

  • auth_invalid_key_id - Invalid Authorization - Invalid Key ID in Access Token
  • auth_invalid_version - Invalid Authorization - version
  • auth_malformed_access - Invalid Authorization - malformed access token
  • auth_not_jwt - Invalid Authorization
  • auth_token_expired - Token is expired
  • auth_token_format - Invalid Authorization - {}
  • auth_token_invalid_claim - Token contained invalid claim value: {}
  • auth_token_sig_invalid - Token Signature is invalid
  • auth_token_unknown - Failed to parse token
  • insufficient_permissions - Insufficient Permissions
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string