Lemmy Icon
API docs by Redocly

Unofficial Lemmy OpenAPI Documentation (v0.19.4)

Download OpenAPI specification:Download

URL: https://github.com/MV-GH/lemmy_openapi_spec License: AGPLv3

Site

Gets the site, and your user data.

Authorizations:
bearerAuthcookieAuth

Responses

Response samples

Content type
application/json
{
  • "site_view": {
    },
  • "admins": [
    ],
  • "version": "string",
  • "my_user": {
    },
  • "all_languages": [
    ],
  • "discussion_languages": [
    ],
  • "taglines": [
    ],
  • "custom_emojis": [
    ],
  • "blocked_urls": [
    ]
}

Create your site.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
name
required
string (CreateSite.name)
sidebar
string (CreateSite.sidebar)
description
string (CreateSite.description)
icon
string (CreateSite.icon)
banner
string (CreateSite.banner)
enable_downvotes
boolean (CreateSite.enable_downvotes)
enable_nsfw
boolean (CreateSite.enable_nsfw)
community_creation_admin_only
boolean (CreateSite.community_creation_admin_only)
require_email_verification
boolean (CreateSite.require_email_verification)
application_question
string (CreateSite.application_question)
private_instance
boolean (CreateSite.private_instance)
default_theme
string (CreateSite.default_theme)
default_post_listing_type
string (ListingType)
Enum: "All" "Local" "Subscribed" "ModeratorView"
default_sort_type
string (SortType)
Enum: "Active" "Hot" "New" "Old" "TopDay" "TopWeek" "TopMonth" "TopYear" "TopAll" "MostComments" "NewComments" "TopHour" "TopSixHour" "TopTwelveHour" "TopThreeMonths" "TopSixMonths" "TopNineMonths" "Controversial" "Scaled"
legal_information
string (CreateSite.legal_information)
application_email_admins
boolean (CreateSite.application_email_admins)
hide_modlog_mod_names
boolean (CreateSite.hide_modlog_mod_names)
discussion_languages
Array of integers (CreateSite.discussion_languages)
slur_filter_regex
string (CreateSite.slur_filter_regex)
actor_name_max_length
integer (CreateSite.actor_name_max_length)
rate_limit_message
integer (CreateSite.rate_limit_message)
rate_limit_message_per_second
integer (CreateSite.rate_limit_message_per_second)
rate_limit_post
integer (CreateSite.rate_limit_post)
rate_limit_post_per_second
integer (CreateSite.rate_limit_post_per_second)
rate_limit_register
integer (CreateSite.rate_limit_register)
rate_limit_register_per_second
integer (CreateSite.rate_limit_register_per_second)
rate_limit_image
integer (CreateSite.rate_limit_image)
rate_limit_image_per_second
integer (CreateSite.rate_limit_image_per_second)
rate_limit_comment
integer (CreateSite.rate_limit_comment)
rate_limit_comment_per_second
integer (CreateSite.rate_limit_comment_per_second)
rate_limit_search
integer (CreateSite.rate_limit_search)
rate_limit_search_per_second
integer (CreateSite.rate_limit_search_per_second)
federation_enabled
boolean (CreateSite.federation_enabled)
federation_debug
boolean (CreateSite.federation_debug)
captcha_enabled
boolean (CreateSite.captcha_enabled)
captcha_difficulty
string (CreateSite.captcha_difficulty)
allowed_instances
Array of strings (CreateSite.allowed_instances)
blocked_instances
Array of strings (CreateSite.blocked_instances)
taglines
Array of strings (CreateSite.taglines)
registration_mode
string (RegistrationMode)
Enum: "Closed" "RequireApplication" "Open"
content_warning
string (CreateSite.content_warning)
default_post_listing_mode
string (PostListingMode)
Enum: "List" "Card" "SmallCard"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "sidebar": "string",
  • "description": "string",
  • "icon": "string",
  • "banner": "string",
  • "enable_downvotes": true,
  • "enable_nsfw": true,
  • "community_creation_admin_only": true,
  • "require_email_verification": true,
  • "application_question": "string",
  • "private_instance": true,
  • "default_theme": "string",
  • "default_post_listing_type": "All",
  • "default_sort_type": "Active",
  • "legal_information": "string",
  • "application_email_admins": true,
  • "hide_modlog_mod_names": true,
  • "discussion_languages": [
    ],
  • "slur_filter_regex": "string",
  • "actor_name_max_length": 0,
  • "rate_limit_message": 0,
  • "rate_limit_message_per_second": 0,
  • "rate_limit_post": 0,
  • "rate_limit_post_per_second": 0,
  • "rate_limit_register": 0,
  • "rate_limit_register_per_second": 0,
  • "rate_limit_image": 0,
  • "rate_limit_image_per_second": 0,
  • "rate_limit_comment": 0,
  • "rate_limit_comment_per_second": 0,
  • "rate_limit_search": 0,
  • "rate_limit_search_per_second": 0,
  • "federation_enabled": true,
  • "federation_debug": true,
  • "captcha_enabled": true,
  • "captcha_difficulty": "string",
  • "allowed_instances": [
    ],
  • "blocked_instances": [
    ],
  • "taglines": [
    ],
  • "registration_mode": "Closed",
  • "content_warning": "string",
  • "default_post_listing_mode": "List"
}

Response samples

Content type
application/json
{
  • "site_view": {
    },
  • "taglines": [
    ]
}

