Moderation endpoints

The moderation endpoints allow authenticated users with appropriate permissions to view and manage user reports.

Authentication

All moderation endpoints require:

Valid JWT token in the Authorization header
User must be active (is_active = true)
User must have report_read permission

Inactive users or users without proper permissions will receive a 403 Forbidden response.

Get reports

GET /api/v1/reports

Retrieves a paginated list of reports based on filter criteria.

Query parameters

public_access

string

required

Filter by visibility status:

v - Visible posts
h - Hidden posts

mod_status

string

required

Filter by moderation status:

o - Open reports
c - Closed reports

board_shortnames

string | array

default:"all boards"

Board(s) to filter by. Can be a single board shortname (1-5 characters) or an array of board shortnames. Defaults to all configured boards.

page_size

integer

default:"20"

Number of reports per page. Must be between 1 and 50.

page_num

integer

default:"0"

Page number (0-indexed). Must be non-negative.

Authorization

string

required

Bearer token from the login endpoint

Show Example request

curl -X GET "https://archive.example.com/api/v1/reports?public_access=v&mod_status=o&page_size=10&page_num=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Show Example request with board filter

curl -X GET "https://archive.example.com/api/v1/reports?public_access=h&mod_status=c&board_shortnames=g&board_shortnames=tech" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

Returns an array of report objects matching the filter criteria.

Show Example response

[
  {
    "report_parent_id": 123,
    "board": "g",
    "post_num": 12345678,
    "public_access": "h",
    "mod_status": "o",
    "created_at": "2026-01-15T12:34:56",
    "submitter_category": "Spam or flooding",
    "mod_notes": null
  }
]

Take action on report

POST /api/v1/reports/{report_parent_id}

Performs a moderation action on a specific report.

report_parent_id

integer

required

The ID of the report to act upon

Authorization

string

required

Bearer token from the login endpoint

Request body

action

string

required

The moderation action to perform:

report_delete - Delete the report
post_delete - Delete the reported post
media_delete - Delete the media file
media_hide - Hide the media file
media_show - Show the media file
post_show - Show the post
post_hide - Hide the post
report_close - Close the report
report_open - Reopen the report
report_save_notes - Save moderator notes

mod_notes

string | null

Optional moderator notes to attach to the action

Show Example request

curl -X POST "https://archive.example.com/api/v1/reports/123" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "post_hide",
    "mod_notes": "Spam content removed"
  }'

Response

msg

string

Success message (status code < 400)

error

string

Error message (status code >= 400)

Show Success response (200)

{
  "msg": "Post hidden successfully"
}

Show Error response (404)

{
  "error": "Report not found"
}

Bulk actions on reports

POST /api/v1/reports/bulk

Performs the same moderation action on multiple reports.

Authorization

string

required

Bearer token from the login endpoint

Request body

action

string

required

The moderation action to perform (see actions list above)

report_parent_ids

array

required

Array of report IDs to act upon. Must contain at least one ID. All IDs must be non-negative integers.

mod_notes

string | null

Optional moderator notes to attach to all actions

Show Example request

curl -X POST "https://archive.example.com/api/v1/reports/bulk" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "report_close",
    "report_parent_ids": [123, 124, 125],
    "mod_notes": "Bulk closure - spam cleanup"
  }'

Response

Returns a results object with the outcome for each report ID.

results

object

Dictionary mapping report IDs to their individual results, each containing msg and code.

Show All success response (200)

{
  "123": {
    "msg": "Report closed",
    "code": 200
  },
  "124": {
    "msg": "Report closed",
    "code": 200
  },
  "125": {
    "msg": "Report closed",
    "code": 200
  }
}

Show Mixed results (207 Multi-Status)

{
  "123": {
    "msg": "Report closed",
    "code": 200
  },
  "124": {
    "msg": "Report not found",
    "code": 404
  },
  "125": {
    "msg": "Report closed",
    "code": 200
  }
}

When results have mixed status codes, the endpoint returns 207 Multi-Status. If all operations have the same status, that status code is returned.

Required permissions

All moderation endpoints require the report_read permission. Additional permissions may be checked based on the action being performed:

report_delete - Delete reports
report_open / report_close - Change report status
report_save_notes - Save moderator notes
post_show / post_hide / post_delete - Modify posts
media_show / media_hide / media_delete - Modify media

API Overview

Web Endpoints

API Endpoints

CLI Commands

Authentication

Get reports

Query parameters

Response

Take action on report

Request body

Response

Bulk actions on reports

Request body

Response

Required permissions

Build docs developers (and LLMs) love

API Overview

Web Endpoints

API Endpoints

CLI Commands

​Authentication

​Get reports

​Query parameters

​Response

​Take action on report

​Request body

​Response

​Bulk actions on reports

​Request body

​Response

​Required permissions

Build docs developers (and LLMs) love

Authentication

Get reports

Query parameters

Response

Take action on report

Request body

Response

Bulk actions on reports

Request body

Response

Required permissions