Skip to main content
GET
List bans

Authorizations

Authorization
string
header
required

A workspace API key from Settings › Developer.

Query Parameters

workspace_id
string
required

The workspace: the 24-character ID in its Ankra address, or its UUID.

active_only
boolean
default:true

false includes lifted bans.

Matches the player username.

limit
integer
default:50

How many to return, up to 100.

Required range: 1 <= x <= 100
offset
integer
default:0

How many to skip, for paging.

Required range: x >= 0

Response

OK.

bans
object[]
offset
integer
limit
integer