Edit your site.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
name
string (EditSite.name)
sidebar
string (EditSite.sidebar)
description
string (EditSite.description)
icon
string (EditSite.icon)
banner
string (EditSite.banner)
enable_downvotes
boolean (EditSite.enable_downvotes)
enable_nsfw
boolean (EditSite.enable_nsfw)
community_creation_admin_only
boolean (EditSite.community_creation_admin_only)
require_email_verification
boolean (EditSite.require_email_verification)
application_question
string (EditSite.application_question)
private_instance
boolean (EditSite.private_instance)
default_theme
string (EditSite.default_theme)
default_post_listing_type
string (ListingType)
Enum: "All" "Local" "Subscribed" "ModeratorView"
default_sort_type
string (SortType)
Enum: "Active" "Hot" "New" "Old" "TopDay" "TopWeek" "TopMonth" "TopYear" "TopAll" "MostComments" "NewComments" "TopHour" "TopSixHour" "TopTwelveHour" "TopThreeMonths" "TopSixMonths" "TopNineMonths" "Controversial" "Scaled"
legal_information
string (EditSite.legal_information)
application_email_admins
boolean (EditSite.application_email_admins)
hide_modlog_mod_names
boolean (EditSite.hide_modlog_mod_names)
discussion_languages
Array of integers (EditSite.discussion_languages)
slur_filter_regex
string (EditSite.slur_filter_regex)
actor_name_max_length
integer (EditSite.actor_name_max_length)
rate_limit_message
integer (EditSite.rate_limit_message)
rate_limit_message_per_second
integer (EditSite.rate_limit_message_per_second)
rate_limit_post
integer (EditSite.rate_limit_post)
rate_limit_post_per_second
integer (EditSite.rate_limit_post_per_second)
rate_limit_register
integer (EditSite.rate_limit_register)
rate_limit_register_per_second
integer (EditSite.rate_limit_register_per_second)
rate_limit_image
integer (EditSite.rate_limit_image)
rate_limit_image_per_second
integer (EditSite.rate_limit_image_per_second)
rate_limit_comment
integer (EditSite.rate_limit_comment)
rate_limit_comment_per_second
integer (EditSite.rate_limit_comment_per_second)
rate_limit_search
integer (EditSite.rate_limit_search)
rate_limit_search_per_second
integer (EditSite.rate_limit_search_per_second)
federation_enabled
boolean (EditSite.federation_enabled)
federation_debug
boolean (EditSite.federation_debug)
captcha_enabled
boolean (EditSite.captcha_enabled)
captcha_difficulty
string (EditSite.captcha_difficulty)
allowed_instances
Array of strings (EditSite.allowed_instances)
blocked_instances
Array of strings (EditSite.blocked_instances)
blocked_urls
Array of strings (EditSite.blocked_urls)
taglines
Array of strings (EditSite.taglines)
registration_mode
string (RegistrationMode)
Enum: "Closed" "RequireApplication" "Open"
reports_email_admins
boolean (EditSite.reports_email_admins)
content_warning
string (EditSite.content_warning)
default_post_listing_mode
string (PostListingMode)
Enum: "List" "Card" "SmallCard"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "sidebar": "string",
  • "description": "string",
  • "icon": "string",
  • "banner": "string",
  • "enable_downvotes": true,
  • "enable_nsfw": true,
  • "community_creation_admin_only": true,
  • "require_email_verification": true,
  • "application_question": "string",
  • "private_instance": true,
  • "default_theme": "string",
  • "default_post_listing_type": "All",
  • "default_sort_type": "Active",
  • "legal_information": "string",
  • "application_email_admins": true,
  • "hide_modlog_mod_names": true,
  • "discussion_languages": [
    ],
  • "slur_filter_regex": "string",
  • "actor_name_max_length": 0,
  • "rate_limit_message": 0,
  • "rate_limit_message_per_second": 0,
  • "rate_limit_post": 0,
  • "rate_limit_post_per_second": 0,
  • "rate_limit_register": 0,
  • "rate_limit_register_per_second": 0,
  • "rate_limit_image": 0,
  • "rate_limit_image_per_second": 0,
  • "rate_limit_comment": 0,
  • "rate_limit_comment_per_second": 0,
  • "rate_limit_search": 0,
  • "rate_limit_search_per_second": 0,
  • "federation_enabled": true,
  • "federation_debug": true,
  • "captcha_enabled": true,
  • "captcha_difficulty": "string",
  • "allowed_instances": [
    ],
  • "blocked_instances": [
    ],
  • "blocked_urls": [
    ],
  • "taglines": [
    ],
  • "registration_mode": "Closed",
  • "reports_email_admins": true,
  • "content_warning": "string",
  • "default_post_listing_mode": "List"
}

Response samples

Content type
application/json
{
  • "site_view": {
    },
  • "taglines": [
    ]
}

Block an instance.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
instance_id
required
integer (InstanceId)
block
required
boolean (BlockInstance.block)

Responses

Request samples

Content type
application/json
{
  • "instance_id": 0,
  • "block": true
}

Response samples

Content type
application/json
{
  • "blocked": true
}

Miscellaneous

Get the modlog.

Authorizations:
bearerAuthcookieAuth
query Parameters
object (GetModlog)

Responses

Response samples

Content type
application/json
{
  • "removed_posts": [
    ],
  • "locked_posts": [
    ],
  • "featured_posts": [
    ],
  • "removed_comments": [
    ],
  • "removed_communities": [
    ],
  • "banned_from_community": [
    ],
  • "banned": [
    ],
  • "added_to_community": [
    ],
  • "transferred_to_community": [
    ],
  • "added": [
    ],
  • "admin_purged_persons": [
    ],
  • "admin_purged_communities": [
    ],
  • "admin_purged_posts": [
    ],
  • "admin_purged_comments": [
    ],
  • "hidden_communities": [
    ]
}

