Players
A Player represents a person on a team roster within a division.
Endpoint: /api/v1/players
Required scope: read:players (read) / admin (write)
Players live on divisionTeam.players (a virtual field). Use ?include=players on divisionTeams or games endpoints to get player rosters.
Endpoints
| Method | Path | Auth | Description |
|---|---|---|---|
| GET | /api/v1/players?team=:id | Required | List players for a team |
| GET | /api/v1/players/:id | Required | Get a single player |
| POST | /api/v1/players | Required | Create a player |
| PUT | /api/v1/players/:id | Required | Update a player |
Allowed ?include= roots: team, organization, league, division, registration, registrationTeam. To populate the player’s team in the same request: ?include=team. See Query Parameter: ?include=.
Fields
| Field | Type | Description |
|---|---|---|
_id | ObjectId | Unique identifier |
name | string | Player full name. Default: "" |
email | string | Player email address. Default: "" |
number | string | Jersey number. Default: "" |
info | any | Flexible additional info (mixed type) |
waiverDetails | WaiverDetail[] | Waiver signature records |
team | ObjectId | Parent DivisionTeam (ref: DivisionTeam) |
organization | ObjectId | Owning organization (ref: Organization) |
tournament | ObjectId | Associated tournament (ref: Tournament) |
registrationTeam | ObjectId | Registration team submission (ref: RegistrationTeam) |
registration | ObjectId | Associated registration (ref: Registration) |
user | ObjectId | Linked user account (ref: User) |
created | date | Creation timestamp |
updated | date | Last update timestamp |
WaiverDetail Sub-Schema
| Field | Type | Description |
|---|---|---|
sentDate | date | Date waiver was sent |
signDate | date | Date waiver was signed |
accepted | boolean | Whether waiver was accepted |
waiver | ObjectId | Waiver ref (ref: Waiver) |
signedName | string | Name as signed |
Get Players for a Team
# Via divisionTeams endpoint (recommended)
curl "https://api.staty.io/api/v1/divisionTeams/TEAM_ID?include=players" \
-H "Authorization: Bearer sk_live_..."
# Via players endpoint
curl "https://api.staty.io/api/v1/players?team=TEAM_ID" \
-H "Authorization: Bearer sk_live_..."Response:
{
"success": true,
"data": [
{
"_id": "player_abc",
"name": "Alex Johnson",
"email": "alex@example.com",
"number": "7",
"team": "divteam_xyz",
"waiverDetails": [
{
"sentDate": "2026-03-01T00:00:00.000Z",
"signDate": "2026-03-02T00:00:00.000Z",
"accepted": true,
"signedName": "Alex Johnson"
}
]
}
],
"count": 1
}Last updated on