Skip to content

Instantly share code, notes, and snippets.

@Olshansk

Olshansk/reddit_openapi.json

Created January 8, 2026 18:28
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save Olshansk/efc6ac92e0a1f19f5fcab49581f240e1 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save Olshansk/efc6ac92e0a1f19f5fcab49581f240e1 to your computer and use it in GitHub Desktop.
Download ZIP
Reddit OpenAPI JSON Spec. This was not validated, but simply converted by claude using this HTML as a source: https://www.reddit.com/dev/api
Raw
reddit_openapi.json
{
"openapi": "3.0.3",
"info": {
"title": "Reddit API",
"description": "Reddit API documentation converted from reddit.com/dev/api",
"version": "1.0.0",
"contact": {
"url": "https://www.reddit.com/dev/api/"
}
},
"servers": [
{
"url": "https://oauth.reddit.com",
"description": "OAuth API server"
},
{
"url": "https://www.reddit.com",
"description": "Public API server"
}
],
"paths": {
"/api/v1/me": {
"get": {
"operationId": "GET_api_v1_me",
"summary": "Returns the identity of the user.",
"description": "Returns the identity of the user.",
"tags": [
"account"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"identity"
]
}
]
}
},
"/api/v1/me/karma": {
"get": {
"operationId": "GET_api_v1_me_karma",
"summary": "Return a breakdown of subreddit karma.",
"description": "Return a breakdown of subreddit karma.",
"tags": [
"account"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"mysubreddits"
]
}
]
}
},
"/api/v1/me/prefs": {
"get": {
"operationId": "GET_api_v1_me_prefs",
"summary": "Return the preference settings of the logged in user",
"description": "Return the preference settings of the logged in user",
"tags": [
"account"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "fields",
"in": "query",
"description": "A comma-separated list of items from this set: threaded_messages activity_relevant_ads email_messages profile_opt_out show_link_flair show_trending country_code clickgadget use_global_defaults enable_reddit_pro_analytics_emails live_orangereds email_new_user_welcome third_party_data_personalized_ads email_chat_request hide_from_robots email_upvote_post min_link_score nightmode enable_default_themes third_party_site_data_personalized_ads survey_last_seen_time email_community_discovery collapse_read_messages mark_messages_read hide_ads sms_notifications_enabled numsites email_private_message hide_downs hide_ups theme_selector email_weekly_topic ignore_suggested_sort research label_nsfw no_profanity email_unsubscribe_all whatsapp_enabled store_visits threaded_modmail email_username_mention show_gold_expiration show_location_based_recommendations geopopular send_welcome_messages highlight_new_comments accept_pms show_stylesheets monitor_mentions feed_recommendations_enabled domain_details over_18 in_redesign_beta media_preview enable_followers min_comment_score public_votes email_post_reply whatsapp_comment_reply search_include_over_18 newwindow default_comment_sort email_comment_reply video_autoplay private_feeds email_upvote_comment email_digests weekly_recap_email num_comments highlight_controversial legacy_search bad_comment_autocollapse live_bar_recommendations_enabled allow_clicktracking show_twitter compress beta email_user_new_follower third_party_site_data_personalized_content lang show_flair send_crosspost_messages third_party_personalized_ads top_karma_subreddits show_presence media",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"identity"
]
}
]
},
"patch": {
"operationId": "PATCH_api_v1_me_prefs",
"summary": "PATCH /api/v1/me/prefs",
"tags": [
"account"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"account"
]
}
]
}
},
"/api/v1/me/trophies": {
"get": {
"operationId": "GET_api_v1_me_trophies",
"summary": "Return a list of trophies for the current user.",
"description": "Return a list of trophies for the current user.",
"tags": [
"account"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"identity"
]
}
]
}
},
"/prefs/{where}": {
"get": {
"operationId": "GET_prefs_where",
"summary": "This endpoint is a listing.",
"description": "This endpoint is a listing. (RSS support available)\n\nURI variants: /prefs/friends, /prefs/blocked, /prefs/messaging, /prefs/trusted, /api/v1/me/friends, /api/v1/me/blocked",
"tags": [
"account"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "after",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "before",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "a positive integer (default: 0)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "the maximum number of items desired (default: 25, maximum: 100)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "show",
"in": "query",
"description": "(optional) the string all",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sr_detail",
"in": "query",
"description": "(optional) expand subreddits",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "where",
"in": "path",
"description": "Path parameter: where",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/api/announcements/v1": {
"get": {
"operationId": "GET_api_announcements_v1",
"summary": "Fetch announcements from Reddit.",
"description": "Fetch announcements from Reddit.\n\nURI variants: /api/announcements/v1/unread",
"tags": [
"announcements"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "after",
"in": "query",
"description": "(beta) fullname of an announcement, prefixed ann_",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "before",
"in": "query",
"description": "(beta) fullname of an announcement, prefixed ann_",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "an integer between 1 and 100",
"required": true,
"schema": {
"type": "integer"
}
}
],
"security": [
{
"oauth2": [
"announcements"
]
}
]
}
},
"/api/announcements/v1/hide": {
"post": {
"operationId": "POST_api_announcements_v1_hide",
"summary": "Accepts a list of announcement fullnames (ann_) and marks them hidden if they belong to the authenti",
"description": "Accepts a list of announcement fullnames (ann_) and marks them hidden if they belong to the authenticated user",
"tags": [
"announcements"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"announcements"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"ids": {
"type": "string",
"description": "(beta) comma separated list of announcement fullnames, prefixed ann_"
}
},
"required": [
"ids"
]
}
}
}
}
}
},
"/api/announcements/v1/read": {
"post": {
"operationId": "POST_api_announcements_v1_read",
"summary": "Accepts a list of announcement fullnames (ann_) and marks them read if they belong to the authentica",
"description": "Accepts a list of announcement fullnames (ann_) and marks them read if they belong to the authenticated user",
"tags": [
"announcements"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"announcements"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"ids": {
"type": "string",
"description": "(beta) comma separated list of announcement fullnames, prefixed ann_"
}
},
"required": [
"ids"
]
}
}
}
}
}
},
"/api/announcements/v1/read/all": {
"post": {
"operationId": "POST_api_announcements_v1_read_all",
"summary": "Marks all unread announcements as read for the authenticated user",
"description": "Marks all unread announcements as read for the authenticated user",
"tags": [
"announcements"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"announcements"
]
}
]
}
},
"/api/needs/captcha": {
"get": {
"operationId": "GET_api_needs_captcha",
"summary": "Check whether ReCAPTCHAs are needed for API methods",
"description": "Check whether ReCAPTCHAs are needed for API methods",
"tags": [
"captcha"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"any"
]
}
]
}
},
"/api/v1/{subreddit}/emoji.json": {
"post": {
"operationId": "POST_api_v1_subreddit_emoji.json",
"summary": "Add an emoji to the DB by posting a message on emoji_upload_q. A job processor that listens on a que",
"description": "Add an emoji to the DB by posting a message on emoji_upload_q. A job processor that listens on a queue, uses the s3_key provided in the request to locate the image in S3 Temp Bucket and moves it to the PERM bucket. It also adds it to the DB using name as the column and sr_fullname as the key and sends the status on the websocket URL that is provided as part of this response.",
"tags": [
"emoji"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "subreddit",
"in": "path",
"description": "Path parameter: subreddit",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"structuredstyles"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"mod_flair_only": {
"type": "boolean",
"description": "boolean value"
},
"name": {
"type": "string",
"description": "Name of the emoji to be created. It can be alphanumeric without any special characters except '-' & '_' and cannot exceed 24 characters."
},
"post_flair_allowed": {
"type": "boolean",
"description": "boolean value"
},
"s3_key": {
"type": "string",
"description": "S3 key of the uploaded image which can be obtained from the S3 url. This is of the form subreddit/hash_value."
},
"user_flair_allowed": {
"type": "boolean",
"description": "boolean value"
}
},
"required": [
"mod_flair_only",
"name",
"post_flair_allowed",
"s3_key",
"user_flair_allowed"
]
}
}
}
}
}
},
"/api/v1/{subreddit}/emoji/{emoji/name}": {
"delete": {
"operationId": "DELETE_api_v1_subreddit_emoji_emoji_name",
"summary": "Delete a Subreddit emoji. Remove the emoji from Cassandra and purge the assets from S3 and the image",
"description": "Delete a Subreddit emoji. Remove the emoji from Cassandra and purge the assets from S3 and the image resizing provider.",
"tags": [
"emoji"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "subreddit",
"in": "path",
"description": "Path parameter: subreddit",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"structuredstyles"
]
}
]
}
},
"/api/v1/{subreddit}/emoji/asset/upload/s3.json": {
"post": {
"operationId": "POST_api_v1_subreddit_emoji_asset_upload_s3.json",
"summary": "Acquire and return an upload lease to s3 temp bucket. The return value of this function is a json ob",
"description": "Acquire and return an upload lease to s3 temp bucket. The return value of this function is a json object containing credentials for uploading assets to S3 bucket, S3 url for upload request and the key to use for uploading. Using this lease the client will upload the emoji image to S3 temp bucket (included as part of the S3 URL).",
"tags": [
"emoji"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "subreddit",
"in": "path",
"description": "Path parameter: subreddit",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"structuredstyles"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"filepath": {
"type": "string",
"description": "name and extension of the image file e.g. image1.png"
},
"mimetype": {
"type": "string",
"description": "mime type of the image e.g. image/png"
}
},
"required": [
"filepath",
"mimetype"
]
}
}
}
}
}
},
"/api/v1/{subreddit}/emoji/custom/size": {
"post": {
"operationId": "POST_api_v1_subreddit_emoji_custom_size",
"summary": "Set custom emoji size.",
"description": "Set custom emoji size.",
"tags": [
"emoji"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "subreddit",
"in": "path",
"description": "Path parameter: subreddit",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"structuredstyles"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"height": {
"type": "integer",
"description": "an integer between 1 and 40 (default: 0)"
},
"width": {
"type": "integer",
"description": "an integer between 1 and 40 (default: 0)"
}
},
"required": [
"height",
"width"
]
}
}
}
}
}
},
"/api/v1/{subreddit}/emojis/all": {
"get": {
"operationId": "GET_api_v1_subreddit_emojis_all",
"summary": "Get all emojis for a SR. The response includes snoomojis as well as emojis for the SR specified in t",
"description": "Get all emojis for a SR. The response includes snoomojis as well as emojis for the SR specified in the request.",
"tags": [
"emoji"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "subreddit",
"in": "path",
"description": "Path parameter: subreddit",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/api/clearflairtemplates": {
"post": {
"operationId": "POST_api_clearflairtemplates",
"summary": "POST /api/clearflairtemplates",
"tags": [
"flair"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modflair"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"flair_type": {
"type": "string",
"description": "one of (USER_FLAIR, LINK_FLAIR)"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"flair_type",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/deleteflair": {
"post": {
"operationId": "POST_api_deleteflair",
"summary": "POST /api/deleteflair",
"tags": [
"flair"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modflair"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"name": {
"type": "string",
"description": "a user by name"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"name",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/deleteflairtemplate": {
"post": {
"operationId": "POST_api_deleteflairtemplate",
"summary": "POST /api/deleteflairtemplate",
"tags": [
"flair"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modflair"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"flair_template_id": {
"type": "string",
"description": ""
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"flair_template_id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/flair": {
"post": {
"operationId": "POST_api_flair",
"summary": "POST /api/flair",
"tags": [
"flair"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modflair"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"css_class": {
"type": "string",
"description": "a valid subreddit image name"
},
"link": {
"type": "string",
"description": "a fullname of a link"
},
"name": {
"type": "string",
"description": "a user by name"
},
"text": {
"type": "string",
"description": "a string no longer than 64 characters"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"css_class",
"link",
"name",
"text",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/flair/template/order": {
"patch": {
"operationId": "PATCH_api_flair_template_order",
"summary": "Update the order of flair templates in the specified subreddit.",
"description": "Update the order of flair templates in the specified subreddit.",
"tags": [
"flair"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modflair"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"flair_type": {
"type": "string",
"description": "one of (USER_FLAIR, LINK_FLAIR)"
},
"subreddit": {
"type": "string",
"description": "subreddit name"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"flair_type",
"subreddit",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/flairconfig": {
"post": {
"operationId": "POST_api_flairconfig",
"summary": "POST /api/flairconfig",
"tags": [
"flair"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modflair"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"flair_enabled": {
"type": "boolean",
"description": "boolean value"
},
"flair_position": {
"type": "string",
"description": "one of (left, right)"
},
"flair_self_assign_enabled": {
"type": "boolean",
"description": "boolean value"
},
"link_flair_position": {
"type": "string",
"description": "one of (`,left,right`)"
},
"link_flair_self_assign_enabled": {
"type": "boolean",
"description": "boolean value"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"flair_enabled",
"flair_position",
"flair_self_assign_enabled",
"link_flair_position",
"link_flair_self_assign_enabled",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/flaircsv": {
"post": {
"operationId": "POST_api_flaircsv",
"summary": "Change the flair of multiple users in the same subreddit with a single API call.",
"description": "Change the flair of multiple users in the same subreddit with a single API call.",
"tags": [
"flair"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modflair"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"flair_csv": {
"type": "string",
"description": "comma-seperated flair information"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"flair_csv",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/flairlist": {
"get": {
"operationId": "GET_api_flairlist",
"summary": "This endpoint is a listing.",
"description": "This endpoint is a listing.",
"tags": [
"flair"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "after",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "before",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "a positive integer (default: 0)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "the maximum number of items desired (default: 25, maximum: 1000)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "name",
"in": "query",
"description": "a user by name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "show",
"in": "query",
"description": "(optional) the string all",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sr_detail",
"in": "query",
"description": "(optional) expand subreddits",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"modflair"
]
}
]
}
},
"/api/flairselector": {
"post": {
"operationId": "POST_api_flairselector",
"summary": "Return information about a users's flair options.",
"description": "Return information about a users's flair options.",
"tags": [
"flair"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"flair"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"is_newlink": {
"type": "boolean",
"description": "boolean value"
},
"link": {
"type": "string",
"description": "a fullname of a link"
},
"name": {
"type": "string",
"description": "a user by name"
}
},
"required": [
"is_newlink",
"link",
"name"
]
}
}
}
}
}
},
"/api/flairtemplate": {
"post": {
"operationId": "POST_api_flairtemplate",
"summary": "POST /api/flairtemplate",
"tags": [
"flair"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modflair"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"css_class": {
"type": "string",
"description": "a valid subreddit image name"
},
"flair_template_id": {
"type": "string",
"description": ""
},
"flair_type": {
"type": "string",
"description": "one of (USER_FLAIR, LINK_FLAIR)"
},
"text": {
"type": "string",
"description": "a string no longer than 64 characters"
},
"text_editable": {
"type": "boolean",
"description": "boolean value"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"css_class",
"flair_template_id",
"flair_type",
"text",
"text_editable",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/flairtemplate/v2": {
"post": {
"operationId": "POST_api_flairtemplate_v2",
"summary": "Create or update a flair template.",
"description": "Create or update a flair template.",
"tags": [
"flair"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modflair"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"allowable_content": {
"type": "string",
"description": "one of (all, emoji, text)"
},
"api_type": {
"type": "string",
"description": "the string json"
},
"background_color": {
"type": "string",
"description": "a 6-digit rgb hex color, e.g. #AABBCC"
},
"css_class": {
"type": "string",
"description": "a valid subreddit image name"
},
"flair_template_id": {
"type": "string",
"description": ""
},
"flair_type": {
"type": "string",
"description": "one of (USER_FLAIR, LINK_FLAIR)"
},
"max_emojis": {
"type": "integer",
"description": "an integer between 1 and 10 (default: 10)"
},
"mod_only": {
"type": "boolean",
"description": "boolean value"
},
"override_css": {
"type": "string",
"description": ""
},
"text": {
"type": "string",
"description": "a string no longer than 64 characters"
},
"text_color": {
"type": "string",
"description": "one of (light, dark)"
},
"text_editable": {
"type": "boolean",
"description": "boolean value"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"allowable_content",
"api_type",
"background_color",
"css_class",
"flair_template_id",
"flair_type",
"max_emojis",
"mod_only",
"override_css",
"text",
"text_color",
"text_editable",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/link/flair": {
"get": {
"operationId": "GET_api_link_flair",
"summary": "Return list of available link flair for the current subreddit.",
"description": "Return list of available link flair for the current subreddit.",
"tags": [
"flair"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"flair"
]
}
]
}
},
"/api/link/flair/v2": {
"get": {
"operationId": "GET_api_link_flair_v2",
"summary": "Return list of available link flair for the current subreddit.",
"description": "Return list of available link flair for the current subreddit.",
"tags": [
"flair"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"flair"
]
}
]
}
},
"/api/selectflair": {
"post": {
"operationId": "POST_api_selectflair",
"summary": "POST /api/selectflair",
"tags": [
"flair"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"flair"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"background_color": {
"type": "string",
"description": "a 6-digit rgb hex color, e.g. #AABBCC"
},
"css_class": {
"type": "string",
"description": "a valid subreddit image name"
},
"flair_template_id": {
"type": "string",
"description": ""
},
"link": {
"type": "string",
"description": "a fullname of a link"
},
"name": {
"type": "string",
"description": "a user by name"
},
"return_rtson": {
"type": "string",
"description": "[all|only|none]: "all" saves attributes and returns rtjson "only" only returns rtjson"none" only saves attributes"
},
"text": {
"type": "string",
"description": "a string no longer than 64 characters"
},
"text_color": {
"type": "string",
"description": "one of (light, dark)"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"background_color",
"css_class",
"flair_template_id",
"link",
"name",
"return_rtson",
"text",
"text_color",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/setflairenabled": {
"post": {
"operationId": "POST_api_setflairenabled",
"summary": "POST /api/setflairenabled",
"tags": [
"flair"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"flair"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"flair_enabled": {
"type": "boolean",
"description": "boolean value"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"flair_enabled",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/user/flair": {
"get": {
"operationId": "GET_api_user_flair",
"summary": "Return list of available user flair for the current subreddit.",
"description": "Return list of available user flair for the current subreddit.",
"tags": [
"flair"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"flair"
]
}
]
}
},
"/api/user/flair/v2": {
"get": {
"operationId": "GET_api_user_flair_v2",
"summary": "Return list of available user flair for the current subreddit.",
"description": "Return list of available user flair for the current subreddit.",
"tags": [
"flair"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"flair"
]
}
]
}
},
"/api/comment": {
"post": {
"operationId": "POST_api_comment",
"summary": "Submit a new comment or reply to a message.",
"description": "Submit a new comment or reply to a message.",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"any"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"recaptcha_token": {
"type": "string",
"description": "a string"
},
"return_rtjson": {
"type": "boolean",
"description": "boolean value"
},
"richtext_json": {
"type": "string",
"description": "JSON data"
},
"text": {
"type": "string",
"description": "raw markdown text"
},
"thing_id": {
"type": "string",
"description": "fullname of parent thing"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
},
"video_poster_url": {
"type": "string",
"description": "a string"
}
},
"required": [
"api_type",
"recaptcha_token",
"return_rtjson",
"richtext_json",
"text",
"thing_id",
"uh / X-Modhash header",
"video_poster_url"
]
}
}
}
}
}
},
"/api/del": {
"post": {
"operationId": "POST_api_del",
"summary": "Delete a Link or Comment.",
"description": "Delete a Link or Comment.",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"edit"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "fullname of a thing created by the user"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/editusertext": {
"post": {
"operationId": "POST_api_editusertext",
"summary": "Edit the body text of a comment or self-post.",
"description": "Edit the body text of a comment or self-post.",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"edit"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"return_rtjson": {
"type": "boolean",
"description": "boolean value"
},
"richtext_json": {
"type": "string",
"description": "JSON data"
},
"text": {
"type": "string",
"description": "raw markdown text"
},
"thing_id": {
"type": "string",
"description": "fullname of a thing"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
},
"video_poster_url": {
"type": "string",
"description": "a string"
}
},
"required": [
"api_type",
"return_rtjson",
"richtext_json",
"text",
"thing_id",
"uh / X-Modhash header",
"video_poster_url"
]
}
}
}
}
}
},
"/api/follow/post": {
"post": {
"operationId": "POST_api_follow_post",
"summary": "Follow or unfollow a post.",
"description": "Follow or unfollow a post.",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"subscribe"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"follow": {
"type": "boolean",
"description": "boolean: True to follow or False to unfollow"
},
"fullname": {
"type": "string",
"description": "fullname of a link"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"follow",
"fullname",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/hide": {
"post": {
"operationId": "POST_api_hide",
"summary": "Hide a link.",
"description": "Hide a link.",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"report"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A comma-separated list of link fullnames"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/info": {
"get": {
"operationId": "GET_api_info",
"summary": "Return a listing of things specified by their fullnames.",
"description": "Return a listing of things specified by their fullnames.",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "query",
"description": "A comma-separated list of thing fullnames",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sr_name",
"in": "query",
"description": "comma-delimited list of subreddit names",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "url",
"in": "query",
"description": "a valid URL",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/api/lock": {
"post": {
"operationId": "POST_api_lock",
"summary": "Lock a link or comment.",
"description": "Lock a link or comment.",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modposts"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "fullname of a thing"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/marknsfw": {
"post": {
"operationId": "POST_api_marknsfw",
"summary": "Mark a link NSFW.",
"description": "Mark a link NSFW.",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modposts"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "fullname of a thing"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/morechildren": {
"get": {
"operationId": "GET_api_morechildren",
"summary": "Retrieve additional comments omitted from a base comment tree.",
"description": "Retrieve additional comments omitted from a base comment tree.",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "api_type",
"in": "query",
"description": "the string json",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "children",
"in": "query",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "depth",
"in": "query",
"description": "(optional) an integer",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "id",
"in": "query",
"description": "(optional) id of the associated MoreChildren object",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "limit_children",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "link_id",
"in": "query",
"description": "fullname of a link",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "one of (confidence, top, new, controversial, old, random, qa, live)",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/api/report": {
"post": {
"operationId": "POST_api_report",
"summary": "Report a link, comment or message. Reporting a thing brings it to the attention of the subreddit&#39",
"description": "Report a link, comment or message. Reporting a thing brings it to the attention of the subreddit's moderators. Reporting a message sends it to a system for admin review. For links and comments, the thing is implicitly hidden as well (see /api/hide for details).",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"report"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"additional_info": {
"type": "string",
"description": "a string no longer than 2000 characters"
},
"api_type": {
"type": "string",
"description": "the string json"
},
"custom_text": {
"type": "string",
"description": "a string no longer than 2000 characters"
},
"from_help_desk": {
"type": "boolean",
"description": "boolean value"
},
"from_modmail": {
"type": "boolean",
"description": "boolean value"
},
"modmail_conv_id": {
"type": "string",
"description": "base36 modmail conversation id"
},
"other_reason": {
"type": "string",
"description": "a string no longer than 100 characters"
},
"reason": {
"type": "string",
"description": "a string no longer than 100 characters"
},
"rule_reason": {
"type": "string",
"description": "a string no longer than 100 characters"
},
"site_reason": {
"type": "string",
"description": "a string no longer than 100 characters"
},
"sr_name": {
"type": "string",
"description": "a string no longer than 1000 characters"
},
"thing_id": {
"type": "string",
"description": "fullname of a thing"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
},
"usernames": {
"type": "string",
"description": "A comma-separated list of items"
}
},
"required": [
"additional_info",
"api_type",
"custom_text",
"from_help_desk",
"from_modmail",
"modmail_conv_id",
"other_reason",
"reason",
"rule_reason",
"site_reason",
"sr_name",
"thing_id",
"uh / X-Modhash header",
"usernames"
]
}
}
}
}
}
},
"/api/save": {
"post": {
"operationId": "POST_api_save",
"summary": "Save a link or comment.",
"description": "Save a link or comment.",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"save"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "a category name"
},
"id": {
"type": "string",
"description": "fullname of a thing"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"category",
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/saved/categories": {
"get": {
"operationId": "GET_api_saved_categories",
"summary": "Get a list of categories in which things are currently saved.",
"description": "Get a list of categories in which things are currently saved.",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"save"
]
}
]
}
},
"/api/sendreplies": {
"post": {
"operationId": "POST_api_sendreplies",
"summary": "Enable or disable inbox replies for a link or comment.",
"description": "Enable or disable inbox replies for a link or comment.",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"edit"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "fullname of a thing created by the user"
},
"state": {
"type": "boolean",
"description": "boolean value"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"state",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/set/contest/mode": {
"post": {
"operationId": "POST_api_set_contest_mode",
"summary": "Set or unset "contest mode" for a link's comments.",
"description": "Set or unset "contest mode" for a link's comments.",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modposts"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"id": {
"type": "string",
"description": ""
},
"state": {
"type": "boolean",
"description": "boolean value"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"id",
"state",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/set/subreddit/sticky": {
"post": {
"operationId": "POST_api_set_subreddit_sticky",
"summary": "Set or unset a Link as the sticky in its subreddit.",
"description": "Set or unset a Link as the sticky in its subreddit.",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modposts"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"id": {
"type": "string",
"description": ""
},
"num": {
"type": "integer",
"description": "an integer between 1 and 4"
},
"state": {
"type": "boolean",
"description": "boolean value"
},
"to_profile": {
"type": "boolean",
"description": "boolean value"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"id",
"num",
"state",
"to_profile",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/set/suggested/sort": {
"post": {
"operationId": "POST_api_set_suggested_sort",
"summary": "Set a suggested sort for a link.",
"description": "Set a suggested sort for a link.",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modposts"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"id": {
"type": "string",
"description": ""
},
"sort": {
"type": "string",
"description": "one of (confidence, top, new, controversial, old, random, qa, live, blank)"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"id",
"sort",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/spoiler": {
"post": {
"operationId": "POST_api_spoiler",
"summary": "POST /api/spoiler",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modposts"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "fullname of a link"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/store/visits": {
"post": {
"operationId": "POST_api_store_visits",
"summary": "Requires a subscription to reddit premium",
"description": "Requires a subscription to reddit premium",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"save"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"links": {
"type": "string",
"description": "A comma-separated list of link fullnames"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"links",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/submit": {
"post": {
"operationId": "POST_api_submit",
"summary": "Submit a link to a subreddit.",
"description": "Submit a link to a subreddit.",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"submit"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"ad": {
"type": "boolean",
"description": "boolean value"
},
"api_type": {
"type": "string",
"description": "the string json"
},
"app": {
"type": "string",
"description": ""
},
"collection_id": {
"type": "string",
"description": "(beta) the UUID of a collection"
},
"extension": {
"type": "string",
"description": "extension used for redirects"
},
"flair_id": {
"type": "string",
"description": "a string no longer than 36 characters"
},
"flair_text": {
"type": "string",
"description": "a string no longer than 64 characters"
},
"g-recaptcha-response": {
"type": "string",
"description": ""
},
"kind": {
"type": "string",
"description": "one of (link, self, image, video, videogif)"
},
"nsfw": {
"type": "boolean",
"description": "boolean value"
},
"post_set_default_post_id": {
"type": "string",
"description": "a string"
},
"post_set_id": {
"type": "string",
"description": "a string"
},
"recaptcha_token": {
"type": "string",
"description": "a string"
},
"resubmit": {
"type": "boolean",
"description": "boolean value"
},
"richtext_json": {
"type": "string",
"description": "JSON data"
},
"sendreplies": {
"type": "boolean",
"description": "boolean value"
},
"spoiler": {
"type": "boolean",
"description": "boolean value"
},
"sr": {
"type": "string",
"description": "subreddit name"
},
"text": {
"type": "string",
"description": "raw markdown text"
},
"title": {
"type": "string",
"description": "title of the submission. up to 300 characters long"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
},
"url": {
"type": "string",
"description": "a valid URL"
},
"video_poster_url": {
"type": "string",
"description": "a valid URL"
}
},
"required": [
"ad",
"api_type",
"app",
"collection_id",
"extension",
"flair_id",
"flair_text",
"g-recaptcha-response",
"kind",
"nsfw",
"post_set_default_post_id",
"post_set_id",
"recaptcha_token",
"resubmit",
"richtext_json",
"sendreplies",
"spoiler",
"sr",
"text",
"title",
"uh / X-Modhash header",
"url",
"video_poster_url"
]
}
}
}
}
}
},
"/api/unhide": {
"post": {
"operationId": "POST_api_unhide",
"summary": "Unhide a link.",
"description": "Unhide a link.",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"report"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A comma-separated list of link fullnames"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/unlock": {
"post": {
"operationId": "POST_api_unlock",
"summary": "Unlock a link or comment.",
"description": "Unlock a link or comment.",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modposts"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "fullname of a thing"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/unmarknsfw": {
"post": {
"operationId": "POST_api_unmarknsfw",
"summary": "Remove the NSFW marking from a link.",
"description": "Remove the NSFW marking from a link.",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modposts"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "fullname of a thing"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/unsave": {
"post": {
"operationId": "POST_api_unsave",
"summary": "Unsave a link or comment.",
"description": "Unsave a link or comment.",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"save"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "fullname of a thing"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/unspoiler": {
"post": {
"operationId": "POST_api_unspoiler",
"summary": "POST /api/unspoiler",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modposts"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "fullname of a link"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/vote": {
"post": {
"operationId": "POST_api_vote",
"summary": "Cast a vote on a thing.",
"description": "Cast a vote on a thing.",
"tags": [
"links and comments"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"vote"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"dir": {
"type": "string",
"description": "vote direction. one of (1, 0, -1)"
},
"id": {
"type": "string",
"description": "fullname of a thing"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"dir",
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/best": {
"get": {
"operationId": "GET_best",
"summary": "This endpoint is a listing.",
"description": "This endpoint is a listing. (RSS support available)",
"tags": [
"listings"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/by/id/{names}": {
"get": {
"operationId": "GET_by_id_names",
"summary": "Get a listing of links by fullname.",
"description": "Get a listing of links by fullname.",
"tags": [
"listings"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "names",
"in": "path",
"description": "A comma-separated list of link fullnames",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/comments/{article}": {
"get": {
"operationId": "GET_comments_article",
"summary": "Get the comment tree for a given Link article.",
"description": "Get the comment tree for a given Link article. (RSS support available)",
"tags": [
"listings"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "article",
"in": "path",
"description": "ID36 of a link",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "comment",
"in": "query",
"description": "(optional) ID36 of a comment",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "context",
"in": "query",
"description": "an integer between 0 and 8",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "depth",
"in": "query",
"description": "(optional) an integer",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "(optional) an integer",
"required": false,
"schema": {
"type": "integer"
}
},
{
"name": "showedits",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "showmedia",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "showmore",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "showtitle",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "sort",
"in": "query",
"description": "one of (confidence, top, new, controversial, old, random, qa, live)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sr_detail",
"in": "query",
"description": "(optional) expand subreddits",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "theme",
"in": "query",
"description": "one of (default, dark)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "threaded",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "truncate",
"in": "query",
"description": "an integer between 0 and 50",
"required": true,
"schema": {
"type": "integer"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/duplicates/{article}": {
"get": {
"operationId": "GET_duplicates_article",
"summary": "Return a list of other submissions of the same URL",
"description": "Return a list of other submissions of the same URL (RSS support available)",
"tags": [
"listings"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "after",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "article",
"in": "path",
"description": "The base 36 ID of a Link",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "before",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "a positive integer (default: 0)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "crossposts_only",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "limit",
"in": "query",
"description": "the maximum number of items desired (default: 25, maximum: 100)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "show",
"in": "query",
"description": "(optional) the string all",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "one of (num_comments, new)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sr",
"in": "query",
"description": "subreddit name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sr_detail",
"in": "query",
"description": "(optional) expand subreddits",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/hot": {
"get": {
"operationId": "GET_hot",
"summary": "This endpoint is a listing.",
"description": "This endpoint is a listing. (RSS support available)",
"tags": [
"listings"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "g",
"in": "query",
"description": "one of (GLOBAL, US, AR, AU, BG, CA, CL, CO, HR, CZ, FI, FR, DE, GR, HU, IS, IN, IE, IT, JP, MY, MX, NZ, PH, PL, PT, PR, RO, RS, SG, ES, SE, TW, TH, TR, GB, US_WA, US_DE, US_DC, US_WI, US_WV, US_HI, US_FL, US_WY, US_NH, US_NJ, US_NM, US_TX, US_LA, US_NC, US_ND, US_NE, US_TN, US_NY, US_PA, US_CA, US_NV, US_VA, US_CO, US_AK, US_AL, US_AR, US_VT, US_IL, US_GA, US_IN, US_IA, US_OK, US_AZ, US_ID, US_CT, US_ME, US_MD, US_MA, US_OH, US_UT, US_MO, US_MN, US_MI, US_RI, US_KS, US_MT, US_MS, US_SC, US_KY, US_OR, US_SD)",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/new": {
"get": {
"operationId": "GET_new",
"summary": "This endpoint is a listing.",
"description": "This endpoint is a listing. (RSS support available)",
"tags": [
"listings"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/rising": {
"get": {
"operationId": "GET_rising",
"summary": "This endpoint is a listing.",
"description": "This endpoint is a listing. (RSS support available)",
"tags": [
"listings"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/{sort}": {
"get": {
"operationId": "GET_sort",
"summary": "This endpoint is a listing.",
"description": "This endpoint is a listing. (RSS support available)",
"tags": [
"listings"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "t",
"in": "query",
"description": "one of (hour, day, week, month, year, all)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "path",
"description": "Path parameter: sort",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/api/live/by/id/{names}": {
"get": {
"operationId": "GET_api_live_by_id_names",
"summary": "Get a listing of live events by id.",
"description": "Get a listing of live events by id.",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "names",
"in": "path",
"description": "a comma-delimited list of live thread fullnames or IDs",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/api/live/create": {
"post": {
"operationId": "POST_api_live_create",
"summary": "Create a new live thread.",
"description": "Create a new live thread.",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"submit"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"description": {
"type": "string",
"description": "raw markdown text"
},
"nsfw": {
"type": "boolean",
"description": "boolean value"
},
"resources": {
"type": "string",
"description": "raw markdown text"
},
"title": {
"type": "string",
"description": "a string no longer than 120 characters"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"description",
"nsfw",
"resources",
"title",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/live/happening/now": {
"get": {
"operationId": "GET_api_live_happening_now",
"summary": "Get some basic information about the currently featured live thread.",
"description": "Get some basic information about the currently featured live thread.",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "show_announcements",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/api/live/{thread}/accept/contributor/invite": {
"post": {
"operationId": "POST_api_live_thread_accept_contributor_invite",
"summary": "Accept a pending invitation to contribute to the thread.",
"description": "Accept a pending invitation to contribute to the thread.",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "thread",
"in": "path",
"description": "Path parameter: thread",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"livemanage"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/live/{thread}/close/thread": {
"post": {
"operationId": "POST_api_live_thread_close_thread",
"summary": "Permanently close the thread, disallowing future updates.",
"description": "Permanently close the thread, disallowing future updates.",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "thread",
"in": "path",
"description": "Path parameter: thread",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"livemanage"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/live/{thread}/delete/update": {
"post": {
"operationId": "POST_api_live_thread_delete_update",
"summary": "Delete an update from the thread.",
"description": "Delete an update from the thread.",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "thread",
"in": "path",
"description": "Path parameter: thread",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"edit"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"id": {
"type": "string",
"description": "the ID of a single update. e.g. LiveUpdate_ff87068e-a126-11e3-9f93-12313b0b3603"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/live/{thread}/edit": {
"post": {
"operationId": "POST_api_live_thread_edit",
"summary": "Configure the thread.",
"description": "Configure the thread.",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "thread",
"in": "path",
"description": "Path parameter: thread",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"livemanage"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"description": {
"type": "string",
"description": "raw markdown text"
},
"nsfw": {
"type": "boolean",
"description": "boolean value"
},
"resources": {
"type": "string",
"description": "raw markdown text"
},
"title": {
"type": "string",
"description": "a string no longer than 120 characters"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"description",
"nsfw",
"resources",
"title",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/live/{thread}/hide/discussion": {
"post": {
"operationId": "POST_api_live_thread_hide_discussion",
"summary": "Hide a linked comment thread from the discussions sidebar and listing.",
"description": "Hide a linked comment thread from the discussions sidebar and listing.",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "thread",
"in": "path",
"description": "Path parameter: thread",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"livemanage"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"link": {
"type": "string",
"description": "The base 36 ID of a Link"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"link",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/live/{thread}/invite/contributor": {
"post": {
"operationId": "POST_api_live_thread_invite_contributor",
"summary": "Invite another user to contribute to the thread.",
"description": "Invite another user to contribute to the thread.",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "thread",
"in": "path",
"description": "Path parameter: thread",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"livemanage"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"name": {
"type": "string",
"description": "the name of an existing user"
},
"permissions": {
"type": "string",
"description": "permission description e.g. +update,+edit,-manage"
},
"type": {
"type": "string",
"description": "one of (liveupdate_contributor_invite, liveupdate_contributor)"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"name",
"permissions",
"type",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/live/{thread}/leave/contributor": {
"post": {
"operationId": "POST_api_live_thread_leave_contributor",
"summary": "Abdicate contributorship of the thread.",
"description": "Abdicate contributorship of the thread.",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "thread",
"in": "path",
"description": "Path parameter: thread",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"livemanage"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/live/{thread}/report": {
"post": {
"operationId": "POST_api_live_thread_report",
"summary": "Report the thread for violating the rules of reddit.",
"description": "Report the thread for violating the rules of reddit.",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "thread",
"in": "path",
"description": "Path parameter: thread",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"report"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"type": {
"type": "string",
"description": "one of (spam, vote-manipulation, personal-information, sexualizing-minors, site-breaking)"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"type",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/live/{thread}/rm/contributor": {
"post": {
"operationId": "POST_api_live_thread_rm_contributor",
"summary": "Revoke another user's contributorship.",
"description": "Revoke another user's contributorship.",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "thread",
"in": "path",
"description": "Path parameter: thread",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"livemanage"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"id": {
"type": "string",
"description": "fullname of a account"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/live/{thread}/rm/contributor/invite": {
"post": {
"operationId": "POST_api_live_thread_rm_contributor_invite",
"summary": "Revoke an outstanding contributor invite.",
"description": "Revoke an outstanding contributor invite.",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "thread",
"in": "path",
"description": "Path parameter: thread",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"livemanage"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"id": {
"type": "string",
"description": "fullname of a account"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/live/{thread}/set/contributor/permissions": {
"post": {
"operationId": "POST_api_live_thread_set_contributor_permissions",
"summary": "Change a contributor or contributor invite's permissions.",
"description": "Change a contributor or contributor invite's permissions.",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "thread",
"in": "path",
"description": "Path parameter: thread",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"livemanage"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"name": {
"type": "string",
"description": "the name of an existing user"
},
"permissions": {
"type": "string",
"description": "permission description e.g. +update,+edit,-manage"
},
"type": {
"type": "string",
"description": "one of (liveupdate_contributor_invite, liveupdate_contributor)"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"name",
"permissions",
"type",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/live/{thread}/strike/update": {
"post": {
"operationId": "POST_api_live_thread_strike_update",
"summary": "Strike (mark incorrect and cross out) the content of an update.",
"description": "Strike (mark incorrect and cross out) the content of an update.",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "thread",
"in": "path",
"description": "Path parameter: thread",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"edit"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"id": {
"type": "string",
"description": "the ID of a single update. e.g. LiveUpdate_ff87068e-a126-11e3-9f93-12313b0b3603"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/live/{thread}/unhide/discussion": {
"post": {
"operationId": "POST_api_live_thread_unhide_discussion",
"summary": "Unhide a linked comment thread from the discussions sidebar and listing..",
"description": "Unhide a linked comment thread from the discussions sidebar and listing..",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "thread",
"in": "path",
"description": "Path parameter: thread",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"livemanage"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"link": {
"type": "string",
"description": "The base 36 ID of a Link"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"link",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/live/{thread}/update": {
"post": {
"operationId": "POST_api_live_thread_update",
"summary": "Post an update to the thread.",
"description": "Post an update to the thread.",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "thread",
"in": "path",
"description": "Path parameter: thread",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"submit"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"body": {
"type": "string",
"description": "raw markdown text"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"body",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/live/{thread}": {
"get": {
"operationId": "GET_live_thread",
"summary": "Get a list of updates posted in this thread.",
"description": "Get a list of updates posted in this thread. (RSS support available)",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "after",
"in": "query",
"description": "the ID of a single update. e.g. LiveUpdate_ff87068e-a126-11e3-9f93-12313b0b3603",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "before",
"in": "query",
"description": "the ID of a single update. e.g. LiveUpdate_ff87068e-a126-11e3-9f93-12313b0b3603",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "a positive integer (default: 0)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "is_embed",
"in": "query",
"description": "(internal use only)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "the maximum number of items desired (default: 25, maximum: 100)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "stylesr",
"in": "query",
"description": "subreddit name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "thread",
"in": "path",
"description": "Path parameter: thread",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/live/{thread}/about": {
"get": {
"operationId": "GET_live_thread_about",
"summary": "Get some basic information about the live thread.",
"description": "Get some basic information about the live thread.",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "thread",
"in": "path",
"description": "Path parameter: thread",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/live/{thread}/contributors": {
"get": {
"operationId": "GET_live_thread_contributors",
"summary": "Get a list of users that contribute to this thread.",
"description": "Get a list of users that contribute to this thread.",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "thread",
"in": "path",
"description": "Path parameter: thread",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/live/{thread}/discussions": {
"get": {
"operationId": "GET_live_thread_discussions",
"summary": "Get a list of reddit submissions linking to this thread.",
"description": "Get a list of reddit submissions linking to this thread. (RSS support available)",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "after",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "before",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "a positive integer (default: 0)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "the maximum number of items desired (default: 25, maximum: 100)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "show",
"in": "query",
"description": "(optional) the string all",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sr_detail",
"in": "query",
"description": "(optional) expand subreddits",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "thread",
"in": "path",
"description": "Path parameter: thread",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/live/{thread}/updates/{update/id}": {
"get": {
"operationId": "GET_live_thread_updates_update_id",
"summary": "Get details about a specific update in a live thread.",
"description": "Get details about a specific update in a live thread.",
"tags": [
"live"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "thread",
"in": "path",
"description": "Path parameter: thread",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/api/compose": {
"post": {
"operationId": "POST_api_compose",
"summary": "Handles message composition under /message/compose.",
"description": "Handles message composition under /message/compose.",
"tags": [
"messages"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"privatemessages"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"from_sr": {
"type": "string",
"description": "subreddit name"
},
"g-recaptcha-response": {
"type": "string",
"description": ""
},
"subject": {
"type": "string",
"description": "a string no longer than 100 characters"
},
"text": {
"type": "string",
"description": "raw markdown text"
},
"to": {
"type": "string",
"description": "the name of an existing user"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"from_sr",
"g-recaptcha-response",
"subject",
"text",
"to",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/del/msg": {
"post": {
"operationId": "POST_api_del_msg",
"summary": "Delete messages from the recipient's view of their inbox.",
"description": "Delete messages from the recipient's view of their inbox.",
"tags": [
"messages"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"privatemessages"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "fullname of a thing"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/read/all/messages": {
"post": {
"operationId": "POST_api_read_all_messages",
"summary": "Queue up marking all messages for a user as read.",
"description": "Queue up marking all messages for a user as read.",
"tags": [
"messages"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"privatemessages"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"filter_types": {
"type": "string",
"description": "A comma-separated list of items"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"filter_types",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/read/message": {
"post": {
"operationId": "POST_api_read_message",
"summary": "POST /api/read/message",
"tags": [
"messages"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"privatemessages"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A comma-separated list of thing fullnames"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/message/{where}": {
"get": {
"operationId": "GET_message_where",
"summary": "This endpoint is a listing.",
"description": "This endpoint is a listing. (RSS support available)\n\nURI variants: /message/inbox, /message/unread, /message/sent",
"tags": [
"messages"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "mark",
"in": "query",
"description": "one of (true, false)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "max_replies",
"in": "query",
"description": "the maximum number of items desired (default: 0, maximum: 300)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "mid",
"in": "query",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "where",
"in": "path",
"description": "Path parameter: where",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"privatemessages"
]
}
]
}
},
"/api/v1/scopes": {
"get": {
"operationId": "GET_api_v1_scopes",
"summary": "Retrieve descriptions of reddit's OAuth2 scopes.",
"description": "Retrieve descriptions of reddit's OAuth2 scopes.",
"tags": [
"misc"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "scopes",
"in": "query",
"description": "(optional) An OAuth2 scope string",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"any"
]
}
]
}
},
"/about/log": {
"get": {
"operationId": "GET_about_log",
"summary": "Get a list of recent moderation actions.",
"description": "Get a list of recent moderation actions. (RSS support available)",
"tags": [
"moderation"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "after",
"in": "query",
"description": "a ModAction ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "before",
"in": "query",
"description": "a ModAction ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "a positive integer (default: 0)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "the maximum number of items desired (default: 25, maximum: 500)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "mod",
"in": "query",
"description": "(optional) a moderator filter",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "show",
"in": "query",
"description": "(optional) the string all",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sr_detail",
"in": "query",
"description": "(optional) expand subreddits",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "one of (banuser, unbanuser, spamlink, removelink, approvelink, spamcomment, removecomment, approvecomment, addmoderator, showcomment, invitemoderator, uninvitemoderator, acceptmoderatorinvite, removemoderator, addcontributor, removecontributor, editsettings, editflair, distinguish, marknsfw, wikibanned, wikicontributor, wikiunbanned, wikipagelisted, removewikicontributor, wikirevise, wikipermlevel, ignorereports, unignorereports, setpermissions, setsuggestedsort, sticky, unsticky, setcontestmode, unsetcontestmode, lock, unlock, muteuser, unmuteuser, createrule, editrule, reorderrules, deleterule, spoiler, unspoiler, modmail_enrollment, community_status, community_styling, community_welcome_page, community_widgets, markoriginalcontent, collections, events, hidden_award, add_community_topics, remove_community_topics, create_scheduled_post, edit_scheduled_post, delete_scheduled_post, submit_scheduled_post, edit_comment_requirements, edit_post_requirements, invitesubscriber, submit_content_rating_survey, adjust_post_crowd_control_level, enable_post_crowd_control_filter, disable_post_crowd_control_filter, deleteoverriddenclassification, overrideclassification, reordermoderators, request_assistance, snoozereports, unsnoozereports, addnote, deletenote, addremovalreason, createremovalreason, updateremovalreason, deleteremovalreason, reorderremovalreason, dev_platform_app_changed, dev_platform_app_disabled, dev_platform_app_enabled, dev_platform_app_installed, dev_platform_app_uninstalled, edit_saved_response, chat_approve_message, chat_remove_message, chat_ban_user, chat_unban_user, chat_invite_host, chat_remove_host, approve_award)",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"modlog"
]
}
]
}
},
"/about/{location}": {
"get": {
"operationId": "GET_about_location",
"summary": "Return a listing of posts relevant to moderators.",
"description": "Return a listing of posts relevant to moderators.",
"tags": [
"moderation"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "after",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "before",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "a positive integer (default: 0)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "the maximum number of items desired (default: 25, maximum: 100)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "location",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "only",
"in": "query",
"description": "one of (links, comments, chat_comments)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "show",
"in": "query",
"description": "(optional) the string all",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sr_detail",
"in": "query",
"description": "(optional) expand subreddits",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/api/accept/moderator/invite": {
"post": {
"operationId": "POST_api_accept_moderator_invite",
"summary": "Accept an invite to moderate the specified subreddit.",
"description": "Accept an invite to moderate the specified subreddit.",
"tags": [
"moderation"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modself"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/approve": {
"post": {
"operationId": "POST_api_approve",
"summary": "Approve a link or comment.",
"description": "Approve a link or comment.",
"tags": [
"moderation"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modposts"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "fullname of a thing"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/distinguish": {
"post": {
"operationId": "POST_api_distinguish",
"summary": "Distinguish a thing's author with a sigil.",
"description": "Distinguish a thing's author with a sigil.",
"tags": [
"moderation"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modposts"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"how": {
"type": "string",
"description": "one of (yes, no, admin, special)"
},
"id": {
"type": "string",
"description": "fullname of a thing"
},
"sticky": {
"type": "boolean",
"description": "boolean value"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"how",
"id",
"sticky",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/ignore/reports": {
"post": {
"operationId": "POST_api_ignore_reports",
"summary": "Prevent future reports on a thing from causing notifications.",
"description": "Prevent future reports on a thing from causing notifications.",
"tags": [
"moderation"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modposts"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "fullname of a thing"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/leavecontributor": {
"post": {
"operationId": "POST_api_leavecontributor",
"summary": "Abdicate approved user status in a subreddit.",
"description": "Abdicate approved user status in a subreddit.",
"tags": [
"moderation"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modself"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "fullname of a thing"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/leavemoderator": {
"post": {
"operationId": "POST_api_leavemoderator",
"summary": "Abdicate moderator status in a subreddit.",
"description": "Abdicate moderator status in a subreddit.",
"tags": [
"moderation"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modself"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "fullname of a thing"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/remove": {
"post": {
"operationId": "POST_api_remove",
"summary": "Remove a link, comment, or modmail message.",
"description": "Remove a link, comment, or modmail message.",
"tags": [
"moderation"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modposts"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "fullname of a thing"
},
"spam": {
"type": "boolean",
"description": "boolean value"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"spam",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/show/comment": {
"post": {
"operationId": "POST_api_show_comment",
"summary": "Mark a comment that it should not be collapsed because of crowd control.",
"description": "Mark a comment that it should not be collapsed because of crowd control.",
"tags": [
"moderation"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modposts"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "fullname of a thing"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/snooze/reports": {
"post": {
"operationId": "POST_api_snooze_reports",
"summary": "Prevent future reports on a thing from causing notifications.",
"description": "Prevent future reports on a thing from causing notifications.",
"tags": [
"moderation"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modposts"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "fullname of a thing"
},
"reason": {
"type": "string",
"description": ""
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"reason",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/unignore/reports": {
"post": {
"operationId": "POST_api_unignore_reports",
"summary": "Allow future reports on a thing to cause notifications.",
"description": "Allow future reports on a thing to cause notifications.",
"tags": [
"moderation"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modposts"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "fullname of a thing"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/unsnooze/reports": {
"post": {
"operationId": "POST_api_unsnooze_reports",
"summary": "For users whose reports were snoozed (see /api/snooze_reports), to go back to escalating future repo",
"description": "For users whose reports were snoozed (see /api/snooze_reports), to go back to escalating future reports from those users.",
"tags": [
"moderation"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modposts"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "fullname of a thing"
},
"reason": {
"type": "string",
"description": ""
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"reason",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/update/crowd/control/level": {
"post": {
"operationId": "POST_api_update_crowd_control_level",
"summary": "Change the post's crowd control level.",
"description": "Change the post's crowd control level.",
"tags": [
"moderation"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modposts"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "fullname of a thing"
},
"level": {
"type": "integer",
"description": "an integer between 0 and 3"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"id",
"level",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/stylesheet": {
"get": {
"operationId": "GET_stylesheet",
"summary": "Redirect to the subreddit's stylesheet if one exists.",
"description": "Redirect to the subreddit's stylesheet if one exists.",
"tags": [
"moderation"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modconfig"
]
}
]
}
},
"/api/mod/bulk/read": {
"post": {
"operationId": "POST_api_mod_bulk_read",
"summary": "Marks all conversations read for a particular conversation state within the passed list of subreddit",
"description": "Marks all conversations read for a particular conversation state within the passed list of subreddits.",
"tags": [
"modmail"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modmail"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"entity": {
"type": "string",
"description": "comma-delimited list of subreddit names"
},
"state": {
"type": "string",
"description": "one of (all, appeals, notifications, inbox, filtered, inprogress, mod, archived, default, highlighted, admin, join_requests, new)"
}
},
"required": [
"entity",
"state"
]
}
}
}
}
}
},
"/api/mod/conversations": {
"get": {
"operationId": "GET_api_mod_conversations",
"summary": "Get conversations for a logged in user or subreddits",
"description": "Get conversations for a logged in user or subreddits",
"tags": [
"modmail"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "after",
"in": "query",
"description": "A Modmail Conversation ID, in the form ModmailConversation_<id>",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "entity",
"in": "query",
"description": "comma-delimited list of subreddit names",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "an integer between 1 and 100 (default: 25)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "sort",
"in": "query",
"description": "one of (recent, mod, user, unread)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "state",
"in": "query",
"description": "one of (all, appeals, notifications, inbox, filtered, inprogress, mod, archived, default, highlighted, admin, join_requests, new)",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"modmail"
]
}
]
},
"post": {
"operationId": "POST_api_mod_conversations",
"summary": "Creates a new conversation for a particular SR.",
"description": "Creates a new conversation for a particular SR.",
"tags": [
"modmail"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modmail"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"body": {
"type": "string",
"description": "raw markdown text"
},
"isAuthorHidden": {
"type": "boolean",
"description": "boolean value"
},
"srName": {
"type": "string",
"description": "subreddit name"
},
"subject": {
"type": "string",
"description": "a string no longer than 100 characters"
},
"to": {
"type": "string",
"description": "Modmail conversation recipient fullname"
}
},
"required": [
"body",
"isAuthorHidden",
"srName",
"subject",
"to"
]
}
}
}
}
}
},
"/api/mod/conversations/:conversation/id": {
"get": {
"operationId": "GET_api_mod_conversations_:conversation_id",
"summary": "Returns all messages, mod actions and conversation metadata for a given conversation id",
"description": "Returns all messages, mod actions and conversation metadata for a given conversation id",
"tags": [
"modmail"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "conversation_id",
"in": "query",
"description": "A Modmail Conversation ID, in the form ModmailConversation_<id>",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "markRead",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"security": [
{
"oauth2": [
"modmail"
]
}
]
},
"post": {
"operationId": "POST_api_mod_conversations_:conversation_id",
"summary": "Creates a new message for a particular conversation.",
"description": "Creates a new message for a particular conversation.",
"tags": [
"modmail"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modmail"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"body": {
"type": "string",
"description": "raw markdown text"
},
"conversation_id": {
"type": "string",
"description": "A Modmail Conversation ID, in the form ModmailConversation_<id>"
},
"isAuthorHidden": {
"type": "boolean",
"description": "boolean value"
},
"isInternal": {
"type": "boolean",
"description": "boolean value"
}
},
"required": [
"body",
"conversation_id",
"isAuthorHidden",
"isInternal"
]
}
}
}
}
}
},
"/api/mod/conversations/:conversation/id/approve": {
"post": {
"operationId": "POST_api_mod_conversations_:conversation_id_approve",
"summary": "Approve the non mod user associated with a particular conversation.",
"description": "Approve the non mod user associated with a particular conversation.",
"tags": [
"modmail"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modmail"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"conversation_id": {
"type": "string",
"description": "base36 modmail conversation id"
}
},
"required": [
"conversation_id"
]
}
}
}
}
}
},
"/api/mod/conversations/:conversation/id/archive": {
"post": {
"operationId": "POST_api_mod_conversations_:conversation_id_archive",
"summary": "Marks a conversation as archived.",
"description": "Marks a conversation as archived.",
"tags": [
"modmail"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modmail"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"conversation_id": {
"type": "string",
"description": "A Modmail Conversation ID, in the form ModmailConversation_<id>"
}
},
"required": [
"conversation_id"
]
}
}
}
}
}
},
"/api/mod/conversations/:conversation/id/disapprove": {
"post": {
"operationId": "POST_api_mod_conversations_:conversation_id_disapprove",
"summary": "Disapprove the non mod user associated with a particular conversation.",
"description": "Disapprove the non mod user associated with a particular conversation.",
"tags": [
"modmail"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modmail"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"conversation_id": {
"type": "string",
"description": "base36 modmail conversation id"
}
},
"required": [
"conversation_id"
]
}
}
}
}
}
},
"/api/mod/conversations/:conversation/id/highlight": {
"delete": {
"operationId": "DELETE_api_mod_conversations_:conversation_id_highlight",
"summary": "Removes a highlight from a conversation.",
"description": "Removes a highlight from a conversation.",
"tags": [
"modmail"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "conversation_id",
"in": "query",
"description": "A Modmail Conversation ID, in the form ModmailConversation_<id>",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"modmail"
]
}
]
},
"post": {
"operationId": "POST_api_mod_conversations_:conversation_id_highlight",
"summary": "Marks a conversation as highlighted.",
"description": "Marks a conversation as highlighted.",
"tags": [
"modmail"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modmail"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"conversation_id": {
"type": "string",
"description": "A Modmail Conversation ID, in the form ModmailConversation_<id>"
}
},
"required": [
"conversation_id"
]
}
}
}
}
}
},
"/api/mod/conversations/:conversation/id/mute": {
"post": {
"operationId": "POST_api_mod_conversations_:conversation_id_mute",
"summary": "Mutes the non mod user associated with a particular conversation.",
"description": "Mutes the non mod user associated with a particular conversation.",
"tags": [
"modmail"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modmail"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"conversation_id": {
"type": "string",
"description": "base36 modmail conversation id"
},
"num_hours": {
"type": "string",
"description": "one of (72, 168, 672)"
}
},
"required": [
"conversation_id",
"num_hours"
]
}
}
}
}
}
},
"/api/mod/conversations/:conversation/id/temp/ban": {
"post": {
"operationId": "POST_api_mod_conversations_:conversation_id_temp_ban",
"summary": "Temporary ban (switch from permanent to temporary ban) the non mod user associated with a particular",
"description": "Temporary ban (switch from permanent to temporary ban) the non mod user associated with a particular conversation.",
"tags": [
"modmail"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modmail"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"conversation_id": {
"type": "string",
"description": "base36 modmail conversation id"
},
"duration": {
"type": "integer",
"description": "an integer between 1 and 999"
}
},
"required": [
"conversation_id",
"duration"
]
}
}
}
}
}
},
"/api/mod/conversations/:conversation/id/unarchive": {
"post": {
"operationId": "POST_api_mod_conversations_:conversation_id_unarchive",
"summary": "Marks conversation as unarchived.",
"description": "Marks conversation as unarchived.",
"tags": [
"modmail"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modmail"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"conversation_id": {
"type": "string",
"description": "A Modmail Conversation ID, in the form ModmailConversation_<id>"
}
},
"required": [
"conversation_id"
]
}
}
}
}
}
},
"/api/mod/conversations/:conversation/id/unban": {
"post": {
"operationId": "POST_api_mod_conversations_:conversation_id_unban",
"summary": "Unban the non mod user associated with a particular conversation.",
"description": "Unban the non mod user associated with a particular conversation.",
"tags": [
"modmail"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modmail"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"conversation_id": {
"type": "string",
"description": "base36 modmail conversation id"
}
},
"required": [
"conversation_id"
]
}
}
}
}
}
},
"/api/mod/conversations/:conversation/id/unmute": {
"post": {
"operationId": "POST_api_mod_conversations_:conversation_id_unmute",
"summary": "Unmutes the non mod user associated with a particular conversation.",
"description": "Unmutes the non mod user associated with a particular conversation.",
"tags": [
"modmail"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modmail"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"conversation_id": {
"type": "string",
"description": "base36 modmail conversation id"
}
},
"required": [
"conversation_id"
]
}
}
}
}
}
},
"/api/mod/conversations/read": {
"post": {
"operationId": "POST_api_mod_conversations_read",
"summary": "Marks a conversations as read for the user.",
"description": "Marks a conversations as read for the user.",
"tags": [
"modmail"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modmail"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"conversationIds": {
"type": "string",
"description": "A comma-separated list of items"
}
},
"required": [
"conversationIds"
]
}
}
}
}
}
},
"/api/mod/conversations/subreddits": {
"get": {
"operationId": "GET_api_mod_conversations_subreddits",
"summary": "Returns a list of srs that the user moderates with mail permission",
"description": "Returns a list of srs that the user moderates with mail permission",
"tags": [
"modmail"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modmail"
]
}
]
}
},
"/api/mod/conversations/unread": {
"post": {
"operationId": "POST_api_mod_conversations_unread",
"summary": "Marks conversations as unread for the user.",
"description": "Marks conversations as unread for the user.",
"tags": [
"modmail"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modmail"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"conversationIds": {
"type": "string",
"description": "A comma-separated list of items"
}
},
"required": [
"conversationIds"
]
}
}
}
}
}
},
"/api/mod/conversations/unread/count": {
"get": {
"operationId": "GET_api_mod_conversations_unread_count",
"summary": "Endpoint to retrieve the unread conversation count by conversation state.",
"description": "Endpoint to retrieve the unread conversation count by conversation state.",
"tags": [
"modmail"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modmail"
]
}
]
}
},
"/api/mod/notes": {
"delete": {
"operationId": "DELETE_api_mod_notes",
"summary": "Delete a mod user note where type=NOTE.",
"description": "Delete a mod user note where type=NOTE.",
"tags": [
"modnote"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "note_id",
"in": "query",
"description": "a unique ID for the note to be deleted (should have a ModNote_ prefix)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subreddit",
"in": "query",
"description": "subreddit name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "user",
"in": "query",
"description": "account username",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"modnote"
]
}
]
},
"get": {
"operationId": "GET_api_mod_notes",
"summary": "Get mod notes for a specific user in a given subreddit.",
"description": "Get mod notes for a specific user in a given subreddit.",
"tags": [
"modnote"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "before",
"in": "query",
"description": "(optional) an encoded string used for pagination with mod notes",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "(optional) one of (NOTE, APPROVAL, REMOVAL, BAN, MUTE, INVITE, SPAM, CONTENT_CHANGE, MOD_ACTION, ALL), to be used for querying specific types of mod notes (default: all)",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "(optional) the number of mod notes to return in the response payload (default: 25, max: 100)'}",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "subreddit",
"in": "query",
"description": "subreddit name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "user",
"in": "query",
"description": "account username",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"modnote"
]
}
]
},
"post": {
"operationId": "POST_api_mod_notes",
"summary": "Create a mod user note where type=NOTE.",
"description": "Create a mod user note where type=NOTE.",
"tags": [
"modnote"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modnote"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "(optional) one of (BOT_BAN, PERMA_BAN, BAN, ABUSE_WARNING, SPAM_WARNING, SPAM_WATCH, SOLID_CONTRIBUTOR, HELPFUL_USER, USER_SUMMARY)"
},
"note": {
"type": "string",
"description": "Content of the note, should be a string with a maximum character limit of 250"
},
"reddit_id": {
"type": "string",
"description": "(optional) a fullname of a comment or post (should have either a t1 or t3 prefix)"
},
"subreddit": {
"type": "string",
"description": "subreddit name"
},
"user": {
"type": "string",
"description": "account username"
}
},
"required": [
"note",
"subreddit",
"user"
]
}
}
}
}
}
},
"/api/mod/notes/recent": {
"get": {
"operationId": "GET_api_mod_notes_recent",
"summary": "Fetch the most recent notes written by a moderator",
"description": "Fetch the most recent notes written by a moderator",
"tags": [
"modnote"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "subreddits",
"in": "query",
"description": "a comma delimited list of subreddits by name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "users",
"in": "query",
"description": "a comma delimited list of usernames",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"modnote"
]
}
]
}
},
"/api/multi/copy": {
"post": {
"operationId": "POST_api_multi_copy",
"summary": "Copy a multi.",
"description": "Copy a multi.",
"tags": [
"multis"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"subscribe"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"description_md": {
"type": "string",
"description": "raw markdown text"
},
"display_name": {
"type": "string",
"description": "a string no longer than 50 characters"
},
"expand_srs": {
"type": "boolean",
"description": "boolean value"
},
"from": {
"type": "string",
"description": "multireddit url path"
},
"to": {
"type": "string",
"description": "destination multireddit url path"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"description_md",
"display_name",
"expand_srs",
"from",
"to",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/multi/mine": {
"get": {
"operationId": "GET_api_multi_mine",
"summary": "Fetch a list of multis belonging to the current user.",
"description": "Fetch a list of multis belonging to the current user.",
"tags": [
"multis"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "expand_srs",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/api/multi/user/{username}": {
"get": {
"operationId": "GET_api_multi_user_username",
"summary": "Fetch a list of public multis belonging to username",
"description": "Fetch a list of public multis belonging to username",
"tags": [
"multis"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "expand_srs",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "username",
"in": "path",
"description": "A valid, existing reddit username",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/api/multi/{multipath}": {
"delete": {
"operationId": "DELETE_api_multi_multipath",
"summary": "Delete a multi.",
"description": "Delete a multi.",
"tags": [
"multis"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "multipath",
"in": "path",
"description": "multireddit url path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "uh / X-Modhash header",
"in": "query",
"description": "a modhash",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"subscribe"
]
}
]
},
"get": {
"operationId": "GET_api_multi_multipath",
"summary": "Fetch a multi's data and subreddit list by name.",
"description": "Fetch a multi's data and subreddit list by name.",
"tags": [
"multis"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "expand_srs",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "multipath",
"in": "path",
"description": "multireddit url path",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
},
"post": {
"operationId": "POST_api_multi_multipath",
"summary": "Create a multi. Responds with 409 Conflict if it already exists.",
"description": "Create a multi. Responds with 409 Conflict if it already exists.",
"tags": [
"multis"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "multipath",
"in": "path",
"description": "multireddit url path",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"subscribe"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"model": {
"type": "string",
"description": "json data: { "description_md": raw markdown text, "display_name": a string no longer than 50 characters, "icon_img": one of (`png`, `jpg`, `jpeg`), "key_color": a 6-digit rgb hex color, e.g. `#AABBCC`, "subreddits": [ { "name": subreddit name, }, ... ], "visibility": one of (`private`, `public`, `hidden`), }"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"model",
"uh / X-Modhash header"
]
}
}
}
}
},
"put": {
"operationId": "PUT_api_multi_multipath",
"summary": "Create or update a multi.",
"description": "Create or update a multi.",
"tags": [
"multis"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "multipath",
"in": "path",
"description": "multireddit url path",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"subscribe"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"expand_srs": {
"type": "boolean",
"description": "boolean value"
},
"model": {
"type": "string",
"description": "json data: { "description_md": raw markdown text, "display_name": a string no longer than 50 characters, "icon_img": one of (`png`, `jpg`, `jpeg`), "key_color": a 6-digit rgb hex color, e.g. `#AABBCC`, "subreddits": [ { "name": subreddit name, }, ... ], "visibility": one of (`private`, `public`, `hidden`), }"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"expand_srs",
"model",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/multi/{multipath}/description": {
"get": {
"operationId": "GET_api_multi_multipath_description",
"summary": "Get a multi's description.",
"description": "Get a multi's description.",
"tags": [
"multis"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "multipath",
"in": "path",
"description": "multireddit url path",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
},
"put": {
"operationId": "PUT_api_multi_multipath_description",
"summary": "Change a multi's markdown description.",
"description": "Change a multi's markdown description.",
"tags": [
"multis"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "multipath",
"in": "path",
"description": "multireddit url path",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"model": {
"type": "string",
"description": "json data: { "body_md": raw markdown text, }"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"model",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/multi/{multipath}/r/{srname}": {
"delete": {
"operationId": "DELETE_api_multi_multipath_r_srname",
"summary": "Remove a subreddit from a multi.",
"description": "Remove a subreddit from a multi.",
"tags": [
"multis"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "multipath",
"in": "path",
"description": "multireddit url path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "srname",
"in": "path",
"description": "subreddit name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "uh / X-Modhash header",
"in": "query",
"description": "a modhash",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"subscribe"
]
}
]
},
"get": {
"operationId": "GET_api_multi_multipath_r_srname",
"summary": "Get data about a subreddit in a multi.",
"description": "Get data about a subreddit in a multi.",
"tags": [
"multis"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "multipath",
"in": "path",
"description": "multireddit url path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "srname",
"in": "path",
"description": "subreddit name",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
},
"put": {
"operationId": "PUT_api_multi_multipath_r_srname",
"summary": "Add a subreddit to a multi.",
"description": "Add a subreddit to a multi.",
"tags": [
"multis"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "multipath",
"in": "path",
"description": "multireddit url path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "srname",
"in": "path",
"description": "subreddit name",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"subscribe"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"model": {
"type": "string",
"description": "json data: { "name": subreddit name, }"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"model",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/search": {
"get": {
"operationId": "GET_search",
"summary": "Search links page.",
"description": "Search links page. (RSS support available)",
"tags": [
"search"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "after",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "before",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "category",
"in": "query",
"description": "a string no longer than 5 characters",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "a positive integer (default: 0)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "include_facets",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "limit",
"in": "query",
"description": "the maximum number of items desired (default: 25, maximum: 100)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "q",
"in": "query",
"description": "a string no longer than 512 characters",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "restrict_sr",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "show",
"in": "query",
"description": "(optional) the string all",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "one of (relevance, hot, top, new, comments)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sr_detail",
"in": "query",
"description": "(optional) expand subreddits",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "t",
"in": "query",
"description": "one of (hour, day, week, month, year, all)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "(optional) comma-delimited list of result types (sr, link, user)",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/about/{where}": {
"get": {
"operationId": "GET_about_where",
"summary": "This endpoint is a listing.",
"description": "This endpoint is a listing. (RSS support available)",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "after",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "before",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "a positive integer (default: 0)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "the maximum number of items desired (default: 25, maximum: 100)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "show",
"in": "query",
"description": "(optional) the string all",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sr_detail",
"in": "query",
"description": "(optional) expand subreddits",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "user",
"in": "query",
"description": "A valid, existing reddit username",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "where",
"in": "path",
"description": "Path parameter: where",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/api/delete/sr/banner": {
"post": {
"operationId": "POST_api_delete_sr_banner",
"summary": "Remove the subreddit's custom mobile banner.",
"description": "Remove the subreddit's custom mobile banner.",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modconfig"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/delete/sr/header": {
"post": {
"operationId": "POST_api_delete_sr_header",
"summary": "Remove the subreddit's custom header image.",
"description": "Remove the subreddit's custom header image.",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modconfig"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/delete/sr/icon": {
"post": {
"operationId": "POST_api_delete_sr_icon",
"summary": "Remove the subreddit's custom mobile icon.",
"description": "Remove the subreddit's custom mobile icon.",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modconfig"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/delete/sr/img": {
"post": {
"operationId": "POST_api_delete_sr_img",
"summary": "Remove an image from the subreddit's custom image set.",
"description": "Remove an image from the subreddit's custom image set.",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modconfig"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"img_name": {
"type": "string",
"description": "a valid subreddit image name"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"img_name",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/recommend/sr/{srnames}": {
"get": {
"operationId": "GET_api_recommend_sr_srnames",
"summary": "DEPRECATED: Return subreddits recommended for the given subreddit(s).",
"description": "DEPRECATED: Return subreddits recommended for the given subreddit(s).",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "omit",
"in": "query",
"description": "comma-delimited list of subreddit names",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "over_18",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "srnames",
"in": "path",
"description": "comma-delimited list of subreddit names",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/api/search/reddit/names": {
"get": {
"operationId": "GET_api_search_reddit_names",
"summary": "List subreddit names that begin with a query string.",
"description": "List subreddit names that begin with a query string.",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "exact",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "include_over_18",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "include_unadvertisable",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "query",
"in": "query",
"description": "a string up to 50 characters long, consisting of printable characters.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "search_query_id",
"in": "query",
"description": "a uuid",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "typeahead_active",
"in": "query",
"description": "boolean value or None",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
},
"post": {
"operationId": "POST_api_search_reddit_names",
"summary": "List subreddit names that begin with a query string.",
"description": "List subreddit names that begin with a query string.",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"read"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"exact": {
"type": "boolean",
"description": "boolean value"
},
"include_over_18": {
"type": "boolean",
"description": "boolean value"
},
"include_unadvertisable": {
"type": "boolean",
"description": "boolean value"
},
"query": {
"type": "string",
"description": "a string up to 50 characters long, consisting of printable characters."
},
"search_query_id": {
"type": "string",
"description": "a uuid"
},
"typeahead_active": {
"type": "boolean",
"description": "boolean value or None"
}
},
"required": [
"exact",
"include_over_18",
"include_unadvertisable",
"query",
"search_query_id",
"typeahead_active"
]
}
}
}
}
}
},
"/api/search/subreddits": {
"post": {
"operationId": "POST_api_search_subreddits",
"summary": "List subreddits that begin with a query string.",
"description": "List subreddits that begin with a query string.",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"read"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"exact": {
"type": "boolean",
"description": "boolean value"
},
"include_over_18": {
"type": "boolean",
"description": "boolean value"
},
"include_unadvertisable": {
"type": "boolean",
"description": "boolean value"
},
"query": {
"type": "string",
"description": "a string up to 50 characters long, consisting of printable characters."
},
"search_query_id": {
"type": "string",
"description": "a uuid"
},
"typeahead_active": {
"type": "boolean",
"description": "boolean value or None"
}
},
"required": [
"exact",
"include_over_18",
"include_unadvertisable",
"query",
"search_query_id",
"typeahead_active"
]
}
}
}
}
}
},
"/api/site/admin": {
"post": {
"operationId": "POST_api_site_admin",
"summary": "Create or configure a subreddit.",
"description": "Create or configure a subreddit.",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modconfig"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"accept_followers": {
"type": "boolean",
"description": "boolean value"
},
"admin_override_spam_comments": {
"type": "boolean",
"description": "boolean value"
},
"admin_override_spam_links": {
"type": "boolean",
"description": "boolean value"
},
"admin_override_spam_selfposts": {
"type": "boolean",
"description": "boolean value"
},
"all_original_content": {
"type": "boolean",
"description": "boolean value"
},
"allow_chat_post_creation": {
"type": "boolean",
"description": "boolean value"
},
"allow_discovery": {
"type": "boolean",
"description": "boolean value"
},
"allow_galleries": {
"type": "boolean",
"description": "boolean value"
},
"allow_images": {
"type": "boolean",
"description": "boolean value"
},
"allow_polls": {
"type": "boolean",
"description": "boolean value"
},
"allow_post_crossposts": {
"type": "boolean",
"description": "boolean value"
},
"allow_prediction_contributors": {
"type": "boolean",
"description": "boolean value"
},
"allow_predictions": {
"type": "boolean",
"description": "boolean value"
},
"allow_predictions_tournament": {
"type": "boolean",
"description": "boolean value"
},
"allow_talks": {
"type": "boolean",
"description": "boolean value"
},
"allow_top": {
"type": "boolean",
"description": "boolean value"
},
"allow_videos": {
"type": "boolean",
"description": "boolean value"
},
"api_type": {
"type": "string",
"description": "the string json"
},
"collapse_deleted_comments": {
"type": "boolean",
"description": "boolean value"
},
"comment_contribution_settings": {
"type": "string",
"description": "json data: { "allowed_media_types": [ one of (`unknown`, `giphy`, `static`, `video`, `animated`, `expression`), ... ], }"
},
"comment_score_hide_mins": {
"type": "integer",
"description": "an integer between 0 and 1440 (default: 0)"
},
"crowd_control_chat_level": {
"type": "integer",
"description": "an integer between 0 and 3"
},
"crowd_control_filter": {
"type": "boolean",
"description": "boolean value"
},
"crowd_control_level": {
"type": "integer",
"description": "an integer between 0 and 3"
},
"crowd_control_mode": {
"type": "boolean",
"description": "boolean value"
},
"crowd_control_post_level": {
"type": "integer",
"description": "an integer between 0 and 3"
},
"description": {
"type": "string",
"description": "raw markdown text"
},
"disable_contributor_requests": {
"type": "boolean",
"description": "boolean value"
},
"exclude_banned_modqueue": {
"type": "boolean",
"description": "boolean value"
},
"free_form_reports": {
"type": "boolean",
"description": "boolean value"
},
"g-recaptcha-response": {
"type": "string",
"description": ""
},
"hateful_content_threshold_abuse": {
"type": "integer",
"description": "an integer between 0 and 3"
},
"hateful_content_threshold_identity": {
"type": "integer",
"description": "an integer between 0 and 3"
},
"header-title": {
"type": "string",
"description": "a string no longer than 500 characters"
},
"hide_ads": {
"type": "boolean",
"description": "boolean value"
},
"key_color": {
"type": "string",
"description": "a 6-digit rgb hex color, e.g. #AABBCC"
},
"link_type": {
"type": "string",
"description": "one of (any, link, self)"
},
"modmail_harassment_filter_enabled": {
"type": "boolean",
"description": "boolean value"
},
"name": {
"type": "string",
"description": "subreddit name"
},
"new_pinned_post_pns_enabled": {
"type": "boolean",
"description": "boolean value"
},
"original_content_tag_enabled": {
"type": "boolean",
"description": "boolean value"
},
"over_18": {
"type": "boolean",
"description": "boolean value"
},
"prediction_leaderboard_entry_type": {
"type": "integer",
"description": "an integer between 0 and 2"
},
"public_description": {
"type": "string",
"description": "raw markdown text"
},
"restrict_commenting": {
"type": "boolean",
"description": "boolean value"
},
"restrict_posting": {
"type": "boolean",
"description": "boolean value"
},
"should_archive_posts": {
"type": "boolean",
"description": "boolean value"
},
"show_media": {
"type": "boolean",
"description": "boolean value"
},
"show_media_preview": {
"type": "boolean",
"description": "boolean value"
},
"spam_comments": {
"type": "string",
"description": "one of (low, high, all)"
},
"spam_links": {
"type": "string",
"description": "one of (low, high, all)"
},
"spam_selfposts": {
"type": "string",
"description": "one of (low, high, all)"
},
"spoilers_enabled": {
"type": "boolean",
"description": "boolean value"
},
"sr": {
"type": "string",
"description": "fullname of a thing"
},
"submit_link_label": {
"type": "string",
"description": "a string no longer than 60 characters"
},
"submit_text": {
"type": "string",
"description": "raw markdown text"
},
"submit_text_label": {
"type": "string",
"description": "a string no longer than 60 characters"
},
"subreddit_discovery_settings": {
"type": "string",
"description": "json data: { "disabled_discovery_types": [ one of (`unknown`, `onboarding`), ... ], }"
},
"suggested_comment_sort": {
"type": "string",
"description": "one of (confidence, top, new, controversial, old, random, qa, live)"
},
"title": {
"type": "string",
"description": "a string no longer than 100 characters"
},
"toxicity_threshold_chat_level": {
"type": "integer",
"description": "an integer between 0 and 1"
},
"type": {
"type": "string",
"description": "one of (gold_restricted, archived, restricted, private, employees_only, gold_only, public, user)"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
},
"user_flair_pns_enabled": {
"type": "boolean",
"description": "boolean value"
},
"welcome_message_enabled": {
"type": "boolean",
"description": "boolean value"
},
"welcome_message_text": {
"type": "string",
"description": "raw markdown text"
},
"wiki_edit_age": {
"type": "integer",
"description": "an integer between 0 and 36600 (default: 0)"
},
"wiki_edit_karma": {
"type": "integer",
"description": "an integer between 0 and 1000000000 (default: 0)"
},
"wikimode": {
"type": "string",
"description": "one of (disabled, modonly, anyone)"
}
},
"required": [
"accept_followers",
"admin_override_spam_comments",
"admin_override_spam_links",
"admin_override_spam_selfposts",
"all_original_content",
"allow_chat_post_creation",
"allow_discovery",
"allow_galleries",
"allow_images",
"allow_polls",
"allow_post_crossposts",
"allow_prediction_contributors",
"allow_predictions",
"allow_predictions_tournament",
"allow_talks",
"allow_top",
"allow_videos",
"api_type",
"collapse_deleted_comments",
"comment_contribution_settings",
"comment_score_hide_mins",
"crowd_control_chat_level",
"crowd_control_filter",
"crowd_control_level",
"crowd_control_mode",
"crowd_control_post_level",
"description",
"disable_contributor_requests",
"exclude_banned_modqueue",
"free_form_reports",
"g-recaptcha-response",
"hateful_content_threshold_abuse",
"hateful_content_threshold_identity",
"header-title",
"hide_ads",
"key_color",
"link_type",
"modmail_harassment_filter_enabled",
"name",
"new_pinned_post_pns_enabled",
"original_content_tag_enabled",
"over_18",
"prediction_leaderboard_entry_type",
"public_description",
"restrict_commenting",
"restrict_posting",
"should_archive_posts",
"show_media",
"show_media_preview",
"spam_comments",
"spam_links",
"spam_selfposts",
"spoilers_enabled",
"sr",
"submit_link_label",
"submit_text",
"submit_text_label",
"subreddit_discovery_settings",
"suggested_comment_sort",
"title",
"toxicity_threshold_chat_level",
"type",
"uh / X-Modhash header",
"user_flair_pns_enabled",
"welcome_message_enabled",
"welcome_message_text",
"wiki_edit_age",
"wiki_edit_karma",
"wikimode"
]
}
}
}
}
}
},
"/api/submit/text": {
"get": {
"operationId": "GET_api_submit_text",
"summary": "Get the submission text for the subreddit.",
"description": "Get the submission text for the subreddit.",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"submit"
]
}
]
}
},
"/api/subreddit/autocomplete": {
"get": {
"operationId": "GET_api_subreddit_autocomplete",
"summary": "Return a list of subreddits and data for subreddits whose names start with 'query'.",
"description": "Return a list of subreddits and data for subreddits whose names start with 'query'.",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "include_over_18",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "include_profiles",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "query",
"in": "query",
"description": "a string up to 25 characters long, consisting of printable characters.",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/api/subreddit/autocomplete/v2": {
"get": {
"operationId": "GET_api_subreddit_autocomplete_v2",
"summary": "GET /api/subreddit/autocomplete/v2",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "include_over_18",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "include_profiles",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "limit",
"in": "query",
"description": "an integer between 1 and 10 (default: 5)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "query",
"in": "query",
"description": "a string up to 25 characters long, consisting of printable characters.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "search_query_id",
"in": "query",
"description": "a uuid",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "typeahead_active",
"in": "query",
"description": "boolean value or None",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/api/subreddit/stylesheet": {
"post": {
"operationId": "POST_api_subreddit_stylesheet",
"summary": "Update a subreddit's stylesheet.",
"description": "Update a subreddit's stylesheet.",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modconfig"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"op": {
"type": "string",
"description": "one of (save, preview)"
},
"reason": {
"type": "string",
"description": "a string up to 256 characters long, consisting of printable characters."
},
"stylesheet_contents": {
"type": "string",
"description": "the new stylesheet content"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"op",
"reason",
"stylesheet_contents",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/subscribe": {
"post": {
"operationId": "POST_api_subscribe",
"summary": "Subscribe to or unsubscribe from a subreddit.",
"description": "Subscribe to or unsubscribe from a subreddit.",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"subscribe"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "one of (sub, unsub)"
},
"action_source": {
"type": "string",
"description": "one of (onboarding, autosubscribe)"
},
"skip_initial_defaults": {
"type": "boolean",
"description": "boolean value"
},
"sr / sr_name": {
"type": "string",
"description": "A comma-separated list of subreddit fullnames (when using the "sr" parameter), or of subreddit names (when using the "sr_name" parameter)."
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"action",
"action_source",
"skip_initial_defaults",
"sr / sr_name",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/upload/sr/img": {
"post": {
"operationId": "POST_api_upload_sr_img",
"summary": "Add or replace a subreddit image, custom header logo, custom mobile icon, or custom mobile banner.",
"description": "Add or replace a subreddit image, custom header logo, custom mobile icon, or custom mobile banner.",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modconfig"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"description": "file upload with maximum size of 500 KiB"
},
"formid": {
"type": "string",
"description": "(optional) can be ignored"
},
"header": {
"type": "integer",
"description": "an integer between 0 and 1"
},
"img_type": {
"type": "string",
"description": "one of png or jpg (default: png)"
},
"name": {
"type": "string",
"description": "a valid subreddit image name"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
},
"upload_type": {
"type": "string",
"description": "one of (img, header, icon, banner)"
}
},
"required": [
"file",
"header",
"img_type",
"name",
"uh / X-Modhash header",
"upload_type"
]
}
}
}
}
}
},
"/api/v1/{subreddit}/post/requirements": {
"get": {
"operationId": "GET_api_v1_subreddit_post_requirements",
"summary": "Fetch moderator-designated requirements to post to the subreddit.",
"description": "Fetch moderator-designated requirements to post to the subreddit.",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "subreddit",
"in": "path",
"description": "Path parameter: subreddit",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"submit"
]
}
]
}
},
"/r/{subreddit}/about": {
"get": {
"operationId": "GET_r_subreddit_about",
"summary": "Return information about the subreddit.",
"description": "Return information about the subreddit.",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "subreddit",
"in": "path",
"description": "Path parameter: subreddit",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/r/{subreddit}/about/edit": {
"get": {
"operationId": "GET_r_subreddit_about_edit",
"summary": "Get the current settings of a subreddit.",
"description": "Get the current settings of a subreddit.",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "created",
"in": "query",
"description": "one of (true, false)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "location",
"in": "query",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "subreddit",
"in": "path",
"description": "Path parameter: subreddit",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"modconfig"
]
}
]
}
},
"/r/{subreddit}/about/rules": {
"get": {
"operationId": "GET_r_subreddit_about_rules",
"summary": "Get the rules for the current subreddit",
"description": "Get the rules for the current subreddit",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "subreddit",
"in": "path",
"description": "Path parameter: subreddit",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/r/{subreddit}/about/traffic": {
"get": {
"operationId": "GET_r_subreddit_about_traffic",
"summary": "GET /r/{subreddit}/about/traffic",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "subreddit",
"in": "path",
"description": "Path parameter: subreddit",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"modconfig"
]
}
]
}
},
"/sidebar": {
"get": {
"operationId": "GET_sidebar",
"summary": "Get the sidebar for the current subreddit",
"description": "Get the sidebar for the current subreddit",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/sticky": {
"get": {
"operationId": "GET_sticky",
"summary": "Redirect to one of the posts stickied in the current subreddit",
"description": "Redirect to one of the posts stickied in the current subreddit",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "num",
"in": "query",
"description": "an integer between 1 and 2 (default: 1)",
"required": true,
"schema": {
"type": "integer"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/subreddits/mine/{where}": {
"get": {
"operationId": "GET_subreddits_mine_where",
"summary": "Get subreddits the user has a relationship with.",
"description": "Get subreddits the user has a relationship with. (RSS support available)\n\nURI variants: /subreddits/mine/subscriber, /subreddits/mine/contributor, /subreddits/mine/moderator, /subreddits/mine/streams",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "where",
"in": "path",
"description": "Path parameter: where",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"mysubreddits"
]
}
]
}
},
"/subreddits/search": {
"get": {
"operationId": "GET_subreddits_search",
"summary": "Search subreddits by title and description.",
"description": "Search subreddits by title and description. (RSS support available)",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "after",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "before",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "a positive integer (default: 0)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "the maximum number of items desired (default: 25, maximum: 100)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "q",
"in": "query",
"description": "a search query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "search_query_id",
"in": "query",
"description": "a uuid",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "show",
"in": "query",
"description": "(optional) the string all",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "show_users",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
},
{
"name": "sort",
"in": "query",
"description": "one of (relevance, activity)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sr_detail",
"in": "query",
"description": "(optional) expand subreddits",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "typeahead_active",
"in": "query",
"description": "boolean value or None",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/subreddits/{where}": {
"get": {
"operationId": "GET_subreddits_where",
"summary": "Get all subreddits.",
"description": "Get all subreddits. (RSS support available)\n\nURI variants: /subreddits/popular, /subreddits/new, /subreddits/gold, /subreddits/default",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "where",
"in": "path",
"description": "Path parameter: where",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/users/search": {
"get": {
"operationId": "GET_users_search",
"summary": "Search user profiles by title and description.",
"description": "Search user profiles by title and description. (RSS support available)",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "after",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "before",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "a positive integer (default: 0)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "the maximum number of items desired (default: 25, maximum: 100)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "q",
"in": "query",
"description": "a search query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "search_query_id",
"in": "query",
"description": "a uuid",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "show",
"in": "query",
"description": "(optional) the string all",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "one of (relevance, activity)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sr_detail",
"in": "query",
"description": "(optional) expand subreddits",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "typeahead_active",
"in": "query",
"description": "boolean value or None",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/users/{where}": {
"get": {
"operationId": "GET_users_where",
"summary": "Get all user subreddits.",
"description": "Get all user subreddits. (RSS support available)\n\nURI variants: /users/popular, /users/new",
"tags": [
"subreddits"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "where",
"in": "path",
"description": "Path parameter: where",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/api/block/user": {
"post": {
"operationId": "POST_api_block_user",
"summary": "For blocking a user. Only accessible to approved OAuth applications",
"description": "For blocking a user. Only accessible to approved OAuth applications",
"tags": [
"users"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"account"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"account_id": {
"type": "string",
"description": "fullname of a account"
},
"api_type": {
"type": "string",
"description": "the string json"
},
"name": {
"type": "string",
"description": "A valid, existing reddit username"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"account_id",
"api_type",
"name",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/friend": {
"post": {
"operationId": "POST_api_friend",
"summary": "Create a relationship between a user and another user or subreddit",
"description": "Create a relationship between a user and another user or subreddit",
"tags": [
"users"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"any"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"ban_context": {
"type": "string",
"description": "fullname of a thing"
},
"ban_message": {
"type": "string",
"description": "raw markdown text"
},
"ban_reason": {
"type": "string",
"description": "a string no longer than 100 characters"
},
"container": {
"type": "string",
"description": ""
},
"duration": {
"type": "integer",
"description": "an integer between 1 and 999"
},
"name": {
"type": "string",
"description": "the name of an existing user"
},
"note": {
"type": "string",
"description": "a string no longer than 300 characters"
},
"permissions": {
"type": "string",
"description": ""
},
"type": {
"type": "string",
"description": "one of (friend, moderator, moderator_invite, contributor, banned, muted, wikibanned, wikicontributor)"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"ban_context",
"ban_message",
"ban_reason",
"container",
"duration",
"name",
"note",
"permissions",
"type",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/report/user": {
"post": {
"operationId": "POST_api_report_user",
"summary": "Report a user. Reporting a user brings it to the attention of a Reddit admin.",
"description": "Report a user. Reporting a user brings it to the attention of a Reddit admin.",
"tags": [
"users"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"report"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"details": {
"type": "string",
"description": "JSON data"
},
"reason": {
"type": "string",
"description": "a string no longer than 100 characters"
},
"('user',)": {
"type": "string",
"description": "A valid, existing reddit username"
}
},
"required": [
"details",
"reason",
"('user',)"
]
}
}
}
}
}
},
"/api/setpermissions": {
"post": {
"operationId": "POST_api_setpermissions",
"summary": "POST /api/setpermissions",
"tags": [
"users"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modothers"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"name": {
"type": "string",
"description": "the name of an existing user"
},
"permissions": {
"type": "string",
"description": ""
},
"type": {
"type": "string",
"description": ""
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"name",
"permissions",
"type",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/unfriend": {
"post": {
"operationId": "POST_api_unfriend",
"summary": "Remove a relationship between a user and another user or subreddit",
"description": "Remove a relationship between a user and another user or subreddit",
"tags": [
"users"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"any"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"api_type": {
"type": "string",
"description": "the string json"
},
"container": {
"type": "string",
"description": ""
},
"id": {
"type": "string",
"description": "fullname of a thing"
},
"name": {
"type": "string",
"description": "the name of an existing user"
},
"type": {
"type": "string",
"description": "one of (friend, enemy, moderator, moderator_invite, contributor, banned, muted, wikibanned, wikicontributor)"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"api_type",
"container",
"id",
"name",
"type",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/user/data/by/account/ids": {
"get": {
"operationId": "GET_api_user_data_by_account_ids",
"summary": "GET /api/user/data/by/account/ids",
"tags": [
"users"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "ids",
"in": "query",
"description": "A comma-separated list of account fullnames",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"privatemessages"
]
}
]
}
},
"/api/username/available": {
"get": {
"operationId": "GET_api_username_available",
"summary": "Check whether a username is available for registration.",
"description": "Check whether a username is available for registration.",
"tags": [
"users"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "user",
"in": "query",
"description": "a valid, unused, username",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"any"
]
}
]
}
},
"/api/v1/me/friends/{username}": {
"delete": {
"operationId": "DELETE_api_v1_me_friends_username",
"summary": "Stop being friends with a user.",
"description": "Stop being friends with a user.",
"tags": [
"users"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "query",
"description": "A valid, existing reddit username",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "username",
"in": "path",
"description": "Path parameter: username",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"subscribe"
]
}
]
},
"put": {
"operationId": "PUT_api_v1_me_friends_username",
"summary": "Create or update a "friend" relationship.",
"description": "Create or update a "friend" relationship.",
"tags": [
"users"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "username",
"in": "path",
"description": "Path parameter: username",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"subscribe"
]
}
]
}
},
"/api/v1/user/{username}/trophies": {
"get": {
"operationId": "GET_api_v1_user_username_trophies",
"summary": "Return a list of trophies for the a given user.",
"description": "Return a list of trophies for the a given user.",
"tags": [
"users"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "id",
"in": "query",
"description": "A valid, existing reddit username",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "username",
"in": "path",
"description": "Path parameter: username",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/user/{username}/about": {
"get": {
"operationId": "GET_user_username_about",
"summary": "Return information about the user, including karma and gold status.",
"description": "Return information about the user, including karma and gold status.",
"tags": [
"users"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "username",
"in": "path",
"description": "the name of an existing user",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"read"
]
}
]
}
},
"/user/{username}/{where}": {
"get": {
"operationId": "GET_user_username_where",
"summary": "This endpoint is a listing.",
"description": "This endpoint is a listing. (RSS support available)",
"tags": [
"users"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "context",
"in": "query",
"description": "an integer between 2 and 10",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "show",
"in": "query",
"description": "one of (given)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "one of (hot, new, top, controversial)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "t",
"in": "query",
"description": "one of (hour, day, week, month, year, all)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "one of (links, comments)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "username",
"in": "path",
"description": "the name of an existing user",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "where",
"in": "path",
"description": "Path parameter: where",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"history"
]
}
]
}
},
"/api/widget": {
"post": {
"operationId": "POST_api_widget",
"summary": "Add and return a widget to the specified subreddit",
"description": "Add and return a widget to the specified subreddit",
"tags": [
"widgets"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"structuredstyles"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"json": {
"type": "integer",
"description": "json data: { "data": [ { "height": an integer, "linkUrl": A valid URL (optional), "url": a valid URL of a reddit-hosted image, "width": an integer, }, ... ], "kind": one of (`image`), "shortName": a string no longer than 30 characters, "styles": { "backgroundColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "headerColor": a 6-digit rgb hex color, e.g. `#AABBCC`, }, } OR { "configuration": { "numEvents": an integer between 1 and 50 (default: 10), "showDate": boolean value, "showDescription": boolean value, "showLocation": boolean value, "showTime": boolean value, "showTitle": boolean value, }, "googleCalendarId": a valid email address, "kind": one of (`calendar`), "requiresSync": boolean value, "shortName": a string no longer than 30 characters, "styles": { "backgroundColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "headerColor": a 6-digit rgb hex color, e.g. `#AABBCC`, }, } OR { "kind": one of (`textarea`), "shortName": a string no longer than 30 characters, "styles": { "backgroundColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "headerColor": a 6-digit rgb hex color, e.g. `#AABBCC`, }, "text": raw markdown text, } OR { "data": [ { "text": a string no longer than 20 characters, "url": a valid URL, } OR { "children": [ { "text": a string no longer than 20 characters, "url": a valid URL, }, ... ], "text": a string no longer than 20 characters, }, ... ], "kind": one of (`menu`), "showWiki": boolean value, } OR { "buttons": [ { "color": a 6-digit rgb hex color, e.g. `#AABBCC`, "fillColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "hoverState": { "color": a 6-digit rgb hex color, e.g. `#AABBCC`, "fillColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "kind": one of (`text`), "text": a string no longer than 30 characters, "textColor": a 6-digit rgb hex color, e.g. `#AABBCC`, } OR { "height": an integer, "imageUrl": a valid URL of a reddit-hosted image, "kind": one of (`image`), "width": an integer, }, "kind": one of (`text`), "text": a string no longer than 30 characters, "textColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "url": a valid URL, } OR { "height": an integer, "hoverState": { "color": a 6-digit rgb hex color, e.g. `#AABBCC`, "fillColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "kind": one of (`text`), "text": a string no longer than 30 characters, "textColor": a 6-digit rgb hex color, e.g. `#AABBCC`, } OR { "height": an integer, "imageUrl": a valid URL of a reddit-hosted image, "kind": one of (`image`), "width": an integer, }, "imageUrl": a valid URL of a reddit-hosted image, "kind": one of (`image`), "linkUrl": a valid URL, "text": a string no longer than 30 characters, "width": an integer, }, ... ], "description": raw markdown text, "kind": one of (`button`), "shortName": a string no longer than 30 characters, "styles": { "backgroundColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "headerColor": a 6-digit rgb hex color, e.g. `#AABBCC`, }, } OR { "data": [ subreddit name, ... ], "kind": one of (`community-list`), "shortName": a string no longer than 30 characters, "styles": { "backgroundColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "headerColor": a 6-digit rgb hex color, e.g. `#AABBCC`, }, } OR { "css": a string no longer than 100000 characters, "height": an integer between 50 and 500, "imageData": [ { "height": an integer, "name": a string no longer than 20 characters, "url": a valid URL of a reddit-hosted image, "width": an integer, }, ... ], "kind": one of (`custom`), "shortName": a string no longer than 30 characters, "styles": { "backgroundColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "headerColor": a 6-digit rgb hex color, e.g. `#AABBCC`, }, "text": raw markdown text, } OR { "display": one of (`cloud`, `list`), "kind": one of (`post-flair`), "order": [ a flair template ID, ... ], "shortName": a string no longer than 30 characters, "styles": { "backgroundColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "headerColor": a 6-digit rgb hex color, e.g. `#AABBCC`, }, }"
}
}
}
}
}
}
}
},
"/api/widget/{widget/id}": {
"delete": {
"operationId": "DELETE_api_widget_widget_id",
"summary": "Delete a widget from the specified subreddit (if it exists)",
"description": "Delete a widget from the specified subreddit (if it exists)",
"tags": [
"widgets"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "widget_id",
"in": "query",
"description": "id of an existing widget",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"structuredstyles"
]
}
]
},
"put": {
"operationId": "PUT_api_widget_widget_id",
"summary": "Update and return the data of a widget.",
"description": "Update and return the data of a widget.",
"tags": [
"widgets"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"structuredstyles"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"json": {
"type": "integer",
"description": "json data: { "data": [ { "height": an integer, "linkUrl": A valid URL (optional), "url": a valid URL of a reddit-hosted image, "width": an integer, }, ... ], "kind": one of (`image`), "shortName": a string no longer than 30 characters, "styles": { "backgroundColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "headerColor": a 6-digit rgb hex color, e.g. `#AABBCC`, }, } OR { "configuration": { "numEvents": an integer between 1 and 50 (default: 10), "showDate": boolean value, "showDescription": boolean value, "showLocation": boolean value, "showTime": boolean value, "showTitle": boolean value, }, "googleCalendarId": a valid email address, "kind": one of (`calendar`), "requiresSync": boolean value, "shortName": a string no longer than 30 characters, "styles": { "backgroundColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "headerColor": a 6-digit rgb hex color, e.g. `#AABBCC`, }, } OR { "kind": one of (`textarea`), "shortName": a string no longer than 30 characters, "styles": { "backgroundColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "headerColor": a 6-digit rgb hex color, e.g. `#AABBCC`, }, "text": raw markdown text, } OR { "display": one of (`full`, `compact`), "kind": one of (`subreddit-rules`), "shortName": a string no longer than 30 characters, "styles": { "backgroundColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "headerColor": a 6-digit rgb hex color, e.g. `#AABBCC`, }, } OR { "data": [ { "text": a string no longer than 20 characters, "url": a valid URL, } OR { "children": [ { "text": a string no longer than 20 characters, "url": a valid URL, }, ... ], "text": a string no longer than 20 characters, }, ... ], "kind": one of (`menu`), "showWiki": boolean value, } OR { "buttons": [ { "color": a 6-digit rgb hex color, e.g. `#AABBCC`, "fillColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "hoverState": { "color": a 6-digit rgb hex color, e.g. `#AABBCC`, "fillColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "kind": one of (`text`), "text": a string no longer than 30 characters, "textColor": a 6-digit rgb hex color, e.g. `#AABBCC`, } OR { "height": an integer, "imageUrl": a valid URL of a reddit-hosted image, "kind": one of (`image`), "width": an integer, }, "kind": one of (`text`), "text": a string no longer than 30 characters, "textColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "url": a valid URL, } OR { "height": an integer, "hoverState": { "color": a 6-digit rgb hex color, e.g. `#AABBCC`, "fillColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "kind": one of (`text`), "text": a string no longer than 30 characters, "textColor": a 6-digit rgb hex color, e.g. `#AABBCC`, } OR { "height": an integer, "imageUrl": a valid URL of a reddit-hosted image, "kind": one of (`image`), "width": an integer, }, "imageUrl": a valid URL of a reddit-hosted image, "kind": one of (`image`), "linkUrl": a valid URL, "text": a string no longer than 30 characters, "width": an integer, }, ... ], "description": raw markdown text, "kind": one of (`button`), "shortName": a string no longer than 30 characters, "styles": { "backgroundColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "headerColor": a 6-digit rgb hex color, e.g. `#AABBCC`, }, } OR { "currentlyViewingText": a string no longer than 30 characters, "kind": one of (`id-card`), "shortName": a string no longer than 30 characters, "styles": { "backgroundColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "headerColor": a 6-digit rgb hex color, e.g. `#AABBCC`, }, "subscribersText": a string no longer than 30 characters, } OR { "data": [ subreddit name, ... ], "kind": one of (`community-list`), "shortName": a string no longer than 30 characters, "styles": { "backgroundColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "headerColor": a 6-digit rgb hex color, e.g. `#AABBCC`, }, } OR { "css": a string no longer than 100000 characters, "height": an integer between 50 and 500, "imageData": [ { "height": an integer, "name": a string no longer than 20 characters, "url": a valid URL of a reddit-hosted image, "width": an integer, }, ... ], "kind": one of (`custom`), "shortName": a string no longer than 30 characters, "styles": { "backgroundColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "headerColor": a 6-digit rgb hex color, e.g. `#AABBCC`, }, "text": raw markdown text, } OR { "display": one of (`cloud`, `list`), "kind": one of (`post-flair`), "order": [ a flair template ID, ... ], "shortName": a string no longer than 30 characters, "styles": { "backgroundColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "headerColor": a 6-digit rgb hex color, e.g. `#AABBCC`, }, } OR { "kind": one of (`moderators`), "styles": { "backgroundColor": a 6-digit rgb hex color, e.g. `#AABBCC`, "headerColor": a 6-digit rgb hex color, e.g. `#AABBCC`, }, }"
},
"widget_id": {
"type": "string",
"description": "a valid widget id"
}
},
"required": [
"widget_id"
]
}
}
}
}
}
},
"/api/widget/image/upload/s3": {
"post": {
"operationId": "POST_api_widget_image_upload_s3",
"summary": "Acquire and return an upload lease to s3 temp bucket.",
"description": "Acquire and return an upload lease to s3 temp bucket.",
"tags": [
"widgets"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"structuredstyles"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"filepath": {
"type": "string",
"description": "name and extension of the image file e.g. image1.png"
},
"mimetype": {
"type": "string",
"description": "mime type of the image e.g. image/png"
}
},
"required": [
"filepath",
"mimetype"
]
}
}
}
}
}
},
"/api/widget/order/{section}": {
"patch": {
"operationId": "PATCH_api_widget_order_section",
"summary": "Update the order of widget_ids in the specified subreddit",
"description": "Update the order of widget_ids in the specified subreddit",
"tags": [
"widgets"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "section",
"in": "path",
"description": "one of (sidebar)",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"structuredstyles"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"json": {
"type": "string",
"description": "json data: [ a string, ... ]"
}
},
"required": [
"json"
]
}
}
}
}
}
},
"/api/widgets": {
"get": {
"operationId": "GET_api_widgets",
"summary": "Return all widgets for the given subreddit",
"description": "Return all widgets for the given subreddit",
"tags": [
"widgets"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "progressive_images",
"in": "query",
"description": "boolean value",
"required": true,
"schema": {
"type": "boolean"
}
}
],
"security": [
{
"oauth2": [
"structuredstyles"
]
}
]
}
},
"/api/wiki/alloweditor/{act}": {
"post": {
"operationId": "POST_api_wiki_alloweditor_act",
"summary": "Allow/deny username to edit this wiki page",
"description": "Allow/deny username to edit this wiki page",
"tags": [
"wiki"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "act",
"in": "path",
"description": "one of (del, add)",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"modwiki"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "string",
"description": "the name of an existing wiki page"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
},
"username": {
"type": "string",
"description": "the name of an existing user"
}
},
"required": [
"page",
"uh / X-Modhash header",
"username"
]
}
}
}
}
}
},
"/api/wiki/edit": {
"post": {
"operationId": "POST_api_wiki_edit",
"summary": "Edit a wiki page",
"description": "Edit a wiki page",
"tags": [
"wiki"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"wikiedit"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"content": {
"type": "string",
"description": ""
},
"page": {
"type": "string",
"description": "the name of an existing page or a new page to create"
},
"previous": {
"type": "string",
"description": "the starting point revision for this edit"
},
"reason": {
"type": "string",
"description": "a string up to 256 characters long, consisting of printable characters."
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"content",
"page",
"previous",
"reason",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/wiki/hide": {
"post": {
"operationId": "POST_api_wiki_hide",
"summary": "Toggle the public visibility of a wiki page revision",
"description": "Toggle the public visibility of a wiki page revision",
"tags": [
"wiki"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modwiki"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "string",
"description": "the name of an existing wiki page"
},
"revision": {
"type": "string",
"description": "a wiki revision ID"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"page",
"revision",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/api/wiki/revert": {
"post": {
"operationId": "POST_api_wiki_revert",
"summary": "Revert a wiki page to revision",
"description": "Revert a wiki page to revision",
"tags": [
"wiki"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"modwiki"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "string",
"description": "the name of an existing wiki page"
},
"revision": {
"type": "string",
"description": "a wiki revision ID"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"page",
"revision",
"uh / X-Modhash header"
]
}
}
}
}
}
},
"/wiki/discussions/{page}": {
"get": {
"operationId": "GET_wiki_discussions_page",
"summary": "Retrieve a list of discussions about this wiki page",
"description": "Retrieve a list of discussions about this wiki page",
"tags": [
"wiki"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "after",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "before",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "a positive integer (default: 0)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "the maximum number of items desired (default: 25, maximum: 100)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "path",
"description": "the name of an existing wiki page",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "show",
"in": "query",
"description": "(optional) the string all",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sr_detail",
"in": "query",
"description": "(optional) expand subreddits",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"wikiread"
]
}
]
}
},
"/wiki/pages": {
"get": {
"operationId": "GET_wiki_pages",
"summary": "Retrieve a list of wiki pages in this subreddit",
"description": "Retrieve a list of wiki pages in this subreddit",
"tags": [
"wiki"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"security": [
{
"oauth2": [
"wikiread"
]
}
]
}
},
"/wiki/revisions": {
"get": {
"operationId": "GET_wiki_revisions",
"summary": "Retrieve a list of recently changed wiki pages in this subreddit",
"description": "Retrieve a list of recently changed wiki pages in this subreddit",
"tags": [
"wiki"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "after",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "before",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "a positive integer (default: 0)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "the maximum number of items desired (default: 25, maximum: 100)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "show",
"in": "query",
"description": "(optional) the string all",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sr_detail",
"in": "query",
"description": "(optional) expand subreddits",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"wikiread"
]
}
]
}
},
"/wiki/revisions/{page}": {
"get": {
"operationId": "GET_wiki_revisions_page",
"summary": "Retrieve a list of revisions of this wiki page",
"description": "Retrieve a list of revisions of this wiki page",
"tags": [
"wiki"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "after",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "before",
"in": "query",
"description": "fullname of a thing",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "count",
"in": "query",
"description": "a positive integer (default: 0)",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"in": "query",
"description": "the maximum number of items desired (default: 25, maximum: 100)",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "path",
"description": "the name of an existing wiki page",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "show",
"in": "query",
"description": "(optional) the string all",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "sr_detail",
"in": "query",
"description": "(optional) expand subreddits",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"wikiread"
]
}
]
}
},
"/wiki/settings/{page}": {
"get": {
"operationId": "GET_wiki_settings_page",
"summary": "Retrieve the current permission settings for page",
"description": "Retrieve the current permission settings for page",
"tags": [
"wiki"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "page",
"in": "path",
"description": "the name of an existing wiki page",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"modwiki"
]
}
]
},
"post": {
"operationId": "POST_wiki_settings_page",
"summary": "Update the permissions and visibility of wiki page",
"description": "Update the permissions and visibility of wiki page",
"tags": [
"wiki"
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
},
"parameters": [
{
"name": "page",
"in": "path",
"description": "the name of an existing wiki page",
"required": true,
"schema": {
"type": "string"
}
}
],
"security": [
{
"oauth2": [
"modwiki"
]
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"properties": {
"listed": {
"type": "boolean",
"description": "boolean value"
},
"permlevel": {
"type": "integer",
"description": "an integer"
},
"uh / X-Modhash header": {
"type": "string",
"description": "a modhash"
}
},
"required": [
"listed",
"permlevel",
"uh / X-Modhash header"
]
}
}
}
}
}
}
},
"components": {
"securitySchemes": {
"oauth2": {
"type": "oauth2",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://www.reddit.com/api/v1/authorize",
"tokenUrl": "https://www.reddit.com/api/v1/access_token",
"scopes": {
"account": "Access to account endpoints",
"announcements": "Access to announcements endpoints",
"any": "Access to any endpoints",
"edit": "Access to edit endpoints",
"flair": "Access to flair endpoints",
"history": "Access to history endpoints",
"identity": "Access to identity endpoints",
"livemanage": "Access to livemanage endpoints",
"modconfig": "Access to modconfig endpoints",
"modflair": "Access to modflair endpoints",
"modlog": "Access to modlog endpoints",
"modmail": "Access to modmail endpoints",
"modnote": "Access to modnote endpoints",
"modothers": "Access to modothers endpoints",
"modposts": "Access to modposts endpoints",
"modself": "Access to modself endpoints",
"modwiki": "Access to modwiki endpoints",
"mysubreddits": "Access to mysubreddits endpoints",
"privatemessages": "Access to privatemessages endpoints",
"read": "Access to read endpoints",
"report": "Access to report endpoints",
"save": "Access to save endpoints",
"structuredstyles": "Access to structuredstyles endpoints",
"submit": "Access to submit endpoints",
"subscribe": "Access to subscribe endpoints",
"vote": "Access to vote endpoints",
"wikiedit": "Access to wikiedit endpoints",
"wikiread": "Access to wikiread endpoints"
}
}
}
}
}
},
"tags": [
{
"name": "account",
"description": "Reddit account endpoints"
},
{
"name": "announcements",
"description": "Reddit announcements endpoints"
},
{
"name": "captcha",
"description": "Reddit captcha endpoints"
},
{
"name": "emoji",
"description": "Reddit emoji endpoints"
},
{
"name": "flair",
"description": "Reddit flair endpoints"
},
{
"name": "links & comments",
"description": "Reddit links & comments endpoints"
},
{
"name": "listings",
"description": "Reddit listings endpoints"
},
{
"name": "live threads",
"description": "Reddit live threads endpoints"
},
{
"name": "private messages",
"description": "Reddit private messages endpoints"
},
{
"name": "misc",
"description": "Reddit misc endpoints"
},
{
"name": "moderation",
"description": "Reddit moderation endpoints"
},
{
"name": "new modmail",
"description": "Reddit new modmail endpoints"
},
{
"name": "modnote",
"description": "Reddit modnote endpoints"
},
{
"name": "multis",
"description": "Reddit multis endpoints"
},
{
"name": "search",
"description": "Reddit search endpoints"
},
{
"name": "subreddits",
"description": "Reddit subreddits endpoints"
},
{
"name": "users",
"description": "Reddit users endpoints"
},
{
"name": "widgets",
"description": "Reddit widgets endpoints"
},
{
"name": "wiki",
"description": "Reddit wiki endpoints"
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment