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

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required

Query Parameters

page
number
type
enum<string>
Available options:
player,
moderator
user_id
string

Response

200 - application/json
actor
object
required
victim
object
required
removed_by
object | null
has_comments
boolean
required
createdAt
string
required
updatedAt
string
required
_id
string
required
reason
string
required
source
string
required
removed_at
string
ban_incremental_id
number
required