Bans
get
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816
Query parameters
ban_typestring · enumOptionalPossible values:
ban_type_valuestringOptional
reasonstringOptional
limitinteger · int32 · min: 1 · max: 100Optional
The maximum number of items to return in a single request.
afterinteger · int64Optional
Returns items after the specified ID. Used for forward pagination through results.
beforeinteger · int64Optional
Returns items before the specified ID. Used for backward pagination through results.
ascbooleanOptional
Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.
Responses
200
OK
application/json
default
Error response
application/json
get
GET /v1/stores/{storeId}/bans HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
[
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"reason": "text",
"enabled": true,
"identities": [
{
"ban_type": "unknown",
"ban_type_value": "text"
}
],
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"created_at": "2025-08-02T17:56:38.750Z",
"updated_at": "2025-08-02T17:56:38.750Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"expires_at": "2025-08-02T17:56:38.750Z"
}
]
post
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816
Body
reasonstring | nullableOptional
expires_atstring · date-time | nullableOptional
Responses
201
Created
application/json
default
Error response
application/json
post
POST /v1/stores/{storeId}/bans HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 119
{
"reason": "text",
"identities": [
{
"ban_type": "unknown",
"ban_type_value": "text"
}
],
"expires_at": "2025-08-02T17:56:38.750Z"
}
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"reason": "text",
"enabled": true,
"identities": [
{
"ban_type": "unknown",
"ban_type_value": "text"
}
],
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"created_at": "2025-08-02T17:56:38.750Z",
"updated_at": "2025-08-02T17:56:38.750Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"expires_at": "2025-08-02T17:56:38.750Z"
}
get
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816
banIdstring · flake-idRequiredExample:
411486491630370816
Responses
200
OK
application/json
default
Error response
application/json
get
GET /v1/stores/{storeId}/bans/{banId} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"reason": "text",
"enabled": true,
"identities": [
{
"ban_type": "unknown",
"ban_type_value": "text"
}
],
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"created_at": "2025-08-02T17:56:38.750Z",
"updated_at": "2025-08-02T17:56:38.750Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"expires_at": "2025-08-02T17:56:38.750Z"
}
delete
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816
banIdstring · flake-idRequiredExample:
411486491630370816
Responses
204
No Content
default
Error response
application/json
delete
DELETE /v1/stores/{storeId}/bans/{banId} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No content
patch
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816
banIdstring · flake-idRequiredExample:
411486491630370816
Body
reasonstring | nullableOptional
expires_atstring · date-time | nullableOptional
Responses
200
OK
application/json
default
Error response
application/json
patch
PATCH /v1/stores/{storeId}/bans/{banId} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 119
{
"reason": "text",
"identities": [
{
"ban_type": "unknown",
"ban_type_value": "text"
}
],
"expires_at": "2025-08-02T17:56:38.750Z"
}
{
"id": "411486491630370816",
"store_id": "411486491630370816",
"reason": "text",
"enabled": true,
"identities": [
{
"ban_type": "unknown",
"ban_type_value": "text"
}
],
"created_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"created_at": "2025-08-02T17:56:38.750Z",
"updated_at": "2025-08-02T17:56:38.750Z",
"updated_by": {
"type": "anonymous",
"id": "411486491630370816"
},
"expires_at": "2025-08-02T17:56:38.750Z"
}
post
Authorizations
Path parameters
storeIdstring · flake-idRequiredExample:
411486491630370816
Body
Responses
200
OK
application/json
default
Error response
application/json
post
POST /v1/stores/{storeId}/bans/check HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 63
{
"identities": [
{
"ban_type": "unknown",
"ban_type_value": "text"
}
]
}
{
"identities": [
{
"ban_type": "unknown",
"ban_type_value": "text"
}
]
}
Was this helpful?