Search lemmy.

Authorizations:
bearerAuthcookieAuth
query Parameters
object (Search)

Responses

Response samples

Content type
application/json
{
  • "type_": "All",
  • "comments": [
    ],
  • "posts": [
    ],
  • "communities": [
    ],
  • "users": [
    ]
}

Fetch a non-local / federated object.

Authorizations:
bearerAuthcookieAuth
query Parameters
object (ResolveObject)

Responses

Response samples

Content type
application/json
{
  • "comment": {
    },
  • "post": {
    },
  • "community": {
    },
  • "person": {
    }
}

Fetch federated instances.

Authorizations:
bearerAuthcookieAuth

Responses

Response samples

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

Community

Get / fetch a community.

Authorizations:
bearerAuthcookieAuth
query Parameters
object (GetCommunity)

Responses

Response samples

Content type
application/json
{
  • "community_view": {
    },
  • "site": {
    },
  • "moderators": [
    ],
  • "discussion_languages": [
    ]
}

Create a new community.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
name
required
string (CreateCommunity.name)
title
required
string (CreateCommunity.title)
description
string (CreateCommunity.description)
icon
string (CreateCommunity.icon)
banner
string (CreateCommunity.banner)
nsfw
boolean (CreateCommunity.nsfw)
posting_restricted_to_mods
boolean (CreateCommunity.posting_restricted_to_mods)
discussion_languages
Array of integers (CreateCommunity.discussion_languages)
visibility
string (CommunityVisibility)
Enum: "Public" "LocalOnly"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "title": "string",
  • "description": "string",
  • "icon": "string",
  • "banner": "string",
  • "nsfw": true,
  • "posting_restricted_to_mods": true,
  • "discussion_languages": [
    ],
  • "visibility": "Public"
}

Response samples

Content type
application/json
{
  • "community_view": {
    },
  • "discussion_languages": [
    ]
}

Edit a community.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
community_id
required
integer (CommunityId)
title
string (EditCommunity.title)
description
string (EditCommunity.description)
icon
string (EditCommunity.icon)
banner
string (EditCommunity.banner)
nsfw
boolean (EditCommunity.nsfw)
posting_restricted_to_mods
boolean (EditCommunity.posting_restricted_to_mods)
discussion_languages
Array of integers (EditCommunity.discussion_languages)
visibility
string (CommunityVisibility)
Enum: "Public" "LocalOnly"

Responses

Request samples

Content type
application/json
{
  • "community_id": 0,
  • "title": "string",
  • "description": "string",
  • "icon": "string",
  • "banner": "string",
  • "nsfw": true,
  • "posting_restricted_to_mods": true,
  • "discussion_languages": [
    ],
  • "visibility": "Public"
}

Response samples

Content type
application/json
{
  • "community_view": {
    },
  • "discussion_languages": [
    ]
}

Hide a community from public / "All" view. Admins only.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
community_id
required
integer (CommunityId)
hidden
required
boolean (HideCommunity.hidden)
reason
string (HideCommunity.reason)

Responses

Request samples

Content type
application/json
{
  • "community_id": 0,
  • "hidden": true,
  • "reason": "string"
}

List communities, with various filters.

Authorizations:
bearerAuthcookieAuth
query Parameters
object (ListCommunities)

Responses

Response samples

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

Follow / subscribe to a community.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
community_id
required
integer (CommunityId)
follow
required
boolean (FollowCommunity.follow)

Responses

Request samples

Content type
application/json
{
  • "community_id": 0,
  • "follow": true
}

Response samples

Content type
application/json
{
  • "community_view": {
    },
  • "discussion_languages": [
    ]
}

Block a community.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
community_id
required
integer (CommunityId)
block
required
boolean (BlockCommunity.block)

Responses

Request samples

Content type
application/json
{
  • "community_id": 0,
  • "block": true
}

Response samples

Content type
application/json
{
  • "community_view": {
    },
  • "blocked": true
}

Delete a community.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
community_id
required
integer (CommunityId)
deleted
required
boolean (DeleteCommunity.deleted)

Responses

Request samples

Content type
application/json
{
  • "community_id": 0,
  • "deleted": true
}

Response samples

Content type
application/json
{
  • "community_view": {
    },
  • "discussion_languages": [
    ]
}

A moderator remove for a community.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
community_id
required
integer (CommunityId)
removed
required
boolean (RemoveCommunity.removed)
reason
string (RemoveCommunity.reason)

Responses

Request samples

Content type
application/json
{
  • "community_id": 0,
  • "removed": true,
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "community_view": {
    },
  • "discussion_languages": [
    ]
}

Transfer your community to an existing moderator.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
community_id
required
integer (CommunityId)
person_id
required
integer (PersonId)

Responses

Request samples

Content type
application/json
{
  • "community_id": 0,
  • "person_id": 0
}

Response samples

Content type
application/json
{
  • "community_view": {
    },
  • "discussion_languages": [
    ]
}

Ban a user from a community.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
community_id
required
integer (CommunityId)
person_id
required
integer (PersonId)
ban
required
boolean (BanFromCommunity.ban)
remove_data
boolean (BanFromCommunity.remove_data)
reason
string (BanFromCommunity.reason)
expires
integer (BanFromCommunity.expires)

Responses

Request samples

