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

Read the roster lock status

GET/api/admin/roster
Authorization
AuthorizationBearer token · headerrequired
Responses
200

Success

rosterLockedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
admissionCapnumberrequired
admittedTeamsobject[]required
Show properties
Array of object
idstringrequired
handlestringrequired
namestringrequired
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
referenceTeamsnumberrequired
401

Unauthorized

errorstringrequired
500

Unhandled server error

errorstringrequired
Try it
Server
Authorization
Request
curl -X GET '/api/admin/roster' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "rosterLockedAt": "2019-08-24T14:15:22Z",
  "admissionCap": 0,
  "admittedTeams": [
    {
      "id": "string",
      "handle": "string",
      "name": "string",
      "number": 0,
      "admittedAt": "2019-08-24T14:15:22Z",
      "isHidden": true
    }
  ],
  "referenceTeams": 0
}