Skip to content
Athena User Guide
Esc
↑↓navigate↵open⌘Jpreview

List players with their team and score

GET/api/admin/players
Authorization
AuthorizationBearer token · headerrequired
Query parameters
limitinteger
min -9007199254740991 · max 9007199254740991
offsetinteger
min -9007199254740991 · max 9007199254740991
qstring
max length 200
sortstring
Allowed:namepoints
dirstring
Allowed:ascdesc
Responses
200

Success

playersobject[]required
Show properties
Array of object
pointsnumberrequired
idstringrequired
namestringrequired
usernamestringrequired
emailstringrequired
bannedboolean | nullrequired
Show properties
Any of:
boolean
boolean
null
null
createdAtstring<date-time>required
teamIdstring | nullrequired
Show properties
Any of:
string
string
null
null
teamNamestring | nullrequired
Show properties
Any of:
string
string
null
null
teamHandlestring | nullrequired
Show properties
Any of:
string
string
null
null
teamNumbernumber | nullrequired
Show properties
Any of:
number
number
null
null
totalnumberrequired
limitnumberrequired
offsetnumberrequired
401

Unauthorized

errorstringrequired
422

Validation failed

typestringrequired
onstringrequired
summarystring
messagestring
foundany
propertystring
expectedstring
500

Unhandled server error

errorstringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET '/api/admin/players' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "players": [
    {
      "points": 0,
      "id": "string",
      "name": "string",
      "username": "string",
      "email": "string",
      "banned": true,
      "createdAt": "2019-08-24T14:15:22Z",
      "teamId": "string",
      "teamName": "string",
      "teamHandle": "string",
      "teamNumber": 0
    }
  ],
  "total": 0,
  "limit": 0,
  "offset": 0
}