Content type
application/json
{
  • "community_id": 0,
  • "person_id": 0,
  • "ban": true,
  • "remove_data": true,
  • "reason": "string",
  • "expires": 0
}

Response samples

Content type
application/json
{
  • "person_view": {
    },
  • "banned": true
}

Add a moderator to your community.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
community_id
required
integer (CommunityId)
person_id
required
integer (PersonId)
added
required
boolean (AddModToCommunity.added)

Responses

Request samples

Content type
application/json
{
  • "community_id": 0,
  • "person_id": 0,
  • "added": true
}

Response samples

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

Admin

Hide a community from public / "All" view. Admins only.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
community_id
required
integer (CommunityId)
hidden
required
boolean (HideCommunity.hidden)
reason
string (HideCommunity.reason)

Responses

Request samples

Content type
application/json
{
  • "community_id": 0,
  • "hidden": true,
  • "reason": "string"
}

Ban a person from your site.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
person_id
required
integer (PersonId)
ban
required
boolean (BanPerson.ban)
remove_data
boolean (BanPerson.remove_data)
reason
string (BanPerson.reason)
expires
integer (BanPerson.expires)

Responses

Request samples

Content type
application/json
{
  • "person_id": 0,
  • "ban": true,
  • "remove_data": true,
  • "reason": "string",
  • "expires": 0
}

Response samples

Content type
application/json
{
  • "person_view": {
    },
  • "banned": true
}

Get a list of banned users

Authorizations:
bearerAuthcookieAuth

Responses

Response samples

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

Block a person.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
person_id
required
integer (PersonId)
block
required
boolean (BlockPerson.block)

Responses

Request samples

Content type
application/json
{
  • "person_id": 0,
  • "block": true
}

Response samples

Content type
application/json
{
  • "person_view": {
    },
  • "blocked": true
}

Leave the Site admins.

Authorizations:
bearerAuthcookieAuth

Responses

Response samples

Content type
application/json
{
  • "site_view": {
    },
  • "admins": [
    ],
  • "version": "string",
  • "my_user": {
    },
  • "all_languages": [
    ],
  • "discussion_languages": [
    ],
  • "taglines": [
    ],
  • "custom_emojis": [
    ],
  • "blocked_urls": [
    ]
}

Add an admin to your site.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
person_id
required
integer (PersonId)
added
required
boolean (AddAdmin.added)

Responses

Request samples

Content type
application/json
{
  • "person_id": 0,
  • "added": true
}

Response samples

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

Get the unread registration applications count.

Authorizations:
bearerAuthcookieAuth

Responses

Response samples

Content type
application/json
{
  • "registration_applications": 0
}

List the registration applications.

Authorizations:
bearerAuthcookieAuth
query Parameters
object (ListRegistrationApplications)

Responses

Response samples

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

Approve a registration application

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
id
required
integer (ApproveRegistrationApplication.id)
approve
required
boolean (ApproveRegistrationApplication.approve)
deny_reason
string (ApproveRegistrationApplication.deny_reason)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "approve": true,
  • "deny_reason": "string"
}

Response samples

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

Purge / Delete a person from the database.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
person_id
required
integer (PersonId)
reason
string (PurgePerson.reason)

Responses

Request samples

Content type
application/json
{
  • "person_id": 0,
  • "reason": "string"
}

Purge / Delete a community from the database.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
community_id
required
integer (CommunityId)
reason
string (PurgeCommunity.reason)

Responses

Request samples

Content type
application/json
{
  • "community_id": 0,
  • "reason": "string"
}

Purge / Delete a post from the database.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
post_id
required
integer (PostId)
reason
string (PurgePost.reason)

Responses

Request samples

Content type
application/json
{
  • "post_id": 0,
  • "reason": "string"
}

Purge / Delete a comment from the database.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
comment_id
required
integer (CommentId)
reason
string (PurgeComment.reason)

Responses

Request samples

Content type
application/json
{
  • "comment_id": 0,
  • "reason": "string"
}

List a post's likes. Admin-only.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
post_id
required
integer (PostId)
page
integer (ListPostLikes.page)
limit
integer (ListPostLikes.limit)

Responses

Request samples

Content type
application/json
{
  • "post_id": 0,
  • "page": 0,
  • "limit": 0
}

Response samples

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

List a comment's likes. Admin-only.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
comment_id
required
integer (CommentId)
page
integer (ListCommentLikes.page)
limit
integer (ListCommentLikes.limit)

Responses

Request samples

Content type
application/json
{
  • "comment_id": 0,
  • "page": 0,
  • "limit": 0
}

Response samples

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

List all the media known to your instance.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
page
integer (ListMedia.page)
limit
integer (ListMedia.limit)

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "limit": 0
}

Response samples

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

Mod

A moderator remove for a community.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
community_id
required
integer (CommunityId)
removed
required
boolean (RemoveCommunity.removed)
reason
string (RemoveCommunity.reason)

Responses

Request samples

Content type
application/json
{
  • "community_id": 0,
  • "removed": true,
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "community_view": {
    },
  • "discussion_languages": [
    ]
}

Transfer your community to an existing moderator.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
community_id
required
integer (CommunityId)
person_id
required
integer (PersonId)

Responses

Request samples

Content type
application/json
{
  • "community_id": 0,
  • "person_id": 0
}

Response samples

Content type
application/json
{
  • "community_view": {
    },
  • "discussion_languages": [
    ]
}

Ban a user from a community.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
community_id
required
integer (CommunityId)
person_id
required
integer (PersonId)
ban
required
boolean (BanFromCommunity.ban)
remove_data
boolean (BanFromCommunity.remove_data)
reason
string (BanFromCommunity.reason)
expires
integer (BanFromCommunity.expires)

