API
group.getBans
API
group.getBans
Returns a group's bans. Must have valid permissions to view.
GET https://group.api.rivet.gg/v1/groups/{group_id}/bans
curl -X GET 'https://group.api.rivet.gg/v1/groups/{group_id}/bans'
Authorizations
Authorization[header]required
string
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
group_idrequired
string
Query Parameters
anchor
string
The pagination anchor. Set to the returned anchor of this endpoint to receive the next set of items.
count
number
Amount of bans to return.
watch_index
string
A query parameter denoting the requests watch index.
Response
banned_identitiesrequired
array
A list of banned group members.
anchor
string
The pagination anchor.
watchrequired
object
Provided by watchable endpoints used in blocking loops.
curl -X GET 'https://group.api.rivet.gg/v1/groups/{group_id}/bans'