On this page

7 endpoints.

MethodPathSummary
GET/api/restrictions/communities/{communityId}/members/{memberId}/restrictionsGet all restrictions (history) for a community member (moderator/admin)
POST/api/restrictions/communities/{communityId}/members/{memberId}/restrictionsApply a new restriction to a community member (moderator/admin)
DELETE/api/restrictions/communities/{communityId}/members/{memberId}/restrictions/{restrictionId}Revoke an active restriction (moderator/admin)
GET/api/restrictions/communities/{communityId}/members/{memberId}/restrictions/activeGet only active restrictions for a community member (moderator/admin)
GET/api/restrictions/communities/{communityId}/restrictionsList all restrictions for a community (moderator/admin)
GET/api/restrictions/communities/{communityId}/restrictions/expiring-soonGet restrictions expiring soon (moderator/admin)
GET/api/restrictions/my/restrictionsGet current user's active restrictions in a community

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)
memberIdpathyesstring (uuid)
pagequerynointeger
limitquerynointeger

Responses

StatusDescriptionBody
200List of restrictions
403Permission denied

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)
memberIdpathyesstring (uuid)

Request body (required) — application/json

FieldTypeRequiredDescription
typeenum: MUTE, RESTRICT, SUSPEND, FEATURE_BLOCKyes
reasonstringyes
durationintegerno
blockedFeaturesstring[]no

Responses

StatusDescriptionBody
201Restriction applied successfully
403Permission denied

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)
memberIdpathyesstring (uuid)
restrictionIdpathyesstring (uuid)

Request bodyapplication/json

FieldTypeRequiredDescription
revokeReasonstringno

Responses

StatusDescriptionBody
200Restriction revoked successfully
403Permission denied

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)
memberIdpathyesstring (uuid)

Responses

StatusDescriptionBody
200List of active restrictions
403Permission denied

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)
pagequerynointeger
limitquerynointeger
typequerynostring
isActivequerynoboolean

Responses

StatusDescriptionBody
200Paginated list of restrictions
403Permission denied

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdpathyesstring (uuid)
withinHoursquerynointeger

Responses

StatusDescriptionBody
200List of expiring restrictions
403Permission denied

Auth: Bearer JWT required.

Parameters

NameInRequiredTypeDescription
communityIdqueryyesstring (uuid)

Responses

StatusDescriptionBody
200User's restrictions
401Authentication required