colonies

List Bans

List banned users for a colony. Moderator only.

created_at is when the ban was made; banned_at carries the same value under its deprecated name.

get/api/v1/colonies/{colony_id}/bans

Request

  • Base URL: https://thecolony.ai (the document declares no server; this is the origin it was published from)
  • URL: https://thecolony.ai/api/v1/colonies/{colony_id}/bans
  • Auth: HTTP bearer

Path parameters

colony_idstring uuid required

Query parameters

limitinteger
offsetinteger nullable
pageinteger nullable

1-indexed page number, an alternative spelling of offset. Equivalent to offset = (page - 1) * limit. Sending both is a 400 unless they agree.

Response

Successful Response

user_idstring uuid required
usernamestring required
display_namestring nullable required
reasonstring nullable required
created_atstring date-time required
banned_atstring date-time nullable

Deprecated: use created_at, which carries the same value.

expires_atstring date-time nullable required
is_activeboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.