API docs by Redocly

Read-it API (1.0.6)

Download OpenAPI specification:Download

API Documentation for all endpoints

Listing

Listing endpoints

Return the best posts based on [time, votes, comments, number of shares] (Here the token is optional if the user is logged in add a token if not don't add it)

Authorizations:
bearerAuth
query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "after": "string",
  • "before": "string",
  • "children": [
    ]
}

Return the hot posts based on [time, votes, comments] (Here the token is optional if the user is logged in add a token if not don't add it)

Authorizations:
bearerAuth
query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "after": "string",
  • "before": "string",
  • "children": [
    ]
}

Return the hot posts in a specific subreddit based on [time, votes, comments] (Here the token is optional if the user is logged in add a token if not don't add it)

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

The name of the subreddit

query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

flairId
string

Flair id to get all posts with that flair (optional)

Responses

Response samples

Content type
application/json
{
  • "after": "string",
  • "before": "string",
  • "children": [
    ]
}

Return the trending posts based on [views] (Here the token is optional if the user is logged in add a token if not don't add it)

Authorizations:
bearerAuth
query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "after": "string",
  • "before": "string",
  • "children": [
    ]
}

Return the trending posts in a specific subreddit based on [views] (Here the token is optional if the user is logged in add a token if not don't add it)

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

The name of the subreddit

query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

flairId
string

Flair id to get all posts with that flair (optional)

Responses

Response samples

Content type
application/json
{
  • "after": "string",
  • "before": "string",
  • "children": [
    ]
}

Return the new posts (Here the token is optional if the user is logged in add a token if not don't add it)

Authorizations:
bearerAuth
query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "after": "string",
  • "before": "string",
  • "children": [
    ]
}

Return the new posts in a specific subreddit (Here the token is optional if the user is logged in add a token if not don't add it)

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

The name of the subreddit

query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

flairId
string

Flair id to get all posts with that flair (optional)

Responses

Response samples

Content type
application/json
{
  • "after": "string",
  • "before": "string",
  • "children": [
    ]
}

Return the top posts based on [votes] (Here the token is optional if the user is logged in add a token if not don't add it)

Authorizations:
bearerAuth
query Parameters
time
string
Default: "all"
Enum: "hour" "day" "week" "month" "year" "all"

The time interval for the results

before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "after": "string",
  • "before": "string",
  • "children": [
    ]
}

Return the top posts in a specific subreddit based on [votes] (Here the token is optional if the user is logged in add a token if not don't add it)

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

The name of the subreddit

query Parameters
time
string
Default: "all"
Enum: "hour" "day" "week" "month" "year" "all"

The time interval for the results

before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

flairId
string

Flair id to get all posts with that flair (optional)

Responses

Response samples

Content type
application/json
{
  • "after": "string",
  • "before": "string",
  • "children": [
    ]
}

Login

Login and forget password endpoints used

Log in to the website

Request Body schema: application/json
username
required
string

Username

password
required
string

Password

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "username": "string",
  • "token": "string"
}

Forget password

Request Body schema: application/json
username
required
string

Username

email
required
string

Email

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Reset the password

path Parameters
id
required
string

User's id

token
required
string

The token created by the server to reset the password

Request Body schema: application/json
newPassword
required
string

New password

verifyPassword
required
string

New password again to verify

Responses

Request samples

Content type
application/json
{
  • "newPassword": "string",
  • "verifyPassword": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Forget username, used to send an email with the username inside it

Request Body schema: application/json
email
required
string

Email to send the username to

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Messages

Private messages

Send a message to a specific user with its subject

Authorizations:
bearerAuth
Request Body schema: application/json
text
required
string

Message Content as text

senderUsername
required
string

Username of the sender if it was user sent it as /u/username ad if it a subreddit send it as /r/subredditName

receiverUsername
required
string

Username of the receiver if it was user sent it as /u/username ad if it a subreddit send it as /r/subredditName

subject
required
string

Subject of the message

subredditName
string

name of the subreddit that you send or received the msg via

isReply
boolean

describes if the message is a reply or not

repliedMsgId
string

describes the name of the msg that this msg is a reply for

Responses

Request samples

Content type
application/json
{
  • "text": "string",
  • "senderUsername": "string",
  • "receiverUsername": "string",
  • "subject": "string",
  • "subredditName": "string",
  • "isReply": true,
  • "repliedMsgId": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Send a mention to a user

Authorizations:
bearerAuth
Request Body schema: application/json
postId
required
string

Id of the post that the mention is in

commentId
required
string

Id of the comment that the mention is in

receiverUsername
required
string

Username of the user that was mentioned

Responses

Request samples

Content type
application/json
{
  • "postId": "string",
  • "commentId": "string",
  • "receiverUsername": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Return a listing of messages that you sent sorted by time of sending the msg

Authorizations:
bearerAuth
query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Return a listing of all the messages,postreplies and mentions that you received sorted by time of sending them

Authorizations:
bearerAuth
query Parameters
before
string

The id of last item in the listing that follows before this page. null if there is no previous page Only one of after/before will be specified.

after
string

The id of last item in the listing that follows after this page. null if there is no next page Only one of after/before will be specified.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Return a listing of unread messages that you received sorted by time of sending the msg

Authorizations:
bearerAuth
query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Return a listing of post replies that you made sorted by time of adding the reply

Authorizations:
bearerAuth
query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Return a listing of mentions that you made sorted by time of adding the mention

Authorizations:
bearerAuth
query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Return a listing of all messages that was sent or received sorted by the time

Authorizations:
bearerAuth
query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Unread a Message

Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string

Full name of the message you want to unread it

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

spam a Message

Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string

Full name of the message you want to spam

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Mark all messages as read

Authorizations:
bearerAuth
Request Body schema: application/json
type
required
string
Enum: "Post Replies" "Messages" "Username Mentions"

Type of messages to mark as read

Responses

Request samples

Content type
application/json
{
  • "type": "Post Replies"
}

Posts and comments moderation

Posts and comments moderation endpoints

Approve a post or comment. for spam reports, approving means that this post / comment is not a spam.

Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string

id of a thing.

type
required
string

type of that thing (post, comment,..).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Remove a post or comment. for spam reports, removing means that this post / comment is a spam so it is removed.

Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string

id of a thing.

type
required
string

type of that thing (post, comment,..).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Lock a post or comment. Prevents a post or new child comments from receiving new comments.

Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string

id of a thing.

type
required
string

type of that thing (post, comment,..).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Unlock a post or comment. Allow a post or comment to receive new comments.

Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string

id of a thing.

type
required
string

type of that thing (post, comment,..).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Mark post or comment as spam for moderators

Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string

id of a thing.

type
required
string

type of that thing (post, comment)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Returns all post flairs of a subreddit (Here the token is optional if the user is logged in add a token if not don't add it)

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

Subreddit name

Responses

Response samples

Content type
application/json
{
  • "postFlairs": [
    ]
}

Add a new post flair to a given subreddit

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

Subreddit name

Request Body schema: application/json
flairName
required
string

Name of the flair

backgroundColor
string

Background color of the flair

textColor
string

Color of the flair name

required
object (FlairSettings)

Responses

Request samples

Content type
application/json
{
  • "flairName": "string",
  • "backgroundColor": "string",
  • "textColor": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "flairId": "string"
}

Returns details of a specific post flair (Here the token is optional if the user is logged in add a token if not don't add it)

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

Subreddit name

flairId
required
string

Post flair ID

Responses

Response samples

Content type
application/json
{
  • "flairId": "string",
  • "flairName": "string",
  • "backgroundColor": "string",
  • "flairOrder": 0,
  • "textColor": "string",
  • "settings": {
    }
}

Edit an existing post flair in a given subreddit

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

Subreddit name

flairId
required
string

id of a post flair

Request Body schema: application/json
flairName
required
string

Name of the flair

backgroundColor
string

Background color of the flair

textColor
string

Color of the flair name

required
object (FlairSettings)

Responses

Request samples

Content type
application/json
{
  • "flairName": "string",
  • "backgroundColor": "string",
  • "textColor": "string",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Delete an existing post flair in a given subreddit

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

Subreddit name

flairId
required
string

id of a post flair

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

Edit the order of all post flairs in a given subreddit

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

Subreddit name

Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "flairsOrder": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Get settings for post flairs in a given subreddit

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

Subreddit name

Responses

Response samples

Content type
application/json
{
  • "enablePostFlairs": true,
  • "allowUsers": true
}

Change the settings for post flairs in a community

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

Subreddit name

Request Body schema: application/json
enablePostFlairs
boolean

Indicates whether this community enabled flairs on posts or not

allowUsers
boolean

This will let users select, edit, and clear post flair for their posts in this community.

Responses

Request samples

Content type
application/json
{
  • "enablePostFlairs": true,
  • "allowUsers": true
}

Response samples

Content type
application/json
{
  • "error": "string"
}

General moderation

General moderation endpoints

Accept an invite to moderate the specified subreddit. The authenticated user must have been invited to moderate the subreddit by one of its current moderators or the admin.

Authorizations:
bearerAuth
Request Body schema: application/json
subreddit
required
string

The name of the subreddit.

Responses

Request samples

Content type
application/json
{
  • "subreddit": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Send a moderation invite to a user. Or edit the permissions of a moderator of a subreddit.

Authorizations:
bearerAuth
Request Body schema: application/json
username
required
string

Username of the user to send the invitation to.

subreddit
required
string

The name of the subreddit.

permissionToEverything
required
boolean

True if user can have full access in that subreddit

permissionToManageUsers
required
boolean

True if user can access mod notes, ban and mute users, and approve submitters

permissionToManageSettings
required
boolean

True if user can manage community settings, appearance, emojis, rules, and AutoMod

permissionToManageFlair
required
boolean

True if user can create and manage user and post flair

permissionToManagePostsComments
required
boolean

True if user can access queues, take action on content, and manage collections and events

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "subreddit": "string",
  • "permissionToEverything": true,
  • "permissionToManageUsers": true,
  • "permissionToManageSettings": true,
  • "permissionToManageFlair": true,
  • "permissionToManagePostsComments": true
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Cancel the invitation that was sent to a user

Authorizations:
bearerAuth
Request Body schema: application/json
username
required
string

Username of the user to send the invitation to.

subreddit
required
string

The name of the subreddit.

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "subreddit": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Abdicate moderator status in a subreddit.

Authorizations:
bearerAuth
Request Body schema: application/json
subreddit
required
string

name of the subreddit to leave it's moderation.

Responses

Request samples

Content type
application/json
{
  • "subreddit": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Subreddit moderation

Subreddit Moderation endpoints

Return a listing of required items relevant to moderators with things that have been marked as spam in that subreddit. (This endpoint is a listing)

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

query Parameters
after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

limit
integer <= 100
Default: 25

the maximum number of items desired (default 25, maximum 100)

only
required
string
Enum: "posts" "comments"

type of things to be returned

sort
string
Default: "newestfirst"
Enum: "new" "old"

method of sorting the returned things

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Return a listing of required items relevant to moderators with things that have been marked as spam in that subreddit. (This endpoint is a listing)

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

query Parameters
after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

limit
integer <= 100
Default: 25

the maximum number of items desired (default 25, maximum 100)

only
required
string
Enum: "posts" "comments"

type of things to be returned

sort
string
Default: "newestfirst"
Enum: "new" "old"

method of sorting the returned things

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Return a listing of required items relevant to moderators with things that have been edited recently in that subreddit. (This endpoint is a listing)

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

query Parameters
after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

limit
integer <= 100
Default: 25

the maximum number of items desired (default 25, maximum 100)

only
required
string
Enum: "posts" "comments"

type of things to be returned

sort
string
Default: "newestfirst"
Enum: "new" "old"

method of sorting the returned things

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Return a listing of required items relevant to moderators with things that have been edited in that subreddit. (This endpoint is a listing)

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

query Parameters
after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

limit
integer <= 100
Default: 25

the maximum number of items desired (default 25, maximum 100)

only
required
string
Enum: "posts" "comments"

type of things to be returned

sort
string
Default: "newestfirst"
Enum: "new" "old"

method of sorting the returned things

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Return a listing of required items relevant to moderators with things that have yet to be approved/removed by a mod in that subreddit. (This endpoint is a listing)

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

query Parameters
after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

limit
integer <= 100
Default: 25

the maximum number of items desired (default 25, maximum 100)

sort
string
Default: "newestfirst"
Enum: "new" "old"

method of sorting the returned things

show
string

optional parameter; if all is passed, filters such as "hide links that I have voted on" will be disabled.

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Ban a user from a subreddit or edit a banned user in that subreddit. Banned users can't post or comment on that subreddit.

Authorizations:
bearerAuth
Request Body schema: application/json
username
required
string

Username of the user to be banned

subreddit
required
string

The name of the subreddit.

banPeriod
integer

The period that user will be banned in days if not permanent. (default Permanent)

reasonForBan
required
string

The reason for banning that user.

modNote
string

Note on that ban

noteInclude
string

Note to include in ban message

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "subreddit": "string",
  • "banPeriod": 0,
  • "reasonForBan": "string",
  • "modNote": "string",
  • "noteInclude": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Remove a ban from a user.

Authorizations:
bearerAuth
Request Body schema: application/json
username
required
string

Username of the user to be banned

subreddit
required
string

The name of the subreddit.

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "subreddit": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Return a listing relevant to moderators in that subreddit with banned users. (This endpoint is a listing)

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

query Parameters
after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

limit
integer <= 100
Default: 25

the maximum number of items desired (default 25, maximum 100)

show
string

optional parameter; if all is passed, filters such as "hide links that I have voted on" will be disabled.

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Get the suggested topics for a subreddit.

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

Responses

Response samples

Content type
application/json
{
  • "communityTopics": [
    ]
}

Approve a user in a subreddit

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

Request Body schema: application/json
username
required
string

Username of the user to be approved

Responses

Request samples

Content type
application/json
{
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Mute a user in the subreddit

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

Request Body schema: application/json
username
required
string

Username of the user to be muted

muteReason
string

Reason to why this user was muted

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "muteReason": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Remove a user from the list of approved users in a subreddit

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

Request Body schema: application/json
username
required
string

Username of the user to be removed

Responses

Request samples

Content type
application/json
{
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Remove a user from the list of muted users in the subreddit

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

Request Body schema: application/json
username
required
string

Username of the user to be unmuted

Responses

Request samples

Content type
application/json
{
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Get the current community settings of a subreddit.

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

Responses

Response samples

Content type
application/json
{
  • "communityName": "string",
  • "mainTopic": "string",
  • "subTopics": [
    ],
  • "communityDescription": "string",
  • "sendWelcomeMessage": true,
  • "welcomeMessage": "string",
  • "language": "string",
  • "region": "string",
  • "type": "Public",
  • "NSFW": true,
  • "acceptingRequestsToJoin": true,
  • "acceptingRequestsToPost": true,
  • "approvedUsersHaveTheAbilityTo": "Post only"
}

Set the community settings of a subreddit.

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

Request Body schema: application/json
communityName
required
string

The name of the community.

mainTopic
required
string

The main topic of the community.

subTopics
required
Array of strings

The sub topics of the community.

communityDescription
required
string

The description of the community. (maximum 500 Characters)

sendWelcomeMessage
required
boolean

If that community send a welcome message to the new members or not.

welcomeMessage
required
string

The welcome message of the community. (if sendWelcomeMessage is true) (maximum 5000 Characters)

language
required
string

The janguage of the community.

Region
string

The region of the community.

Type
required
string
Enum: "Public" "Restricted" "Private"

The type of the community.

NSFW
required
boolean

The community allow +18 content or not.

acceptingRequestsToJoin
required
boolean

Display a button on your private subreddit that allows users to request to join. (if the type is private only)

acceptingRequestsToPost
required
boolean

Accept posts or not (if the type is restricted only)

approvedUsersHaveTheAbilityTo
required
string
Enum: "Post only" "Comment only" "Post & Comment"

Approved users have the ability to (if the type is restricted only)

Responses

Request samples

Content type
application/json
{
  • "communityName": "string",
  • "mainTopic": "string",
  • "subTopics": [
    ],
  • "communityDescription": "string",
  • "sendWelcomeMessage": true,
  • "welcomeMessage": "string",
  • "language": "string",
  • "Region": "string",
  • "Type": "Public",
  • "NSFW": true,
  • "acceptingRequestsToJoin": true,
  • "acceptingRequestsToPost": true,
  • "approvedUsersHaveTheAbilityTo": "Post only"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Get the posts and comments settings of a subreddit.

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

Responses

Response samples

Content type
application/json
{
  • "enableSpoiler": true,
  • "allowImagesInComment": true,
  • "suggestedSort": "none"
}

Set the posts and comments settings of a subreddit.

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

Request Body schema: application/json
enableSpoiler
required
boolean

Enable spoiler tag in posts or not

allowImagesInComment
required
boolean

Allow images on comment or not

suggestedSort
required
string
Enum: "none" "best" "top" "new" "old"

The sugggested sort for comment in that community

Responses

Request samples

Content type
application/json
{
  • "enableSpoiler": true,
  • "allowImagesInComment": true,
  • "suggestedSort": "none"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Return the traffic stats of members for a certain subreddit

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

Responses

Response samples

Content type
application/json
{
  • "numberOfJoinedLastDay": 0,
  • "numberOfJoinedLastWeek": 0,
  • "numberOfJoinedLastMonth": 0,
  • "numberOfLeftLastDay": 0,
  • "numberOfLeftLastWeek": 0,
  • "numberOfLeftLastMonth": 0,
  • "days": [
    ],
  • "weeks": [
    ],
  • "months": [
    ]
}

Add a rule to subreddit.

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

Request Body schema: application/json
ruleName
required
string

The name of the rule.

appliesTo
required
string
Enum: "posts and comments" "posts only" "comments only"

Where to apply the rule

reportReason
string

The reason of the report. (maximum 100 charachter)

description
string

The full description of the report. (maximum 500 charachter)

Responses

Request samples

Content type
application/json
{
  • "ruleName": "string",
  • "appliesTo": "posts and comments",
  • "reportReason": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "ruleId": "string"
}

Get the rules for a subreddit. (Here the token is optional if the user is logged in add a token if not don't add it)

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

Responses

Response samples

Content type
application/json
{
  • "rules": [
    ]
}

Edit a rule at subreddit.

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

ruleId
required
string

id of the rule.

Request Body schema: application/json
ruleName
required
string

The name of the rule.

ruleOrder
required
integer

Order of the rule (add it as it is.. don't edit it.. if you want to edit it use the /r/{subreddit}/about/rules-order endpoint to edit the rules order)

appliesTo
required
string
Enum: "posts and comments" "posts only" "comments only"

Where to apply the rule

reportReason
string

The reason of the report. (maximum 100 charachter)

description
string

The full description of the report. (maximum 500 charachter)

Responses

Request samples

Content type
application/json
{
  • "ruleName": "string",
  • "ruleOrder": 0,
  • "appliesTo": "posts and comments",
  • "reportReason": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Delete a rule at subreddit.

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

ruleId
required
string

id of the rule.

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

Edit rules order of the subreddit.

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

Request Body schema: application/json
required
Array of objects

The order of the rules.

Responses

Request samples

Content type
application/json
{
  • "rulesOrder": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Notifications

Notifications that sent to each user about an occurred event

get all the notifications sent to the user

Authorizations:
bearerAuth
query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "unreadCount": 0,
  • "children": [
    ]
}

mark all the notifications as read

Authorizations:
bearerAuth

Responses

mark a notification as read

Authorizations:
bearerAuth

Responses

mark a specific notification as hidden

Authorizations:
bearerAuth

Responses

subscribe to notifications with the client token from firebase (after the login directly)

Authorizations:
bearerAuth
Request Body schema: application/json
type
required
string
Enum: "web" "flutter"

web or flutter

accessToken
required
string

the access token from firebase

Responses

Request samples

Content type
application/json
{
  • "type": "web",
  • "accessToken": "string"
}

unsubscribe from notifications (with signout)

Authorizations:
bearerAuth
Request Body schema: application/json
type
required
string
Enum: "web" "flutter"

web or flutter

Responses

Request samples

Content type
application/json
{
  • "type": "web"
}

Threads

Containers that help us to send notifications

Sign Up

Sign Up and email verfication endpoints

Create a new account to the user

Request Body schema: application/json
email
required
string

Email of the user

username
required
string

Username

password
required
string

Password

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "username": "string",
  • "token": "string"
}

Check if the username is used before

query Parameters
username
required
string

Username to check

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

Check if the email is used before

query Parameters
email
required
string

Email to check

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

Verify the email

path Parameters
id
required
string

User's id

token
required
string

The token created by the server to verify the email

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

Sign up and Login with google or facebook

path Parameters
type
required
string
Enum: "google" "facebook"

Type of sign up

Request Body schema: application/json
accessToken
required
string

Access token from the response of google or facebook

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string"
}

Response samples

Content type
application/json
{
  • "username": "string",
  • "token": "string"
}

Get an available random username used to create a new account

query Parameters
count
required
number

number of random usernames you want to get

Responses

Response samples

Content type
application/json
{
  • "usernames": [
    ]
}

Edit the username of the user [can be used only once after signing up with google or facebook]

Request Body schema: application/json
username
required
string

New available username

Responses

Request samples

Content type
application/json
{
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Subreddit

Subreddit endpoints

Return a listing of all the Communities

Authorizations:
bearerAuth
query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Return a listing of communities of a specific category

Authorizations:
bearerAuth
path Parameters
categoryName
string

the category of subreddits

query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Returns the top 5 subreddits of 2 random categories

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "first": {
    },
  • "second": {
    }
}

Return a listing of the mostly viewed communities

Authorizations:
bearerAuth
query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Return two random categories to display

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "firstCategory": "string",
  • "secondCategory": "string",
  • "firstCategoryChildren": [
    ],
  • "secondCategoryChildren": [
    ]
}

Return all the details of the subreddit (Here the token is optional if the user is logged in add a token if not don't add it)

Authorizations:
bearerAuth
path Parameters
subreddit
string

the name of the subreddit

Responses

Response samples

Content type
application/json
{
  • "nsfw": true,
  • "type": "private",
  • "subredditId": "string",
  • "isFavorite": true,
  • "title": "string",
  • "nickname": "string",
  • "isModerator": true,
  • "category": "string",
  • "members": 0,
  • "description": "string",
  • "dateOfCreation": "string",
  • "isMember": true,
  • "banner": "string",
  • "picture": "string",
  • "views": 0,
  • "mainTopic": "string",
  • "subtopics": [
    ]
}

add a subreddit to the users favorite subreddits

Authorizations:
bearerAuth
path Parameters
subreddit
string

the name of the subreddit

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

remove a subreddit from the user's favorites subreddits

Authorizations:
bearerAuth
path Parameters
subreddit
string

the name of the subreddit

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

Add profile picture for a subreddit

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

Request Body schema: application/json
avatar
required
object

The avatar image

Responses

Request samples

Content type
application/json
{
  • "avatar": { }
}

Response samples

Content type
application/json
{
  • "path": "string"
}

Delete the profile picture in a subreddit

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

Responses

Add a banner to a subreddit

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

Request Body schema: application/json
banner
required
object

The banner image

Responses

Request samples

Content type
application/json
{
  • "banner": { }
}

Response samples

Content type
application/json
{
  • "path": "string"
}

Delete the banner image in a subreddit

Authorizations:
bearerAuth
path Parameters
subreddit
required
string

name of the subreddit.

Responses

Create a new subreddit

Authorizations:
bearerAuth
Request Body schema: application/json
subredditName
required
string

Subreddit name

type
required
string
Enum: "Public" "Restricted" "Private"

Subreddit type

nsfw
required
boolean

If true, this subreddit will be NSFW

category
required
string

The category of that subreddit

Responses

Request samples

Content type
application/json
{
  • "subredditName": "string",
  • "type": "Public",
  • "nsfw": true,
  • "category": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

join a subreddit

Authorizations:
bearerAuth
Request Body schema: application/json
subredditId
required
string

Id of the subreddit

message
string

the sent message from the user in case the subreddit is private

Responses

Request samples

Content type
application/json
{
  • "subredditId": "string",
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Leave a subreddit

Authorizations:
bearerAuth
Request Body schema: application/json
subredditName
required
string

Subreddit name

Responses

Request samples

Content type
application/json
{
  • "subredditName": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Check if the username is used before

query Parameters
subredditName
required
string

Subreddit's name to check

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

add description of the community

Authorizations:
bearerAuth
path Parameters
subreddit
string

the name of the subreddit

Request Body schema: application/json
description
string

description of the community (maximum 300)

Responses

Request samples

Content type
application/json
{
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

add the main topic to the community

Authorizations:
bearerAuth
path Parameters
subreddit
string

the name of the subreddit

Request Body schema: application/json
title
required
string

title of the main topic in the community

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

add subtopics to the community

Authorizations:
bearerAuth
path Parameters
subreddit
string

the name of the subreddit

Request Body schema: application/json
title
required
Array of strings

titles of the sub topics in the community

Responses

Request samples

Content type
application/json
{
  • "title": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Return a listing of moderators in that specified subreddit

Authorizations:
bearerAuth
path Parameters
subreddit
string

the name of the subreddit

query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Return a listing of approved users in that specified subreddit

Authorizations:
bearerAuth
path Parameters
subreddit
string

the name of the subreddit

query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Return a listing of muted users in that specified subreddit

Authorizations:
bearerAuth
path Parameters
subreddit
string

the name of the subreddit

query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Return a listing of the invited moderators in that specified subreddit

Authorizations:
bearerAuth
path Parameters
subreddit
string

the name of the subreddit

query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Return all subreddits that you are moderator in ( usecase to send message from )

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "children": [
    ]
}

Return all subreddits that you are member in ( usecase to post in )

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "children": [
    ]
}

Return all subreddits that you marked as favorite

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "children": [
    ]
}

Posts

Only post-related actions

Blur the content of the post and unblur when opening it

Authorizations:
bearerAuth
Request Body schema: application/json
id
string

id of a post

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Remove ability to blur the content of the post

Authorizations:
bearerAuth
Request Body schema: application/json
id
string

id of a post

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Mark a post NSFW (Not Safe For Work)

Authorizations:
bearerAuth
Request Body schema: application/json
id
string

id of a post

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Remove the NSFW marking from a post

Authorizations:
bearerAuth
Request Body schema: application/json
id
string

id of a post

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

returns the user that made a comment in a specific post

Authorizations:
bearerAuth
query Parameters
id
required
string

id of the post

Responses

Response samples

Content type
application/json
{
  • "usernames": [
    ]
}

Follow or unfollow a post.

Authorizations:
bearerAuth
Request Body schema: application/json
follow
boolean

True to follow or False to unfollow

id
string

id of a post

Responses

Request samples

Content type
application/json
{
  • "follow": true,
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Hide a post (This removes it from the user's default view of subreddit listings)

Authorizations:
bearerAuth
Request Body schema: application/json
id
string

id of a post

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Set suggested sort for a post comments

Authorizations:
bearerAuth
Request Body schema: application/json
id
string

id of a post

sort
string
Enum: "top" "new" "best" "old"

sort kind

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "sort": "top"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Reset the suggested sort for a post back to default

Authorizations:
bearerAuth
Request Body schema: application/json
id
string

id of a post

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Submit or share a post to a subreddit. The request body could be json in case the kind is not image/video, else it has to be FormData with image files placed in an array "images" as well as imageCaptions and imageLinks and video placed in "video". The kind can also be 'post' in case of sharing a post because it's content will be another post basically and the id of the post being shared is given in the 'sharePostId' field. A hybrid kind means that it can contain text, links, images and videos.

Authorizations:
bearerAuth
Request Body schema: application/json
title
required
string

Post title

kind
required
string
Enum: "link" "hybrid" "image" "video" "post"
subreddit
string

Subreddit name

inSubreddit
required
boolean

True if the post is submitted in a subreddit, False if it's in the user account (not a subreddit)

content
object

Object received directly from the WYSIWYG tool

images
Array of objects

image files

imageCaptions
Array of strings

Image captions of each image submitted and an element in it should be null if the image doesn't have a caption (Do not skip the element)

imageLinks
Array of strings

Links written for the images submitted (only when kind = images)

video
object

Video file in case the kind is 'video'

link
string

Link submission in case the kind is 'link'

nsfw
boolean

Not Safe for Work

spoiler
boolean

Blur the content of the post

flairId
string

Flair ID

sendReplies
boolean

Allow post reply notifications

sharePostId
string

id of a post (given in case of sharing a post)

scheduleDate
string <date>

Date for the post submitted at in case of scheduling it

scheduleTime
string <time>

Time required for the post to be submitted at in case of scheduling it

scheduleTimeZone
string <time_zone>

Time zone chosen when scheduling a post

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "kind": "link",
  • "subreddit": "string",
  • "inSubreddit": true,
  • "content": { },
  • "images": [
    ],
  • "imageCaptions": [
    ],
  • "imageLinks": [
    ],
  • "video": { },
  • "link": "string",
  • "nsfw": true,
  • "spoiler": true,
  • "flairId": "string",
  • "sendReplies": true,
  • "sharePostId": "string",
  • "scheduleDate": "2019-08-24",
  • "scheduleTime": "14:15:22Z",
  • "scheduleTimeZone": "string"
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Edit a post (available only for the posts of hyprid type and only edit the content)

Authorizations:
bearerAuth
Request Body schema: application/json
content
required
string

Object received directly from the WYSIWYG tool

postId
required
string

the id of the post

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "postId": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Unhide a post

Authorizations:
bearerAuth
Request Body schema: application/json
id
string

id of a post

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Get the insights on a post

Authorizations:
bearerAuth
query Parameters
id
required
string

id of the post

Responses

Response samples

Content type
application/json
{
  • "totalViews": 0,
  • "upvoteRate": 0,
  • "communityKarma": 0,
  • "totalShares": 0
}

Get details about a specific post (Here the token is optional if the user is logged in add a token if not don't add it)

Authorizations:
bearerAuth
query Parameters
id
required
string

id of the post

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "kind": "link",
  • "title": "string",
  • "subreddit": "string",
  • "link": "string",
  • "images": [
    ],
  • "video": "string",
  • "content": { },
  • "nsfw": true,
  • "spoiler": true,
  • "sharePostId": "string",
  • "flair": {
    },
  • "comments": 0,
  • "votes": 0,
  • "postedAt": "string",
  • "sendReplies": true,
  • "markedSpam": true,
  • "suggestedSort": "string",
  • "editedAt": "string",
  • "postedBy": "string",
  • "votingType": 1,
  • "saved": false,
  • "followed": false,
  • "hidden": false,
  • "spammed": false,
  • "inYourSubreddit": false,
  • "moderation": {
    }
}

Pin or unpin a post

Authorizations:
bearerAuth
Request Body schema: application/json
id
string

id of a post

pin
boolean

True for pin and False for unpin

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "pin": true
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Returns all posts pinned by the user (Token is optional)

Authorizations:
bearerAuth
query Parameters
username
string

Username of the user to get pinned posts

Responses

Response samples

Content type
application/json
{
  • "pinnedPosts": [
    ]
}

Categories

All the different categories for communities

Get a list of all categories

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "categories": [
    ]
}

Comments

Comments and replies on a post

Follow a comment.

Authorizations:
bearerAuth
Request Body schema: application/json
commentId
string

id of a comment

Responses

Request samples

Content type
application/json
{
  • "commentId": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Unfollow a comment.

Authorizations:
bearerAuth
Request Body schema: application/json
commentId
string

id of a comment

Responses

Request samples

Content type
application/json
{
  • "commentId": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Create a new comment to a post or another comment

Authorizations:
bearerAuth
Request Body schema: application/json
content
object

Comment content

postId
string

id of the post that will contain the comment

parentId
string

id of the thing being replied to (parent)

parentType
string
Enum: "post" "comment"

Comment is a reply to post or comment

level
number

Level of the comment (How deep is it in the comment tree) [min = 1]

subredditName
string

Subreddit that contain the post

haveSubreddit
boolean

If true, then the post is in a subreddit

Responses

Request samples

Content type
application/json
{
  • "content": { },
  • "postId": "string",
  • "parentId": "string",
  • "parentType": "post",
  • "level": 0,
  • "subredditName": "string",
  • "haveSubreddit": true
}

Response samples

Content type
application/json
{
  • "id": "string"
}

Get the comment tree for a given post (Here the token is optional if the user is logged in add a token if not don't add it)

Authorizations:
bearerAuth
path Parameters
postId
required
string

The post id

query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of comments to return (optional)

sort
string
Default: "best"
Enum: "best" "top" "new" "old"

Comments sorting algorithm

Responses

Response samples

Content type
application/json
{
  • "after": "string",
  • "before": "string",
  • "children": [
    ]
}

Return comment tree of a specific comment (Here the token is optional if the user is logged in add a token if not don't add it)

Authorizations:
bearerAuth
path Parameters
postId
required
string

The post id

commentId
required
string

The comment id to show its tree

query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of comments to return (optional)

sort
string
Default: "best"
Enum: "best" "top" "new" "old"

Comments sorting algorithm

Responses

Response samples

Content type
application/json
{
  • "after": "string",
  • "before": "string",
  • "children": [
    ]
}

Post-comment actions

User actions that are allowed on a comment or a post

Edit the body text of a comment

Authorizations:
bearerAuth
Request Body schema: application/json
content
Object

New content entered

id
string

id of the comment being edited

Responses

Request samples

Content type
application/json
{
  • "content": null,
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Save a post or comment

Authorizations:
bearerAuth
Request Body schema: application/json
id
string

id of a thing

type
string
Enum: "post" "comment"

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "type": "post"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Enable or disable inbox replies for a Post or comment

Authorizations:
bearerAuth
Request Body schema: application/json
id
string

id of a thing created by the user

type
string
Enum: "post" "comment"
state
boolean

True for enabling replies and false for disabling it

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "type": "post",
  • "state": true
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Unsave a Post or comment (This removes the thing from the user's saved listings)

Authorizations:
bearerAuth
Request Body schema: application/json
id
string

id of a thing

type
string
Enum: "post" "comment"

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "type": "post"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Vote on a post or comment

Authorizations:
bearerAuth
Request Body schema: application/json
id
string

id of a thing

type
string
Enum: "post" "comment"
direction
number

Vote direction.. 1 for upvote and -1 for downvote

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "type": "post",
  • "direction": 0
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Post-comment-message actions

User actions that are allowed on a comment, post or message

Delete a Post, Comment or Message

Authorizations:
bearerAuth
Request Body schema: application/json
id
string

id of a thing created by the user

type
string
Enum: "post" "comment" "message"

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "type": "post"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Mark a post, comment or message as spam

Authorizations:
bearerAuth
Request Body schema: application/json
id
string

id of a thing created by the user

type
string
Enum: "post" "comment" "message"
reason
string

Reason for why the user marked this thing as spam

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "type": "post",
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Unmark a post as spam

Authorizations:
bearerAuth
Request Body schema: application/json
id
string

id of a thing created by the user

type
string
Enum: "post" "comment" "message"

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "type": "post"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Search

Search for anything in any place

General search in the posts tab

query Parameters
q
required
string

Search query entered

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

limit
number
Default: 25

The maximum number of items desired (Maximum 100)

type
string
Default: "post"
Enum: "subreddit" "user" "comment" "post"

Thing being searched for

sort
string
Default: "new"
Enum: "hot" "top" "new" "best" "most comments" "trending"

Type of sort applied on the results

category
string

Search in a specific category

time
string
Default: "all"
Enum: "hour" "day" "week" "month" "year" "all"

Search within a time frame

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

General search in the comments tab

query Parameters
q
required
string

Search query entered

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

limit
number
Default: 25

The maximum number of items desired (Maximum 100)

type
string
Default: "post"
Enum: "subreddit" "user" "comment" "post"

Thing being searched for

sort
string
Default: "new"
Enum: "hot" "top" "new" "best" "most comments" "trending"

Type of sort applied on the results

category
string

Search in a specific category

time
string
Default: "all"
Enum: "hour" "day" "week" "month" "year" "all"

Search within a time frame

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

General search for a subreddit (An OPTIONAL TOKEN is sent in case there is a logged in user & this is for all search endpoints)

query Parameters
q
required
string

Search query entered

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

limit
number
Default: 25

The maximum number of items desired (Maximum 100)

type
string
Default: "post"
Enum: "subreddit" "user" "comment" "post"

Thing being searched for

sort
string
Default: "new"
Enum: "hot" "top" "new" "best" "most comments" "trending"

Type of sort applied on the results

category
string

Search in a specific category

restrictedSubreddits
boolean

Search in restricted subreddits only

time
string
Default: "all"
Enum: "hour" "day" "week" "month" "year" "all"

Search within a time frame

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

General search for a user

query Parameters
q
required
string

Search query entered

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

limit
number
Default: 25

The maximum number of items desired (Maximum 100)

type
string
Default: "post"
Enum: "subreddit" "user" "comment" "post"

Thing being searched for

sort
string
Default: "new"
Enum: "hot" "top" "new" "best" "most comments" "trending"

Type of sort applied on the results

category
string

Search in a specific category

time
string
Default: "all"
Enum: "hour" "day" "week" "month" "year" "all"

Search within a time frame

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Search in a specific subreddit for posts

path Parameters
subreddit
required
string

Subreddit name

query Parameters
q
required
string

Search query entered

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

limit
number
Default: 25

The maximum number of items desired (Maximum 100)

type
string
Default: "post"
Enum: "post" "comment"

Thing being searched for

sort
string
Default: "new"
Enum: "hot" "top" "new" "best" "most comments" "trending"

Type of sort applied on the results

category
string

Search in a specific category

time
string
Default: "all"
Enum: "hour" "day" "week" "month" "year" "all"

Search within a time frame

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Search in a specific subreddit for comments

path Parameters
subreddit
required
string

Subreddit name

query Parameters
q
required
string

Search query entered

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

limit
number
Default: 25

The maximum number of items desired (Maximum 100)

type
string
Default: "post"
Enum: "post" "comment"

Thing being searched for

sort
string
Default: "new"
Enum: "hot" "top" "new" "best" "most comments" "trending"

Type of sort applied on the results

category
string

Search in a specific category

time
string
Default: "all"
Enum: "hour" "day" "week" "month" "year" "all"

Search within a time frame

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

User

User's profile endpoints (overview, history, ...etc)

Block or unblock a user

Authorizations:
bearerAuth
Request Body schema: application/json
block
required
boolean

True to block the user, false to unblock the user

username
required
string

Username of the user to block

Responses

Request samples

Content type
application/json
{
  • "block": true,
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Follow or unfollow a user

Authorizations:
bearerAuth
Request Body schema: application/json
follow
required
boolean

True to follow the user, false to unfollow the user

username
required
string

Username of the user to follow

Responses

Request samples

Content type
application/json
{
  • "follow": true,
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Return information about the user (Here the token is optional if the user is logged in add a token if not don't add it)

path Parameters
username
required
string

The username of the user to get

Responses

Response samples

Content type
application/json
{
  • "displayName": "string",
  • "about": "string",
  • "banner": "string",
  • "picture": "string",
  • "karma": 0,
  • "cakeDate": "2019-08-24",
  • "socialLinks": [
    ],
  • "nsfw": true,
  • "followed": true,
  • "blocked": true,
  • "moderatorOf": [
    ]
}

Return a list of user's activity [posts, comments]

path Parameters
username
required
string

The username of the user to get

query Parameters
sort
string
Default: "new"
Enum: "new" "hot" "top"

The sorting algorithm used

time
string
Default: "all"
Enum: "hour" "day" "week" "month" "year" "all"

The time interval for the results (used with top only)

before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Return a list of user's posts

path Parameters
username
required
string

The username of the user to get

query Parameters
sort
string
Default: "new"
Enum: "new" "hot" "top"

The sorting algorithm used

time
string
Default: "all"
Enum: "hour" "day" "week" "month" "year" "all"

The time interval for the results (used with top only)

before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "after": "string",
  • "before": "string",
  • "children": [
    ]
}

Return a list of user's history (recent clicked posts)

Authorizations:
bearerAuth
path Parameters
username
required
string

The username of the user to get

query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "after": "string",
  • "before": "string",
  • "children": [
    ]
}

Clear the history of the user

Authorizations:
bearerAuth
Request Body schema: application/json
username
required
string

Username of the user to clear his history

Responses

Request samples

Content type
application/json
{
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Return a list of user's comments

path Parameters
username
required
string

The username of the user to get

query Parameters
sort
string
Default: "new"
Enum: "new" "hot" "top"

The sorting algorithm used

time
string
Default: "all"
Enum: "hour" "day" "week" "month" "year" "all"

The time interval for the results (used with top only)

before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Return a list of user's upvoted posts

Authorizations:
bearerAuth
path Parameters
username
required
string

The username of the user to get

query Parameters
sort
string
Default: "new"
Enum: "new" "hot" "top"

The sorting algorithm used

time
string
Default: "all"
Enum: "hour" "day" "week" "month" "year" "all"

The time interval for the results (used with top only)

before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "after": "string",
  • "before": "string",
  • "children": [
    ]
}

Return a list of user's downvoted posts

Authorizations:
bearerAuth
path Parameters
username
required
string

The username of the user to get

query Parameters
sort
string
Default: "new"
Enum: "new" "hot" "top"

The sorting algorithm used

time
string
Default: "all"
Enum: "hour" "day" "week" "month" "year" "all"

The time interval for the results (used with top only)

before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "after": "string",
  • "before": "string",
  • "children": [
    ]
}

Return a list of user's saved [posts, comments]

Authorizations:
bearerAuth
path Parameters
username
required
string

The username of the user to get

query Parameters
sort
string
Default: "new"
Enum: "new" "hot" "top"

The sorting algorithm used

time
string
Default: "all"
Enum: "hour" "day" "week" "month" "year" "all"

The time interval for the results (used with top only)

before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}

Return a list of user's hidden posts

Authorizations:
bearerAuth
path Parameters
username
required
string

The username of the user to get

query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "after": "string",
  • "before": "string",
  • "children": [
    ]
}

Return the details of the user

Authorizations:
bearerAuth
path Parameters
username
required
string

The username of the user to get details

Responses

Response samples

Content type
application/json
{
  • "karma": "string",
  • "joinDate": "2019-08-24T14:15:22Z"
}

Return the followed users

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "children": [
    ]
}

User settings

User settings endpoints

Return the preference settings of the logged in user

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "email": "string",
  • "googleEmail": "string",
  • "facebookEmail": "string",
  • "country": "string",
  • "gender": "string",
  • "displayName": "string",
  • "about": "string",
  • "socialLinks": [
    ],
  • "havePassword": true,
  • "hasVerifiedEmail": true,
  • "nsfw": true,
  • "allowToFollowYou": true,
  • "adultContent": true,
  • "autoplayMedia": true,
  • "newFollowerEmail": true,
  • "unsubscribeFromEmails": true
}

Change the settings of the logged in user [can send any of the properties]

Authorizations:
bearerAuth
Request Body schema: application/json
country
string

The new country

gender
string

The new gender

displayName
string

The new display name

about
string

The brief description of the user

havePassword
boolean

User to know if the user have a password or not

nsfw
boolean

This content is NSFW or not

allowToFollowYou
boolean

If true, Other users can follow you

adultContent
boolean

If true, View adult and NSFW (not safe for work) content in your feed and search results

autoplayMedia
boolean

If true, Play videos and gifs automatically when in the viewport

newFollowerEmail
boolean

If true, Send an email when a user follows you

unsubscribeFromEmails
boolean

If true, Don't send any emails

Responses

Request samples

Content type
application/json
{
  • "country": "string",
  • "gender": "string",
  • "displayName": "string",
  • "about": "string",
  • "havePassword": true,
  • "nsfw": true,
  • "allowToFollowYou": true,
  • "adultContent": true,
  • "autoplayMedia": true,
  • "newFollowerEmail": true,
  • "unsubscribeFromEmails": true
}

Connect the account with google or facebook for fast login

Authorizations:
bearerAuth
path Parameters
type
required
string
Enum: "google" "facebook"

Type of connect

Request Body schema: application/json
accessToken
required
string

Access token from the response of google or facebook

password
required
string

Password entered for verification

Responses

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Disconnect google or facebook account

Authorizations:
bearerAuth
path Parameters
type
required
string
Enum: "google" "facebook"

Type of disconnect

Request Body schema: application/json
password
required
string

Password entered for verification

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Change the email of the logged in user

Authorizations:
bearerAuth
Request Body schema: application/json
currentPassword
required
string

The current password

newEmail
required
string

The new email

Responses

Request samples

Content type
application/json
{
  • "currentPassword": "string",
  • "newEmail": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Change the password of the logged in user

Authorizations:
bearerAuth
Request Body schema: application/json
currentPassword
required
string

The current password

newPassword
required
string

The new password

confirmNewPassword
required
string

Confirm the new password

Responses

Request samples

Content type
application/json
{
  • "currentPassword": "string",
  • "newPassword": "string",
  • "confirmNewPassword": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Delete the account

Authorizations:
bearerAuth
Request Body schema: application/json
username
required
string

Username for that user

password
required
string

The password

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Add a social link to the logged in user

Authorizations:
bearerAuth
Request Body schema: application/json
type
required
string

Type of the link [facebook, youtube, ...etc]

displayText
required
string

Display text for the link

link
required
string

The link

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "displayText": "string",
  • "link": "string"
}

Response samples

Content type
application/json
{
  • "error": "string"
}

Delete the social link

Authorizations:
bearerAuth
Request Body schema: application/json
type
required
string

Type of the link [facebook, youtube, ...etc]

displayText
required
string

Display text for the link

link
required
string

The link

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "displayText": "string",
  • "link": "string"
}

Add a profile picture to the logged in user

Authorizations:
bearerAuth
Request Body schema: application/json
avatar
required
object

The avatar image

Responses

Request samples

Content type
application/json
{
  • "avatar": { }
}

Response samples

Content type
application/json
{
  • "path": "string"
}

Delete the profile picture

Authorizations:
bearerAuth

Responses

Add a banner to the logged in user

Authorizations:
bearerAuth
Request Body schema: application/json
banner
required
object

The banner image

Responses

Request samples

Content type
application/json
{
  • "banner": { }
}

Response samples

Content type
application/json
{
  • "path": "string"
}

Delete the banner image

Authorizations:
bearerAuth

Responses

Get a list of blocked users by the logged in user

Authorizations:
bearerAuth
query Parameters
before
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the previous things.

after
string

Only one of after/before should be specified. The id of last item in the listing to use as the anchor point of the slice and get the next things.

limit
integer
Default: 25

Maximum number of items desired [Maximum = 100]

Responses

Response samples

Content type
application/json
{
  • "before": "string",
  • "after": "string",
  • "children": [
    ]
}