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

Request

Query Parameters

cursor Cursor

Possible values: <= 4096 characters

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

page_size Page Size

Possible values: >= 1 and <= 1000

Default value: 100

number of players to return

Responses

200

Successful Response

application/json

Schema

Schema

players

object[]

List of players. An empty list means iteration is complete

Array [

player_id Player Id (integer)requireddeprecated

Player ID DEPRECATED use player_uuid instead

player_uuid uuidrequired

Player UUID

]

cursor Cursor (string)

Cursor to continue iteration

Example (from schema)

{
  "players": [
    {
      "player_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "cursor": "string"
}

400

Bad Request

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "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_invalid_type - Invalid Authorization - Invalid Token Type

• auth_token_sig_invalid - Token Signature is invalid

• auth_token_unknown - Failed to parse token

• insufficient_permissions - Insufficient Permissions

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...