GET /players

Description

Returns a listing of all players in the game. This route can only be used with the game or debug scope.

Resource URL

https://api.playlyfe.com/players

Method

GET

Scopes

game, debug

Parameters

LocationParameter NameDefault ValueDescription
Queryskip0Number of players to skip
Querylimit10Maximum number of players to return

Example

Request
GET https://api.playlyfe.com/players
Response
{
  "data": [
    {
      "id": "morpheus",
      "alias": "Morpheus",
      "enabled": true
    },
    {
      "alias": "Neo",
      "enabled": true,
      "id": "neo"
    },
    {
      "id": "trinity",
      "alias": "Trinity",
      "enabled": true
    }
  ],
  "total": 3
}