Responses

Request samples

Content type
application/json
{
  • "community_id": 0,
  • "person_id": 0,
  • "ban": true,
  • "remove_data": true,
  • "reason": "string",
  • "expires": 0
}

Response samples

Content type
application/json
{
  • "person_view": {
    },
  • "banned": true
}

Add a moderator to your community.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
community_id
required
integer (CommunityId)
person_id
required
integer (PersonId)
added
required
boolean (AddModToCommunity.added)

Responses

Request samples

Content type
application/json
{
  • "community_id": 0,
  • "person_id": 0,
  • "added": true
}

Response samples

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

Post

Get / fetch a post.

Authorizations:
bearerAuthcookieAuth
query Parameters
object (GetPost)

Responses

Response samples

Content type
application/json
{
  • "post_view": {
    },
  • "community_view": {
    },
  • "moderators": [
    ],
  • "cross_posts": [
    ]
}

Edit a post.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
post_id
required
integer (PostId)
name
string (EditPost.name)
url
string (EditPost.url)
body
string (EditPost.body)
alt_text
string (EditPost.alt_text)
nsfw
boolean (EditPost.nsfw)
language_id
integer (LanguageId)
custom_thumbnail
string (EditPost.custom_thumbnail)

Responses

Request samples

Content type
application/json
{
  • "post_id": 0,
  • "name": "string",
  • "url": "string",
  • "body": "string",
  • "alt_text": "string",
  • "nsfw": true,
  • "language_id": 0,
  • "custom_thumbnail": "string"
}

Response samples

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

Create a post.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
name
required
string (CreatePost.name)
community_id
required
integer (CommunityId)
url
string (CreatePost.url)
body
string (CreatePost.body)
alt_text
string (CreatePost.alt_text)
honeypot
string (CreatePost.honeypot)
nsfw
boolean (CreatePost.nsfw)
language_id
integer (LanguageId)
custom_thumbnail
string (CreatePost.custom_thumbnail)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "community_id": 0,
  • "url": "string",
  • "body": "string",
  • "alt_text": "string",
  • "honeypot": "string",
  • "nsfw": true,
  • "language_id": 0,
  • "custom_thumbnail": "string"
}

Response samples

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

Get / fetch posts, with various filters.

Authorizations:
bearerAuthcookieAuth
query Parameters
object (GetPosts)

Responses

Response samples

Content type
application/json
{
  • "posts": [
    ],
  • "next_page": "string"
}

Delete a post.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
post_id
required
integer (PostId)
deleted
required
boolean (DeletePost.deleted)

Responses

Request samples

Content type
application/json
{
  • "post_id": 0,
  • "deleted": true
}

Response samples

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

A moderator remove for a post.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
post_id
required
integer (PostId)
removed
required
boolean (RemovePost.removed)
reason
string (RemovePost.reason)

Responses

Request samples

Content type
application/json
{
  • "post_id": 0,
  • "removed": true,
  • "reason": "string"
}

Response samples

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

Mark a post as read.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
post_ids
required
Array of integers (MarkPostAsRead.post_ids)
read
required
boolean (MarkPostAsRead.read)

Responses

Request samples

Content type
application/json
{
  • "post_ids": [
    ],
  • "read": true
}

Response samples

Content type
application/json
{
  • "success": true
}

A moderator can lock a post ( IE disable new comments ).

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
post_id
required
integer (PostId)
locked
required
boolean (LockPost.locked)

Responses

Request samples

Content type
application/json
{
  • "post_id": 0,
  • "locked": true
}

Response samples

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

A moderator can feature a community post ( IE stick it to the top of a community ).

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
post_id
required
integer (PostId)
featured
required
boolean (FeaturePost.featured)
feature_type
required
string (PostFeatureType)
Enum: "Local" "Community"

Responses

Request samples

Content type
application/json
{
  • "post_id": 0,
  • "featured": true,
  • "feature_type": "Local"
}

Response samples

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

Like / vote on a post.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
post_id
required
integer (PostId)
score
required
integer (CreatePostLike.score)

Responses

Request samples

Content type
application/json
{
  • "post_id": 0,
  • "score": 0
}

Response samples

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

Save a post.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
post_id
required
integer (PostId)
save
required
boolean (SavePost.save)

Responses

Request samples

Content type
application/json
{
  • "post_id": 0,
  • "save": true
}

Response samples

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

Report a post.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
post_id
required
integer (PostId)
reason
required
string (CreatePostReport.reason)

Responses

Request samples

Content type
application/json
{
  • "post_id": 0,
  • "reason": "string"
}

Response samples

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

Resolve a post report. Only a mod can do this.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
report_id
required
integer (PostReportId)
resolved
required
boolean (ResolvePostReport.resolved)

Responses

Request samples

Content type
application/json
{
  • "report_id": 0,
  • "resolved": true
}

Response samples

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

List post reports.

Authorizations:
bearerAuthcookieAuth
query Parameters
object (ListPostReports)

Responses

Response samples

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

Fetch metadata for any given site.

Authorizations:
bearerAuthcookieAuth
query Parameters
object (GetSiteMetadata)

Responses

Response samples

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

Like / vote on a comment.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
comment_id
required
integer (CommentId)
score
required
integer (CreateCommentLike.score)

Responses

Request samples

Content type
application/json
{
  • "comment_id": 0,
  • "score": 0
}

Response samples

