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

List teams by score

GET/api/admin/teams
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

teamsobject[]required
Show properties
Array of object
pointsnumberrequired
idstringrequired
namestringrequired
handlestringrequired
numbernumber | nullrequired
Show properties
Any of:
number
number
null
null
admittedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
isHiddenbooleanrequired
leaderUserIdstring | nullrequired
Show properties
Any of:
string
string
null
null
createdAtstring<date-time>required
ranknumber | nullrequired
Show properties
Any of:
number
number
null
null
memberCountnumberrequired
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/teams' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "teams": [
    {
      "points": 0,
      "id": "string",
      "name": "string",
      "handle": "string",
      "number": 0,
      "admittedAt": "2019-08-24T14:15:22Z",
      "isHidden": true,
      "leaderUserId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "rank": 0,
      "memberCount": 0
    }
  ],
  "total": 0,
  "limit": 0,
  "offset": 0
}