> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Reddit

> How to set up the Reddit connector, plus the actions that are available.

![Reddit](https://stackone-logos.com/api/reddit/filled/svg)

Betav2.0.0[See changelog](https://docs.stackone.com/connectors/reddit/changelog.md)

[57 actions](#actions) · 4 auth methods

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/reddit/guides/connector-profile/oauth-2-0.md)
>
> Requires registering a Web app at reddit.com/prefs/apps. Each end user authorizes their own Reddit account, so actions r...

> [card] [OAuth 2.0 (Password Grant) · Connector Profile](https://docs.stackone.com/connectors/reddit/guides/connector-profile/oauth-2-0-password-grant.md)
>
> For Reddit "script" apps that authenticate as a single user, the app's developer. The token carries full scope, so it re...

> [card] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/reddit/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> Userless access for a confidential Reddit app (a web app or script app with a secret). Reaches public read endpoints onl...

> [card] [OAuth 2.0 (Installed Client) · Connector Profile](https://docs.stackone.com/connectors/reddit/guides/connector-profile/oauth-2-0-installed-client.md)
>
> Userless access for a Reddit installed app, which has a Client ID but no secret. Reaches public read endpoints only, and...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/reddit/guides/link-account/oauth-2-0.md)

> [card] [OAuth 2.0 (Password Grant) · Link Account](https://docs.stackone.com/connectors/reddit/guides/link-account/oauth-2-0-password-grant.md)

> [card] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/reddit/guides/link-account/oauth-2-0-client-credentials.md)

> [card] [OAuth 2.0 (Installed Client) · Link Account](https://docs.stackone.com/connectors/reddit/guides/link-account/oauth-2-0-installed-client.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

OAuth 2.0

OAuth 2.0 (Client Credentials)

OAuth 2.0 (Installed Client)

OAuth 2.0 (Password Grant)

No auth methods found

Scopes

Select all
|
Clear

account

edit

history

identity

modcontributors

modposts

mysubreddits

privatemessages

read

save

submit

subscribe

vote

wikiedit

wikiread

No scopes found

57 actions

ActionDescriptionRequired scopes

Get Me`reddit_get_me`

Get the identity and profile of the authenticated Reddit user.

`identity`

Get My Karma`reddit_get_my_karma`

Return a per-subreddit karma breakdown for the authenticated user.

`mysubreddits`

Get My Preferences`reddit_get_my_prefs`

Return the authenticated user's preferences object.

`identity`

Update My Preferences`reddit_update_my_prefs`

Patch one or more preference fields for the authenticated user.

`account`

Get My Trophies`reddit_get_my_trophies`

Return the list of trophies awarded to the authenticated user.

`identity`

List My Friends`reddit_list_my_friends`

List Redditors the authenticated user has added as friends.

`read`

Submit Comment`reddit_submit_comment`

Reply to a post or comment as the authenticated user.

`submit`

Edit Comment`reddit_edit_comment`

Replace the Markdown body of a comment owned by the authenticated user.

`edit`

Delete Comment`reddit_delete_comment`

Delete a comment owned by the authenticated user.

`edit`

List Subreddit Comments`reddit_list_subreddit_comments`

List the most recent comments posted in a subreddit.

`read`

List Post Comments`reddit_list_post_comments`

Fetch a post together with its threaded comment tree.

`read`

Get More Children`reddit_get_more_children`

Expand a `more` stub from a comment tree.

`read`

List Inbox`reddit_list_inbox`

List all items in the authenticated user's inbox (messages, replies, mentions).

`privatemessages`

List Unread Messages`reddit_list_unread`

List only the unread items in the authenticated user's inbox.

`privatemessages`

List Sent Messages`reddit_list_sent`

List private messages the authenticated user has sent.

`privatemessages`

Get Unread Count`reddit_get_unread_count`

Return the number of unread items in the authenticated user's inbox.

`privatemessages`

Compose Message`reddit_compose_message`

Send a private message to a Redditor or to a subreddit's modmail.

`privatemessages`

Read Message`reddit_read_message`

Mark one or more inbox items as read.

`privatemessages`

Read All Messages`reddit_read_all_messages`

Mark every inbox item for the authenticated user as read.

`privatemessages`

Delete Message`reddit_delete_message`

Delete a private message from the authenticated user's inbox.

`privatemessages`

List Mod Queue`reddit_list_mod_queue`

List reported and spam-filtered items awaiting moderator review in a subreddit.

`read`

Approve Thing`reddit_approve_thing`

Approve a reported or filtered post or comment as a moderator.

`modposts`

Remove Thing`reddit_remove_thing`

Remove a post or comment from a subreddit as a moderator.

`modposts`

Ban User`reddit_ban_user`

Ban a Redditor from a subreddit (permanent or time-limited).

`modcontributors`

Unban User`reddit_unban_user`

Reverse a ban, mute, contributor, moderator, or wiki relationship for a user in a subreddit.

`modcontributors`

List Hot Posts`reddit_list_hot_posts`

List hot posts from the authenticated user's front page.

`read`

List New Posts`reddit_list_new_posts`

List newest posts on the authenticated user's front page.

`read`

List Top Posts`reddit_list_top_posts`

List top-scoring posts on the user's front page within a time window.

`read`

Get Post`reddit_get_post`

Fetch a single post together with its comment tree by base36 id.

`read`

Submit Post`reddit_submit_post`

Submit a new link, self/text, or media post to a subreddit.

`submit`

Edit Post`reddit_edit_post`

Replace the Markdown body of a self/text post (or comment) owned by the authenticated user.

`edit`

Delete Post`reddit_delete_post`

Delete a post (or comment) owned by the authenticated user.

`edit`

Save Thing`reddit_save_thing`

Save a post or comment to the authenticated user's saved listing.

`save`

Unsave Thing`reddit_unsave_thing`

Remove a post or comment from the authenticated user's saved listing.

`save`

Vote On Thing`reddit_vote_thing`

Upvote, downvote, or clear a vote on a post or comment.

`vote`

Search All Of Reddit`reddit_search_all`

Full-text search across all of Reddit's posts, subreddits, and users.

`read`

Search Within Subreddit`reddit_search_subreddit`

Full-text search scoped to one subreddit.

`read`

Search Users`reddit_search_users`

Search for Redditors by username and profile content.

`read`

Check Username Availability`reddit_username_available`

Check whether a username is free for new-account registration on Reddit.

`read`

Get Subreddit About`reddit_get_subreddit_about`

Get metadata and community attributes for one subreddit.

`read`

Get Subreddit Rules`reddit_get_subreddit_rules`

Get the published community rules for a subreddit.

`read`

List Subreddit Hot Posts`reddit_list_subreddit_hot`

List posts ranked by the `hot` algorithm within a specific subreddit.

`read`

List Subreddit New Posts`reddit_list_subreddit_new`

List the newest posts within a specific subreddit (chronological).

`read`

List My Subscribed Subreddits`reddit_list_my_subreddits_subscriber`

List subreddits the authenticated user is subscribed to.

`mysubreddits`

List My Moderated Subreddits`reddit_list_my_subreddits_moderator`

List subreddits the authenticated user is a moderator of.

`mysubreddits`

List Popular Subreddits`reddit_list_subreddits_popular`

List the most popular public subreddits site-wide.

`read`

Search Subreddits`reddit_search_subreddits`

Search subreddits by name, title, and description.

`read`

Subscribe To Subreddit`reddit_subscribe_subreddit`

Subscribe the authenticated user to one or more subreddits.

`subscribe`

Unsubscribe From Subreddit`reddit_unsubscribe_subreddit`

Unsubscribe the authenticated user from one or more subreddits.

`subscribe`

Get User About`reddit_get_user_about`

Get a Redditor's public profile by username.

`read`

Get User Trophies`reddit_get_user_trophies`

Get a Redditor's public trophies (achievements) by username.

`read`

List User Submitted`reddit_list_user_submitted`

List posts submitted by a Redditor.

`history`

List User Comments`reddit_list_user_comments`

List comments authored by a Redditor.

`history`

Block User`reddit_block_user`

Block another Redditor on behalf of the authenticated user.

`account`

List Wiki Pages`reddit_list_wiki_pages`

List every wiki page name in a subreddit.

`wikiread`

Get Wiki Page`reddit_get_wiki_page`

Get the rendered content of a specific subreddit wiki page.

`wikiread`

Edit Wiki Page`reddit_edit_wiki_page`

Create or replace the Markdown content of a subreddit wiki page.

`wikiedit`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.