logo
AdminList bans

List bans

curl -X GET "https://mail.haltman.io/api/admin/bans?limit=42&offset=42&active=true&ban_type=email&ban_value=example_string" \
  -H "Content-Type: application/json"
{
  "items": [
    {
      "id": 123,
      "ban_type": "email",
      "ban_value": "example_string",
      "reason": "example_string",
      "created_at": "2024-12-25T10:00:00Z",
      "expires_at": "2024-12-25T10:00:00Z",
      "revoked_at": "2024-12-25T10:00:00Z",
      "revoked_reason": "example_string",
      "active": true
    }
  ],
  "pagination": {
    "total": 42,
    "limit": 42,
    "offset": 42
  }
}
GET
/api/admin/bans
GET
API Key (cookie: __Host-access)
__Host-accessstring
Required

Access-session cookie used for user and admin authentication.

Access-session cookie used for user and admin authentication.
query
limitinteger

Page size. Default 50, maximum 200.

Min: 1 • Max: 200
query
offsetinteger

Zero-based page offset.

Min: 0
query
activestring

Boolean-like filter accepting 0/1 and common textual equivalents.

query
ban_typestring
Options: email, domain, ip, name
Request Preview
Response

Response will appear here after sending the request

Authentication

path
parameterstring
Required

API Key for authentication. Access-session cookie used for user and admin authentication.

Query Parameters

limitinteger

Page size. Default 50, maximum 200.

offsetinteger

Zero-based page offset.

activestring

Boolean-like filter accepting 0/1 and common textual equivalents.

ban_typestring
Allowed values:emaildomainipname

Responses

itemsarray
Required
paginationobject
Required