Content type
application/json
{
  • "comment_view": {
    },
  • "recipient_ids": [
    ]
}

Hide a post from list views.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
post_ids
required
Array of integers (HidePost.post_ids)
hide
required
boolean (HidePost.hide)

Responses

Request samples

Content type
application/json
{
  • "post_ids": [
    ],
  • "hide": true
}

Comment

Get / fetch comment.

Authorizations:
bearerAuthcookieAuth
query Parameters
object (GetComment)

Responses

Response samples

Content type
application/json
{
  • "comment_view": {
    },
  • "recipient_ids": [
    ]
}

Create a comment.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
content
required
string (CreateComment.content)
post_id
required
integer (PostId)
parent_id
integer (CommentId)
language_id
integer (LanguageId)

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "post_id": 0,
  • "parent_id": 0,
  • "language_id": 0
}

Response samples

Content type
application/json
{
  • "comment_view": {
    },
  • "recipient_ids": [
    ]
}

Edit a comment.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
comment_id
required
integer (CommentId)
content
string (EditComment.content)
language_id
integer (LanguageId)

Responses

Request samples

Content type
application/json
{
  • "comment_id": 0,
  • "content": "string",
  • "language_id": 0
}

Response samples

Content type
application/json
{
  • "comment_view": {
    },
  • "recipient_ids": [
    ]
}

Get / fetch comments.

Authorizations:
bearerAuthcookieAuth
query Parameters
object (GetComments)

Responses

Response samples

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

Delete a comment.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
comment_id
required
integer (CommentId)
deleted
required
boolean (DeleteComment.deleted)

Responses

Request samples

Content type
application/json
{
  • "comment_id": 0,
  • "deleted": true
}

Response samples

Content type
application/json
{
  • "comment_view": {
    },
  • "recipient_ids": [
    ]
}

A moderator remove for a comment.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
comment_id
required
integer (CommentId)
removed
required
boolean (RemoveComment.removed)
reason
string (RemoveComment.reason)

Responses

Request samples

Content type
application/json
{
  • "comment_id": 0,
  • "removed": true,
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "comment_view": {
    },
  • "recipient_ids": [
    ]
}

Mark a comment as read.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
comment_reply_id
required
integer (CommentReplyId)
read
required
boolean (MarkCommentReplyAsRead.read)

Responses

Request samples

Content type
application/json
{
  • "comment_reply_id": 0,
  • "read": true
}

Response samples

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

Distinguishes a comment (speak as moderator)

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
comment_id
required
integer (CommentId)
distinguished
required
boolean (DistinguishComment.distinguished)

Responses

Request samples

Content type
application/json
{
  • "comment_id": 0,
  • "distinguished": true
}

Response samples

Content type
application/json
{
  • "comment_view": {
    },
  • "recipient_ids": [
    ]
}

Save a comment.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
comment_id
required
integer (CommentId)
save
required
boolean (SaveComment.save)

Responses

Request samples

Content type
application/json
{
  • "comment_id": 0,
  • "save": true
}

Response samples

Content type
application/json
{
  • "comment_view": {
    },
  • "recipient_ids": [
    ]
}

Report a comment.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
comment_id
required
integer (CommentId)
reason
required
string (CreateCommentReport.reason)

Responses

Request samples

Content type
application/json
{
  • "comment_id": 0,
  • "reason": "string"
}

Response samples

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

Resolve a comment report. Only a mod can do this.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
report_id
required
integer (CommentReportId)
resolved
required
boolean (ResolveCommentReport.resolved)

Responses

Request samples

Content type
application/json
{
  • "report_id": 0,
  • "resolved": true
}

Response samples

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

List comment reports.

Authorizations:
bearerAuthcookieAuth
query Parameters
object (ListCommentReports)

Responses

Response samples

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

PrivateMessage

Edit a private message.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
private_message_id
required
integer (PrivateMessageId)
content
required
string (EditPrivateMessage.content)

Responses

Request samples

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

Response samples

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

Create a private message.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
content
required
string (CreatePrivateMessage.content)
recipient_id
required
integer (PersonId)

Responses

Request samples

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

Response samples

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

Get / fetch private messages.

Authorizations:
bearerAuthcookieAuth
query Parameters
object (GetPrivateMessages)

Responses

Response samples

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

Delete a private message.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
private_message_id
required
integer (PrivateMessageId)
deleted
required
boolean (DeletePrivateMessage.deleted)

Responses

Request samples

Content type
application/json
{
  • "private_message_id": 0,
  • "deleted": true
}

Response samples

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

Mark a private message as read.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
private_message_id
required
integer (PrivateMessageId)
read
required
boolean (MarkPrivateMessageAsRead.read)

Responses

Request samples

Content type
application/json
{
  • "private_message_id": 0,
  • "read": true
}

Response samples

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

Create a report for a private message.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
private_message_id
required
integer (PrivateMessageId)
reason
required
string (CreatePrivateMessageReport.reason)

Responses

Request samples

Content type
application/json
{
  • "private_message_id": 0,
  • "reason": "string"
}

Response samples

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

Resolve a report for a private message.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
report_id
required
integer (PrivateMessageReportId)
resolved
required
boolean (ResolvePrivateMessageReport.resolved)

Responses

Request samples

Content type
application/json
{
  • "report_id": 0,
  • "resolved": true
}

Response samples

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

List private message reports.

Authorizations:
bearerAuthcookieAuth
query Parameters
object (ListPrivateMessageReports)

Responses

Response samples

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

User

Get the details for a person.

Authorizations:
bearerAuthcookieAuth
query Parameters
object (GetPersonDetails)

