tokportal_list_account_bans
Retrieve and monitor validated ban reports and appeals for your delivered accounts, covering the full lifecycle from pending appeals to staff resolutions. Poll for updates using a timestamp watermark to track status changes.
Instructions
List ban reports and appeals. Pollable list of validated ban reports for the caller's delivered accounts, covering the whole lifecycle: appeal_pending (platform appeal filed, account unavailable but NOT yet banned), appeal_accepted (account survived), appeal_refused / no_appeal_banned (confirmed ban), and the staff commercial resolution (refund / remake / no_remake with a machine-readable reason_code such as tos_ban). This is the REST counterpart of the account.banned, account.ban_appeal.submitted, account.ban_appeal.resolved and account.ban_resolution.decided webhook events. Only staff/CM-validated bans appear here — detections from TokPortal's internal health scan are never listed. Poll with the since parameter (updated_at watermark) to pick up new reports and status changes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number. | |
| since | No | Only reports updated at or after this ISO 8601 timestamp. Use the highest updated_at you have seen as a polling watermark. | |
| status | No | Filter by appeal lifecycle status. | |
| per_page | No | Items per page. | |
| account_id | No | Filter by saved account ID. | |
| resolution | No | Filter by staff commercial resolution. 'pending' selects confirmed bans still awaiting the staff decision. | |
| include_screenshots | No | When true, each report includes a signed 7-day URL of the ban-evidence screenshot when one exists. |