Moderator Toolbox stores all per-subreddit moderation data in subreddit wiki pages, which are accessible through the standard Reddit API. Third-party apps, bots, and scripts can read and write this data directly — no Toolbox-specific API required.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/toolbox-team/reddit-moderator-toolbox/llms.txt
Use this file to discover all available pages before exploring further.
Data stores
Toolbox uses two primary wiki-based data stores per subreddit:Usernotes
Per-user moderation notes stored as compressed JSON in the
usernotes wiki page. Supports schema versions 4 through 6 (v6 current).Subreddit config
Removal reasons, note type definitions, ban macros, and mod macros stored as plain JSON in the
toolbox wiki page. Schema version 1.Ban notes
Ban reason macros and templates stored in the
banmacros wiki page, used during the Toolbox ban flow.Wiki storage
Technical details on how Toolbox reads and writes wiki pages, including compression, versioning, and API endpoints.
Authentication
All wiki access requires Reddit OAuth authentication. Your app must request the appropriate scopes before reading or writing Toolbox data.Reading wiki pages requires the
wikiedit or wikiread scope depending on the subreddit’s wiki access settings. Writing requires wikiedit. Moderator-only wiki pages (which Toolbox enforces) additionally require the calling user to be a moderator of the target subreddit.Reddit API endpoints
Two Reddit API endpoints cover all Toolbox data access:| Operation | Method | Endpoint |
|---|---|---|
| Read a wiki page | GET | /r/{subreddit}/wiki/{page}.json |
| Write a wiki page | POST | /r/{subreddit}/api/wiki/edit |
GET request is a JSON envelope; the actual page content lives at data.content_md. For Toolbox data, that string is itself JSON (or compressed JSON for usernotes) and must be parsed separately.
Quick start
Authenticate with Reddit OAuth
Obtain an OAuth access token with the
wikiedit scope for the moderating user. All requests must include an Authorization: bearer {token} header when using oauth.reddit.com.Read the wiki page
Fetch
/r/{subreddit}/wiki/usernotes.json (or toolbox.json) and extract data.content_md from the response body.Parse the content
For usernotes, decompress the
blob field using zlib before parsing. For config, parse the string directly as JSON. See the individual schema pages for details.Validate the schema version
Check the
ver field of the parsed object before processing. Reject data with versions outside the supported range to avoid corrupting writes.