Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Communities::Ban

List Bans

List bans for a community

get/communities/{community_id}/bans

Path parameters

community_idinteger required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

OK

idinteger

Ban ID

public_idstring nullable

Ban public ID

community_idinteger

ID of the Community this ban applies to

bannable_typestring

Polymorphic type of the bannable scope (e.g. Community)

bannable_idinteger

Polymorphic ID of the bannable scope

banned_by_idinteger

ID of the membership record that issued the ban (set automatically)

reasonstring nullable

Optional reason for the ban (max 1024 characters)

created_atstring date-time

Created at

updated_atstring date-time

Updated at

Example response

[
  {
    "id": 201,
    "public_id": "MnOpQr",
    "community_id": 1,
    "bannable_type": "Community",
    "bannable_id": 1,
    "banned_by_id": 12,
    "reason": "Violated community guidelines",
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z",
    "contact": {
      "id": 55,
      "public_id": "GhIjKl",
      "email_address": "member@example.com",
      "first_name": "Jane",
      "last_name": "Doe",
      "phone_number": null
    }
  }
]