Responses

Response samples

Content type
application/json
{
  • "person_view": {
    },
  • "site": {
    },
  • "comments": [
    ],
  • "posts": [
    ],
  • "moderates": [
    ]
}

Register a new user.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
username
required
string (Register.username)
password
required
string (Register.password)
password_verify
required
string (Register.password_verify)
show_nsfw
required
boolean (Register.show_nsfw)
email
string (Register.email)
captcha_uuid
string (Register.captcha_uuid)
captcha_answer
string (Register.captcha_answer)
honeypot
string (Register.honeypot)
answer
string (Register.answer)

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "password_verify": "string",
  • "show_nsfw": true,
  • "email": "string",
  • "captcha_uuid": "string",
  • "captcha_answer": "string",
  • "honeypot": "string",
  • "answer": "string"
}

Response samples

Content type
application/json
{
  • "jwt": "string",
  • "registration_created": true,
  • "verify_email_sent": true
}

Fetch a Captcha.

Authorizations:
bearerAuthcookieAuth

Responses

Response samples

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

Get mentions for your user.

Authorizations:
bearerAuthcookieAuth
query Parameters
object (GetPersonMentions)

Responses

Response samples

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

Mark a person mention as read.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
person_mention_id
required
integer (PersonMentionId)
read
required
boolean (MarkPersonMentionAsRead.read)

Responses

Request samples

Content type
application/json
{
  • "person_mention_id": 0,
  • "read": true
}

Response samples

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

Get comment replies.

Authorizations:
bearerAuthcookieAuth
query Parameters
object (GetReplies)

Responses

Response samples

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

Ban a person from your site.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
person_id
required
integer (PersonId)
ban
required
boolean (BanPerson.ban)
remove_data
boolean (BanPerson.remove_data)
reason
string (BanPerson.reason)
expires
integer (BanPerson.expires)

Responses

Request samples

Content type
application/json
{
  • "person_id": 0,
  • "ban": true,
  • "remove_data": true,
  • "reason": "string",
  • "expires": 0
}

Response samples

Content type
application/json
{
  • "person_view": {
    },
  • "banned": true
}

Get a list of banned users

Authorizations:
bearerAuthcookieAuth

Responses

Response samples

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

Block a person.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
person_id
required
integer (PersonId)
block
required
boolean (BlockPerson.block)

Responses

Request samples

Content type
application/json
{
  • "person_id": 0,
  • "block": true
}

Response samples

Content type
application/json
{
  • "person_view": {
    },
  • "blocked": true
}

Log into lemmy.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
username_or_email
required
string (Login.username_or_email)
password
required
string (Login.password)
totp_2fa_token
string (Login.totp_2fa_token)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "jwt": "string",
  • "registration_created": true,
  • "verify_email_sent": true
}

Delete your account.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
password
required
string (DeleteAccount.password)
delete_content
required
boolean (DeleteAccount.delete_content)

Responses

Request samples

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

Reset your password.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
email
required
string (PasswordReset.email)

Responses

Request samples

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

Change your password from an email / token based reset.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
token
required
string (PasswordChangeAfterReset.token)
password
required
string (PasswordChangeAfterReset.password)
password_verify
required
string (PasswordChangeAfterReset.password_verify)

Responses

Request samples

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

Mark all replies as read.

Authorizations:
bearerAuthcookieAuth

Responses

Response samples

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

Save your user settings.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
show_nsfw
boolean (SaveUserSettings.show_nsfw)
blur_nsfw
boolean (SaveUserSettings.blur_nsfw)
auto_expand
boolean (SaveUserSettings.auto_expand)
theme
string (SaveUserSettings.theme)
default_sort_type
string (SortType)
Enum: "Active" "Hot" "New" "Old" "TopDay" "TopWeek" "TopMonth" "TopYear" "TopAll" "MostComments" "NewComments" "TopHour" "TopSixHour" "TopTwelveHour" "TopThreeMonths" "TopSixMonths" "TopNineMonths" "Controversial" "Scaled"
default_listing_type
string (ListingType)
Enum: "All" "Local" "Subscribed" "ModeratorView"
interface_language
string (SaveUserSettings.interface_language)
avatar
string (SaveUserSettings.avatar)
banner
string (SaveUserSettings.banner)
display_name
string (SaveUserSettings.display_name)
email
string (SaveUserSettings.email)
bio
string (SaveUserSettings.bio)
matrix_user_id
string (SaveUserSettings.matrix_user_id)
show_avatars
boolean (SaveUserSettings.show_avatars)
send_notifications_to_email
boolean (SaveUserSettings.send_notifications_to_email)
bot_account
boolean (SaveUserSettings.bot_account)
show_bot_accounts
boolean (SaveUserSettings.show_bot_accounts)
show_read_posts
boolean (SaveUserSettings.show_read_posts)
discussion_languages
Array of integers (SaveUserSettings.discussion_languages)
open_links_in_new_tab
boolean (SaveUserSettings.open_links_in_new_tab)
infinite_scroll_enabled
boolean (SaveUserSettings.infinite_scroll_enabled)
post_listing_mode
string (PostListingMode)
Enum: "List" "Card" "SmallCard"
enable_keyboard_navigation
boolean (SaveUserSettings.enable_keyboard_navigation)
enable_animated_images
boolean (SaveUserSettings.enable_animated_images)
collapse_bot_comments
boolean (SaveUserSettings.collapse_bot_comments)
show_scores
boolean (SaveUserSettings.show_scores)
show_upvotes
boolean (SaveUserSettings.show_upvotes)
show_downvotes
boolean (SaveUserSettings.show_downvotes)
show_upvote_percentage
boolean (SaveUserSettings.show_upvote_percentage)

