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

List players with their team and score

GET/api/admin/players
Query parameters
limitnumber
offsetnumber
qstring
max length 200
sortstring
Allowed:namepoints
dirstring
Allowed:ascdesc
Responses
200

Success

playersobject[]required
Show properties
Array of object
pointsnumber | nullrequired
Show properties
Any of:
number
number
null
null
teamIdstring | nullrequired
Show properties
Any of:
string
string
null
null
teamNamestring | nullrequired
Show properties
Any of:
string
string
null
null
idstringrequired
namestringrequired
emailstringrequired
emailVerifiedbooleanrequired
imagestring | nullrequired
Show properties
Any of:
string
string
null
null
createdAtstring<date-time>required
updatedAtstring<date-time>required
usernamestringrequired
bannedboolean | nullrequired
Show properties
Any of:
boolean
boolean
null
null
banReasonstring | nullrequired
Show properties
Any of:
string
string
null
null
banExpiresstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
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
Parameters
Request
curl -X GET '/api/admin/players' \
  -H 'Accept: application/json'
Response
{
  "players": [
    {
      "points": 0,
      "teamId": "string",
      "teamName": "string",
      "id": "string",
      "name": "string",
      "email": "string",
      "emailVerified": true,
      "image": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "username": "string",
      "banned": true,
      "banReason": "string",
      "banExpires": "2019-08-24T14:15:22Z"
    }
  ],
  "total": 0,
  "limit": 0,
  "offset": 0
}