Bans (Invite Only)
Get Bans
API Documentation
Activity
- In-Game Tracking
- Users
- Sessions
- GETRetrieve Leaderboard
Order Logging
Staff
Workspace
- GETRetrieve a Workspace
- POSTUpdate a Workspace
- GETList Games
- POSTCreate Game
- DELDelete a Game
- GETList Roles
- POSTCreate a Role
- PUTUpdate Role
- DELDelete a Role
- GETList logbook templates
- GETRetrieve Logbook Template
- POSTCreate a Logbook Template
- PATCHUpdate a Logbook Template
- DELDelete a Logbook Template
- GETRetrieve GApps Config
- POSTSet GApps Service Account
- PATCHUpdate GApps Config
- DELDelete GApps Config
- GETGet Trello Config
- GETGet Trello boards
- POSTSet Trello board
- POSTSet Trello format
- DELDisconnect Trello board
- DELDelete Trello Config
- GETRetrieve Schedules
- POSTCreate a Schedule
- POSTUpdate a Schedule
Trello Integration
Bans (Invite Only)
Connections
Bans (Invite Only)
Get Bans
Retrieve a list of bans
GET
/
players
/
bans
/
{workspaceId}
curl --request GET \
--url https://api.hyra.io/players/bans/{workspaceId} \
--header 'Authorization: Bearer <token>'
[
{
"actor": {
"exists": true,
"id": "<string>",
"username": "<string>",
"display_name": "<string>"
},
"victim": {
"exists": true,
"id": "<string>",
"username": "<string>",
"display_name": "<string>"
},
"removed_by": {
"exists": true,
"id": "<string>",
"username": "<string>",
"display_name": "<string>"
},
"has_comments": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"_id": "<string>",
"reason": "<string>",
"source": "<string>",
"removed_at": "<string>",
"ban_incremental_id": 123
}
]
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Query Parameters
Available options:
player
, moderator
Response
200 - application/json
Default Response
The response is of type object[]
.
curl --request GET \
--url https://api.hyra.io/players/bans/{workspaceId} \
--header 'Authorization: Bearer <token>'
[
{
"actor": {
"exists": true,
"id": "<string>",
"username": "<string>",
"display_name": "<string>"
},
"victim": {
"exists": true,
"id": "<string>",
"username": "<string>",
"display_name": "<string>"
},
"removed_by": {
"exists": true,
"id": "<string>",
"username": "<string>",
"display_name": "<string>"
},
"has_comments": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"_id": "<string>",
"reason": "<string>",
"source": "<string>",
"removed_at": "<string>",
"ban_incremental_id": 123
}
]