Responses

Request samples

Content type
application/json
{
  • "show_nsfw": true,
  • "blur_nsfw": true,
  • "auto_expand": true,
  • "theme": "string",
  • "default_sort_type": "Active",
  • "default_listing_type": "All",
  • "interface_language": "string",
  • "avatar": "string",
  • "banner": "string",
  • "display_name": "string",
  • "email": "string",
  • "bio": "string",
  • "matrix_user_id": "string",
  • "show_avatars": true,
  • "send_notifications_to_email": true,
  • "bot_account": true,
  • "show_bot_accounts": true,
  • "show_read_posts": true,
  • "discussion_languages": [
    ],
  • "open_links_in_new_tab": true,
  • "infinite_scroll_enabled": true,
  • "post_listing_mode": "List",
  • "enable_keyboard_navigation": true,
  • "enable_animated_images": true,
  • "collapse_bot_comments": true,
  • "show_scores": true,
  • "show_upvotes": true,
  • "show_downvotes": true,
  • "show_upvote_percentage": true
}

Change your user password.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
new_password
required
string (ChangePassword.new_password)
new_password_verify
required
string (ChangePassword.new_password_verify)
old_password
required
string (ChangePassword.old_password)

Responses

Request samples

Content type
application/json
{
  • "new_password": "string",
  • "new_password_verify": "string",
  • "old_password": "string"
}

Response samples

Content type
application/json
{
  • "jwt": "string",
  • "registration_created": true,
  • "verify_email_sent": true
}

Get counts for your reports

Authorizations:
bearerAuthcookieAuth
query Parameters
object (GetReportCount)

Responses

Response samples

Content type
application/json
{
  • "community_id": 0,
  • "comment_reports": 0,
  • "post_reports": 0,
  • "private_message_reports": 0
}

Get your unread counts

Authorizations:
bearerAuthcookieAuth

Responses

Response samples

Content type
application/json
{
  • "replies": 0,
  • "mentions": 0,
  • "private_messages": 0
}

Verify your email

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
token
required
string (VerifyEmail.token)

Responses

Request samples

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

Leave the Site admins.

Authorizations:
bearerAuthcookieAuth

Responses

Response samples

Content type
application/json
{
  • "site_view": {
    },
  • "admins": [
    ],
  • "version": "string",
  • "my_user": {
    },
  • "all_languages": [
    ],
  • "discussion_languages": [
    ],
  • "taglines": [
    ],
  • "custom_emojis": [
    ],
  • "blocked_urls": [
    ]
}

Block an instance.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
instance_id
required
integer (InstanceId)
block
required
boolean (BlockInstance.block)

Responses

Request samples

Content type
application/json
{
  • "instance_id": 0,
  • "block": true
}

Response samples

Content type
application/json
{
  • "blocked": true
}

Generate a TOTP / two-factor secret. Afterwards you need to call `/user/totp/update` with a valid token to enable it.

Authorizations:
bearerAuthcookieAuth

Responses

Response samples

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

Enable / Disable TOTP / two-factor authentication. To enable, you need to first call `/user/totp/generate` and then pass a valid token to this. Disabling is only possible if 2FA was previously enabled. Again it is necessary to pass a valid token.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
totp_token
required
string (UpdateTotp.totp_token)
enabled
required
boolean (UpdateTotp.enabled)

Responses

Request samples

Content type
application/json
{
  • "totp_token": "string",
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "enabled": true
}

Export a backup of your user settings, including your saved content, followed communities, and blocks.

Authorizations:
bearerAuthcookieAuth

Responses

Response samples

Content type
application/json
"string"

Import a backup of your user settings.

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
string (ImportUserSettings)

Responses

Request samples

Content type
application/json
"string"

List login tokens for your user

Authorizations:
bearerAuthcookieAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns an error message if your auth token is invalid

Authorizations:
bearerAuthcookieAuth

Responses

[MANUAL] Logout your user, which clears the cookie and invalidates the auth token

Authorizations:
bearerAuthcookieAuth

Responses

List all the media for your user

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
page
integer (ListMedia.page)
limit
integer (ListMedia.limit)

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "limit": 0
}

Response samples

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

CustomEmoji

Edit an existing custom emoji

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
id
required
integer (CustomEmojiId)
category
required
string (EditCustomEmoji.category)
image_url
required
string (EditCustomEmoji.image_url)
alt_text
required
string (EditCustomEmoji.alt_text)
keywords
required
Array of strings (EditCustomEmoji.keywords)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "category": "string",
  • "image_url": "string",
  • "alt_text": "string",
  • "keywords": [
    ]
}

Response samples

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

Create a new custom emoji

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
category
required
string (CreateCustomEmoji.category)
shortcode
required
string (CreateCustomEmoji.shortcode)
image_url
required
string (CreateCustomEmoji.image_url)
alt_text
required
string (CreateCustomEmoji.alt_text)
keywords
required
Array of strings (CreateCustomEmoji.keywords)

Responses

Request samples

Content type
application/json
{
  • "category": "string",
  • "shortcode": "string",
  • "image_url": "string",
  • "alt_text": "string",
  • "keywords": [
    ]
}

Response samples

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

Delete a custom emoji

Authorizations:
bearerAuthcookieAuth
Request Body schema: application/json
id
required
integer (CustomEmojiId)

Responses

Request samples

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