Unofficial Lemmy OpenAPI Documentation (v0.19.6)

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": {"site": {"id": 0,
"name": "string",
"sidebar": "string",
"published": "string",
"updated": "string",
"icon": "string",
"banner": "string",
"description": "string",
"actor_id": "string",
"last_refreshed_at": "string",
"inbox_url": "string",
"public_key": "string",
"instance_id": 0,
"content_warning": "string"
},
"local_site": {"id": 0,
"site_id": 0,
"site_setup": true,
"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",
"legal_information": "string",
"hide_modlog_mod_names": true,
"application_email_admins": true,
"slur_filter_regex": "string",
"actor_name_max_length": 0,
"federation_enabled": true,
"captcha_enabled": true,
"captcha_difficulty": "string",
"published": "string",
"updated": "string",
"registration_mode": "Closed",
"reports_email_admins": true,
"federation_signed_fetch": true,
"default_post_listing_mode": "List",
"default_sort_type": "Active"
},
"local_site_rate_limit": {"local_site_id": 0,
"message": 0,
"message_per_second": 0,
"post": 0,
"post_per_second": 0,
"register": 0,
"register_per_second": 0,
"image": 0,
"image_per_second": 0,
"comment": 0,
"comment_per_second": 0,
"search": 0,
"search_per_second": 0,
"published": "string",
"updated": "string",
"import_user_settings": 0,
"import_user_settings_per_second": 0
},
"counts": {"site_id": 0,
"users": 0,
"posts": 0,
"comments": 0,
"communities": 0,
"users_active_day": 0,
"users_active_week": 0,
"users_active_month": 0,
"users_active_half_year": 0
}
},
"admins": [{"person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"counts": {"person_id": 0,
"post_count": 0,
"comment_count": 0
},
"is_admin": true
}
],
"version": "string",
"my_user": {"local_user_view": {"local_user": {"id": 0,
"person_id": 0,
"email": "string",
"show_nsfw": true,
"theme": "string",
"default_sort_type": "Active",
"default_listing_type": "All",
"interface_language": "string",
"show_avatars": true,
"send_notifications_to_email": true,
"show_scores": true,
"show_bot_accounts": true,
"show_read_posts": true,
"email_verified": true,
"accepted_application": true,
"open_links_in_new_tab": true,
"blur_nsfw": true,
"auto_expand": true,
"infinite_scroll_enabled": true,
"admin": true,
"post_listing_mode": "List",
"totp_2fa_enabled": true,
"enable_keyboard_navigation": true,
"enable_animated_images": true,
"collapse_bot_comments": true
},
"local_user_vote_display_mode": {"local_user_id": 0,
"score": true,
"upvotes": true,
"downvotes": true,
"upvote_percentage": true
},
"person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"counts": {"person_id": 0,
"post_count": 0,
"comment_count": 0
}
},
"follows": [{"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"follower": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
}
}
],
"moderates": [{"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"moderator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
}
}
],
"community_blocks": [{"person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
}
}
],
"instance_blocks": [{"person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"instance": {"id": 0,
"domain": "string",
"published": "string",
"updated": "string",
"software": "string",
"version": "string"
},
"site": {"id": 0,
"name": "string",
"sidebar": "string",
"published": "string",
"updated": "string",
"icon": "string",
"banner": "string",
"description": "string",
"actor_id": "string",
"last_refreshed_at": "string",
"inbox_url": "string",
"public_key": "string",
"instance_id": 0,
"content_warning": "string"
}
}
],
"person_blocks": [{"person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"target": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
}
}
],
"discussion_languages": [0
]
},
"all_languages": [{"id": 0,
"code": "string",
"name": "string"
}
],
"discussion_languages": [0
],
"taglines": [{"id": 0,
"local_site_id": 0,
"content": "string",
"published": "string",
"updated": "string"
}
],
"custom_emojis": [{"custom_emoji": {"id": 0,
"local_site_id": 0,
"shortcode": "string",
"image_url": "string",
"alt_text": "string",
"category": "string",
"published": "string",
"updated": "string"
},
"keywords": [{"custom_emoji_id": 0,
"keyword": "string"
}
]
}
],
"blocked_urls": [{"id": 0,
"url": "string",
"published": "string",
"updated": "string"
}
]
}

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

Payload

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": [0
],
"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": ["string"
],
"blocked_instances": ["string"
],
"taglines": ["string"
],
"registration_mode": "Closed",
"content_warning": "string",
"default_post_listing_mode": "List"
}

Response samples

Content type

application/json

{"site_view": {"site": {"id": 0,
"name": "string",
"sidebar": "string",
"published": "string",
"updated": "string",
"icon": "string",
"banner": "string",
"description": "string",
"actor_id": "string",
"last_refreshed_at": "string",
"inbox_url": "string",
"public_key": "string",
"instance_id": 0,
"content_warning": "string"
},
"local_site": {"id": 0,
"site_id": 0,
"site_setup": true,
"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",
"legal_information": "string",
"hide_modlog_mod_names": true,
"application_email_admins": true,
"slur_filter_regex": "string",
"actor_name_max_length": 0,
"federation_enabled": true,
"captcha_enabled": true,
"captcha_difficulty": "string",
"published": "string",
"updated": "string",
"registration_mode": "Closed",
"reports_email_admins": true,
"federation_signed_fetch": true,
"default_post_listing_mode": "List",
"default_sort_type": "Active"
},
"local_site_rate_limit": {"local_site_id": 0,
"message": 0,
"message_per_second": 0,
"post": 0,
"post_per_second": 0,
"register": 0,
"register_per_second": 0,
"image": 0,
"image_per_second": 0,
"comment": 0,
"comment_per_second": 0,
"search": 0,
"search_per_second": 0,
"published": "string",
"updated": "string",
"import_user_settings": 0,
"import_user_settings_per_second": 0
},
"counts": {"site_id": 0,
"users": 0,
"posts": 0,
"comments": 0,
"communities": 0,
"users_active_day": 0,
"users_active_week": 0,
"users_active_month": 0,
"users_active_half_year": 0
}
},
"taglines": [{"id": 0,
"local_site_id": 0,
"content": "string",
"published": "string",
"updated": "string"
}
]
}

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

Payload

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": [0
],
"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": ["string"
],
"blocked_instances": ["string"
],
"blocked_urls": ["string"
],
"taglines": ["string"
],
"registration_mode": "Closed",
"reports_email_admins": true,
"content_warning": "string",
"default_post_listing_mode": "List"
}

Response samples

Content type

application/json

{"site_view": {"site": {"id": 0,
"name": "string",
"sidebar": "string",
"published": "string",
"updated": "string",
"icon": "string",
"banner": "string",
"description": "string",
"actor_id": "string",
"last_refreshed_at": "string",
"inbox_url": "string",
"public_key": "string",
"instance_id": 0,
"content_warning": "string"
},
"local_site": {"id": 0,
"site_id": 0,
"site_setup": true,
"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",
"legal_information": "string",
"hide_modlog_mod_names": true,
"application_email_admins": true,
"slur_filter_regex": "string",
"actor_name_max_length": 0,
"federation_enabled": true,
"captcha_enabled": true,
"captcha_difficulty": "string",
"published": "string",
"updated": "string",
"registration_mode": "Closed",
"reports_email_admins": true,
"federation_signed_fetch": true,
"default_post_listing_mode": "List",
"default_sort_type": "Active"
},
"local_site_rate_limit": {"local_site_id": 0,
"message": 0,
"message_per_second": 0,
"post": 0,
"post_per_second": 0,
"register": 0,
"register_per_second": 0,
"image": 0,
"image_per_second": 0,
"comment": 0,
"comment_per_second": 0,
"search": 0,
"search_per_second": 0,
"published": "string",
"updated": "string",
"import_user_settings": 0,
"import_user_settings_per_second": 0
},
"counts": {"site_id": 0,
"users": 0,
"posts": 0,
"comments": 0,
"communities": 0,
"users_active_day": 0,
"users_active_week": 0,
"users_active_month": 0,
"users_active_half_year": 0
}
},
"taglines": [{"id": 0,
"local_site_id": 0,
"content": "string",
"published": "string",
"updated": "string"
}
]
}

Block an instance.

Authorizations:

bearerAuthcookieAuth

Request Body schema: application/json

instance_id required	integer (InstanceId)
block required	boolean (BlockInstance.block)

Responses

Request samples

Payload

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": [{"mod_remove_post": {"id": 0,
"mod_person_id": 0,
"post_id": 0,
"reason": "string",
"removed": true,
"when_": "string"
},
"moderator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"post": {"id": 0,
"name": "string",
"url": "string",
"body": "string",
"creator_id": 0,
"community_id": 0,
"removed": true,
"locked": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"embed_title": "string",
"embed_description": "string",
"thumbnail_url": "string",
"ap_id": "string",
"local": true,
"embed_video_url": "string",
"language_id": 0,
"featured_community": true,
"featured_local": true,
"url_content_type": "string",
"alt_text": "string"
},
"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
}
}
],
"locked_posts": [{"mod_lock_post": {"id": 0,
"mod_person_id": 0,
"post_id": 0,
"locked": true,
"when_": "string"
},
"moderator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"post": {"id": 0,
"name": "string",
"url": "string",
"body": "string",
"creator_id": 0,
"community_id": 0,
"removed": true,
"locked": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"embed_title": "string",
"embed_description": "string",
"thumbnail_url": "string",
"ap_id": "string",
"local": true,
"embed_video_url": "string",
"language_id": 0,
"featured_community": true,
"featured_local": true,
"url_content_type": "string",
"alt_text": "string"
},
"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
}
}
],
"featured_posts": [{"mod_feature_post": {"id": 0,
"mod_person_id": 0,
"post_id": 0,
"featured": true,
"when_": "string",
"is_featured_community": true
},
"moderator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"post": {"id": 0,
"name": "string",
"url": "string",
"body": "string",
"creator_id": 0,
"community_id": 0,
"removed": true,
"locked": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"embed_title": "string",
"embed_description": "string",
"thumbnail_url": "string",
"ap_id": "string",
"local": true,
"embed_video_url": "string",
"language_id": 0,
"featured_community": true,
"featured_local": true,
"url_content_type": "string",
"alt_text": "string"
},
"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
}
}
],
"removed_comments": [{"mod_remove_comment": {"id": 0,
"mod_person_id": 0,
"comment_id": 0,
"reason": "string",
"removed": true,
"when_": "string"
},
"moderator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"comment": {"id": 0,
"creator_id": 0,
"post_id": 0,
"content": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"ap_id": "string",
"local": true,
"path": "string",
"distinguished": true,
"language_id": 0
},
"commenter": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"post": {"id": 0,
"name": "string",
"url": "string",
"body": "string",
"creator_id": 0,
"community_id": 0,
"removed": true,
"locked": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"embed_title": "string",
"embed_description": "string",
"thumbnail_url": "string",
"ap_id": "string",
"local": true,
"embed_video_url": "string",
"language_id": 0,
"featured_community": true,
"featured_local": true,
"url_content_type": "string",
"alt_text": "string"
},
"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
}
}
],
"removed_communities": [{"mod_remove_community": {"id": 0,
"mod_person_id": 0,
"community_id": 0,
"reason": "string",
"removed": true,
"when_": "string"
},
"moderator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
}
}
],
"banned_from_community": [{"mod_ban_from_community": {"id": 0,
"mod_person_id": 0,
"other_person_id": 0,
"community_id": 0,
"reason": "string",
"banned": true,
"expires": "string",
"when_": "string"
},
"moderator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"banned_person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
}
}
],
"banned": [{"mod_ban": {"id": 0,
"mod_person_id": 0,
"other_person_id": 0,
"reason": "string",
"banned": true,
"expires": "string",
"when_": "string"
},
"moderator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"banned_person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
}
}
],
"added_to_community": [{"mod_add_community": {"id": 0,
"mod_person_id": 0,
"other_person_id": 0,
"community_id": 0,
"removed": true,
"when_": "string"
},
"moderator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"modded_person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
}
}
],
"transferred_to_community": [{"mod_transfer_community": {"id": 0,
"mod_person_id": 0,
"other_person_id": 0,
"community_id": 0,
"when_": "string"
},
"moderator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"modded_person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
}
}
],
"added": [{"mod_add": {"id": 0,
"mod_person_id": 0,
"other_person_id": 0,
"removed": true,
"when_": "string"
},
"moderator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"modded_person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
}
}
],
"admin_purged_persons": [{"admin_purge_person": {"id": 0,
"admin_person_id": 0,
"reason": "string",
"when_": "string"
},
"admin": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
}
}
],
"admin_purged_communities": [{"admin_purge_community": {"id": 0,
"admin_person_id": 0,
"reason": "string",
"when_": "string"
},
"admin": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
}
}
],
"admin_purged_posts": [{"admin_purge_post": {"id": 0,
"admin_person_id": 0,
"community_id": 0,
"reason": "string",
"when_": "string"
},
"admin": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
}
}
],
"admin_purged_comments": [{"admin_purge_comment": {"id": 0,
"admin_person_id": 0,
"post_id": 0,
"reason": "string",
"when_": "string"
},
"admin": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"post": {"id": 0,
"name": "string",
"url": "string",
"body": "string",
"creator_id": 0,
"community_id": 0,
"removed": true,
"locked": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"embed_title": "string",
"embed_description": "string",
"thumbnail_url": "string",
"ap_id": "string",
"local": true,
"embed_video_url": "string",
"language_id": 0,
"featured_community": true,
"featured_local": true,
"url_content_type": "string",
"alt_text": "string"
}
}
],
"hidden_communities": [{"mod_hide_community": {"id": 0,
"community_id": 0,
"mod_person_id": 0,
"when_": "string",
"reason": "string",
"hidden": true
},
"admin": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
}
}
]
}

Search lemmy.

Authorizations:

bearerAuthcookieAuth

query Parameters

object (Search)

Responses

Response samples

Content type

application/json

{"type_": "All",
"comments": [{"comment": {"id": 0,
"creator_id": 0,
"post_id": 0,
"content": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"ap_id": "string",
"local": true,
"path": "string",
"distinguished": true,
"language_id": 0
},
"creator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"post": {"id": 0,
"name": "string",
"url": "string",
"body": "string",
"creator_id": 0,
"community_id": 0,
"removed": true,
"locked": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"embed_title": "string",
"embed_description": "string",
"thumbnail_url": "string",
"ap_id": "string",
"local": true,
"embed_video_url": "string",
"language_id": 0,
"featured_community": true,
"featured_local": true,
"url_content_type": "string",
"alt_text": "string"
},
"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"counts": {"comment_id": 0,
"score": 0,
"upvotes": 0,
"downvotes": 0,
"published": "string",
"child_count": 0
},
"creator_banned_from_community": true,
"banned_from_community": true,
"creator_is_moderator": true,
"creator_is_admin": true,
"subscribed": "Subscribed",
"saved": true,
"creator_blocked": true,
"my_vote": 0
}
],
"posts": [{"post": {"id": 0,
"name": "string",
"url": "string",
"body": "string",
"creator_id": 0,
"community_id": 0,
"removed": true,
"locked": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"embed_title": "string",
"embed_description": "string",
"thumbnail_url": "string",
"ap_id": "string",
"local": true,
"embed_video_url": "string",
"language_id": 0,
"featured_community": true,
"featured_local": true,
"url_content_type": "string",
"alt_text": "string"
},
"creator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"image_details": {"link": "string",
"width": 0,
"height": 0,
"content_type": "string"
},
"creator_banned_from_community": true,
"banned_from_community": true,
"creator_is_moderator": true,
"creator_is_admin": true,
"counts": {"post_id": 0,
"comments": 0,
"score": 0,
"upvotes": 0,
"downvotes": 0,
"published": "string",
"newest_comment_time": "string"
},
"subscribed": "Subscribed",
"saved": true,
"read": true,
"hidden": true,
"creator_blocked": true,
"my_vote": 0,
"unread_comments": 0
}
],
"communities": [{"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"subscribed": "Subscribed",
"blocked": true,
"counts": {"community_id": 0,
"subscribers": 0,
"posts": 0,
"comments": 0,
"published": "string",
"users_active_day": 0,
"users_active_week": 0,
"users_active_month": 0,
"users_active_half_year": 0,
"subscribers_local": 0
},
"banned_from_community": true
}
],
"users": [{"person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"counts": {"person_id": 0,
"post_count": 0,
"comment_count": 0
},
"is_admin": true
}
]
}

Fetch a non-local / federated object.

Authorizations:

bearerAuthcookieAuth

query Parameters

object (ResolveObject)

Responses

Response samples

Content type

application/json

{"comment": {"comment": {"id": 0,
"creator_id": 0,
"post_id": 0,
"content": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"ap_id": "string",
"local": true,
"path": "string",
"distinguished": true,
"language_id": 0
},
"creator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"post": {"id": 0,
"name": "string",
"url": "string",
"body": "string",
"creator_id": 0,
"community_id": 0,
"removed": true,
"locked": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"embed_title": "string",
"embed_description": "string",
"thumbnail_url": "string",
"ap_id": "string",
"local": true,
"embed_video_url": "string",
"language_id": 0,
"featured_community": true,
"featured_local": true,
"url_content_type": "string",
"alt_text": "string"
},
"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"counts": {"comment_id": 0,
"score": 0,
"upvotes": 0,
"downvotes": 0,
"published": "string",
"child_count": 0
},
"creator_banned_from_community": true,
"banned_from_community": true,
"creator_is_moderator": true,
"creator_is_admin": true,
"subscribed": "Subscribed",
"saved": true,
"creator_blocked": true,
"my_vote": 0
},
"post": {"post": {"id": 0,
"name": "string",
"url": "string",
"body": "string",
"creator_id": 0,
"community_id": 0,
"removed": true,
"locked": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"embed_title": "string",
"embed_description": "string",
"thumbnail_url": "string",
"ap_id": "string",
"local": true,
"embed_video_url": "string",
"language_id": 0,
"featured_community": true,
"featured_local": true,
"url_content_type": "string",
"alt_text": "string"
},
"creator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"image_details": {"link": "string",
"width": 0,
"height": 0,
"content_type": "string"
},
"creator_banned_from_community": true,
"banned_from_community": true,
"creator_is_moderator": true,
"creator_is_admin": true,
"counts": {"post_id": 0,
"comments": 0,
"score": 0,
"upvotes": 0,
"downvotes": 0,
"published": "string",
"newest_comment_time": "string"
},
"subscribed": "Subscribed",
"saved": true,
"read": true,
"hidden": true,
"creator_blocked": true,
"my_vote": 0,
"unread_comments": 0
},
"community": {"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"subscribed": "Subscribed",
"blocked": true,
"counts": {"community_id": 0,
"subscribers": 0,
"posts": 0,
"comments": 0,
"published": "string",
"users_active_day": 0,
"users_active_week": 0,
"users_active_month": 0,
"users_active_half_year": 0,
"subscribers_local": 0
},
"banned_from_community": true
},
"person": {"person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"counts": {"person_id": 0,
"post_count": 0,
"comment_count": 0
},
"is_admin": true
}
}

Fetch federated instances.

Authorizations:

bearerAuthcookieAuth

Responses

Response samples

Content type

application/json

{"federated_instances": {"linked": [{"id": 0,
"domain": "string",
"published": "string",
"updated": "string",
"software": "string",
"version": "string",
"federation_state": {"instance_id": 0,
"last_successful_id": 0,
"last_successful_published_time": "string",
"fail_count": 0,
"last_retry": "string",
"next_retry": "string"
}
}
],
"allowed": [{"id": 0,
"domain": "string",
"published": "string",
"updated": "string",
"software": "string",
"version": "string",
"federation_state": {"instance_id": 0,
"last_successful_id": 0,
"last_successful_published_time": "string",
"fail_count": 0,
"last_retry": "string",
"next_retry": "string"
}
}
],
"blocked": [{"id": 0,
"domain": "string",
"published": "string",
"updated": "string",
"software": "string",
"version": "string",
"federation_state": {"instance_id": 0,
"last_successful_id": 0,
"last_successful_published_time": "string",
"fail_count": 0,
"last_retry": "string",
"next_retry": "string"
}
}
]
}
}

Community

Get / fetch a community.

Authorizations:

bearerAuthcookieAuth

query Parameters

object (GetCommunity)

Responses

Response samples

Content type

application/json

{"community_view": {"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"subscribed": "Subscribed",
"blocked": true,
"counts": {"community_id": 0,
"subscribers": 0,
"posts": 0,
"comments": 0,
"published": "string",
"users_active_day": 0,
"users_active_week": 0,
"users_active_month": 0,
"users_active_half_year": 0,
"subscribers_local": 0
},
"banned_from_community": true
},
"site": {"id": 0,
"name": "string",
"sidebar": "string",
"published": "string",
"updated": "string",
"icon": "string",
"banner": "string",
"description": "string",
"actor_id": "string",
"last_refreshed_at": "string",
"inbox_url": "string",
"public_key": "string",
"instance_id": 0,
"content_warning": "string"
},
"moderators": [{"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"moderator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
}
}
],
"discussion_languages": [0
]
}

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

Payload

Content type

application/json

{"name": "string",
"title": "string",
"description": "string",
"icon": "string",
"banner": "string",
"nsfw": true,
"posting_restricted_to_mods": true,
"discussion_languages": [0
],
"visibility": "Public"
}

Response samples

Content type

application/json

{"community_view": {"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"subscribed": "Subscribed",
"blocked": true,
"counts": {"community_id": 0,
"subscribers": 0,
"posts": 0,
"comments": 0,
"published": "string",
"users_active_day": 0,
"users_active_week": 0,
"users_active_month": 0,
"users_active_half_year": 0,
"subscribers_local": 0
},
"banned_from_community": true
},
"discussion_languages": [0
]
}

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

Payload

Content type

application/json

{"community_id": 0,
"title": "string",
"description": "string",
"icon": "string",
"banner": "string",
"nsfw": true,
"posting_restricted_to_mods": true,
"discussion_languages": [0
],
"visibility": "Public"
}

Response samples

Content type

application/json

{"community_view": {"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"subscribed": "Subscribed",
"blocked": true,
"counts": {"community_id": 0,
"subscribers": 0,
"posts": 0,
"comments": 0,
"published": "string",
"users_active_day": 0,
"users_active_week": 0,
"users_active_month": 0,
"users_active_half_year": 0,
"subscribers_local": 0
},
"banned_from_community": true
},
"discussion_languages": [0
]
}

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

Payload

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": [{"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"subscribed": "Subscribed",
"blocked": true,
"counts": {"community_id": 0,
"subscribers": 0,
"posts": 0,
"comments": 0,
"published": "string",
"users_active_day": 0,
"users_active_week": 0,
"users_active_month": 0,
"users_active_half_year": 0,
"subscribers_local": 0
},
"banned_from_community": true
}
]
}

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

Payload

Content type

application/json

{"community_id": 0,
"follow": true
}

Response samples

Content type

application/json

{"community_view": {"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"subscribed": "Subscribed",
"blocked": true,
"counts": {"community_id": 0,
"subscribers": 0,
"posts": 0,
"comments": 0,
"published": "string",
"users_active_day": 0,
"users_active_week": 0,
"users_active_month": 0,
"users_active_half_year": 0,
"subscribers_local": 0
},
"banned_from_community": true
},
"discussion_languages": [0
]
}

Block a community.

Authorizations:

bearerAuthcookieAuth

Request Body schema: application/json

community_id required	integer (CommunityId)
block required	boolean (BlockCommunity.block)

Responses

Request samples

Payload

Content type

application/json

{"community_id": 0,
"block": true
}

Response samples

Content type

application/json

{"community_view": {"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"subscribed": "Subscribed",
"blocked": true,
"counts": {"community_id": 0,
"subscribers": 0,
"posts": 0,
"comments": 0,
"published": "string",
"users_active_day": 0,
"users_active_week": 0,
"users_active_month": 0,
"users_active_half_year": 0,
"subscribers_local": 0
},
"banned_from_community": true
},
"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

Payload

Content type

application/json

{"community_id": 0,
"deleted": true
}

Response samples

Content type

application/json

{"community_view": {"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"subscribed": "Subscribed",
"blocked": true,
"counts": {"community_id": 0,
"subscribers": 0,
"posts": 0,
"comments": 0,
"published": "string",
"users_active_day": 0,
"users_active_week": 0,
"users_active_month": 0,
"users_active_half_year": 0,
"subscribers_local": 0
},
"banned_from_community": true
},
"discussion_languages": [0
]
}

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

Payload

Content type

application/json

{"community_id": 0,
"removed": true,
"reason": "string"
}

Response samples

Content type

application/json

{"community_view": {"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"subscribed": "Subscribed",
"blocked": true,
"counts": {"community_id": 0,
"subscribers": 0,
"posts": 0,
"comments": 0,
"published": "string",
"users_active_day": 0,
"users_active_week": 0,
"users_active_month": 0,
"users_active_half_year": 0,
"subscribers_local": 0
},
"banned_from_community": true
},
"discussion_languages": [0
]
}

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

Payload

Content type

application/json

{"community_id": 0,
"person_id": 0
}

Response samples

Content type

application/json

{"community_view": {"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"subscribed": "Subscribed",
"blocked": true,
"counts": {"community_id": 0,
"subscribers": 0,
"posts": 0,
"comments": 0,
"published": "string",
"users_active_day": 0,
"users_active_week": 0,
"users_active_month": 0,
"users_active_half_year": 0,
"subscribers_local": 0
},
"banned_from_community": true
},
"discussion_languages": [0
]
}

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

Payload

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": {"person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"counts": {"person_id": 0,
"post_count": 0,
"comment_count": 0
},
"is_admin": true
},
"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

Payload

Content type

application/json

{"community_id": 0,
"person_id": 0,
"added": true
}

Response samples

Content type

application/json

{"moderators": [{"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"moderator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
}
}
]
}

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

Payload

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

Payload

Content type

application/json

{"person_id": 0,
"ban": true,
"remove_data": true,
"reason": "string",
"expires": 0
}

Response samples

Content type

application/json

{"person_view": {"person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"counts": {"person_id": 0,
"post_count": 0,
"comment_count": 0
},
"is_admin": true
},
"banned": true
}

Get a list of banned users

Authorizations:

bearerAuthcookieAuth

Responses

Response samples

Content type

application/json

{"banned": [{"person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"counts": {"person_id": 0,
"post_count": 0,
"comment_count": 0
},
"is_admin": true
}
]
}

Block a person.

Authorizations:

bearerAuthcookieAuth

Request Body schema: application/json

person_id required	integer (PersonId)
block required	boolean (BlockPerson.block)

Responses

Request samples

Payload

Content type

application/json

{"person_id": 0,
"block": true
}

Response samples

Content type

application/json

{"person_view": {"person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"counts": {"person_id": 0,
"post_count": 0,
"comment_count": 0
},
"is_admin": true
},
"blocked": true
}

Leave the Site admins.

Authorizations:

bearerAuthcookieAuth

Responses

Response samples

Content type

application/json

{"site_view": {"site": {"id": 0,
"name": "string",
"sidebar": "string",
"published": "string",
"updated": "string",
"icon": "string",
"banner": "string",
"description": "string",
"actor_id": "string",
"last_refreshed_at": "string",
"inbox_url": "string",
"public_key": "string",
"instance_id": 0,
"content_warning": "string"
},
"local_site": {"id": 0,
"site_id": 0,
"site_setup": true,
"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",
"legal_information": "string",
"hide_modlog_mod_names": true,
"application_email_admins": true,
"slur_filter_regex": "string",
"actor_name_max_length": 0,
"federation_enabled": true,
"captcha_enabled": true,
"captcha_difficulty": "string",
"published": "string",
"updated": "string",
"registration_mode": "Closed",
"reports_email_admins": true,
"federation_signed_fetch": true,
"default_post_listing_mode": "List",
"default_sort_type": "Active"
},
"local_site_rate_limit": {"local_site_id": 0,
"message": 0,
"message_per_second": 0,
"post": 0,
"post_per_second": 0,
"register": 0,
"register_per_second": 0,
"image": 0,
"image_per_second": 0,
"comment": 0,
"comment_per_second": 0,
"search": 0,
"search_per_second": 0,
"published": "string",
"updated": "string",
"import_user_settings": 0,
"import_user_settings_per_second": 0
},
"counts": {"site_id": 0,
"users": 0,
"posts": 0,
"comments": 0,
"communities": 0,
"users_active_day": 0,
"users_active_week": 0,
"users_active_month": 0,
"users_active_half_year": 0
}
},
"admins": [{"person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"counts": {"person_id": 0,
"post_count": 0,
"comment_count": 0
},
"is_admin": true
}
],
"version": "string",
"my_user": {"local_user_view": {"local_user": {"id": 0,
"person_id": 0,
"email": "string",
"show_nsfw": true,
"theme": "string",
"default_sort_type": "Active",
"default_listing_type": "All",
"interface_language": "string",
"show_avatars": true,
"send_notifications_to_email": true,
"show_scores": true,
"show_bot_accounts": true,
"show_read_posts": true,
"email_verified": true,
"accepted_application": true,
"open_links_in_new_tab": true,
"blur_nsfw": true,
"auto_expand": true,
"infinite_scroll_enabled": true,
"admin": true,
"post_listing_mode": "List",
"totp_2fa_enabled": true,
"enable_keyboard_navigation": true,
"enable_animated_images": true,
"collapse_bot_comments": true
},
"local_user_vote_display_mode": {"local_user_id": 0,
"score": true,
"upvotes": true,
"downvotes": true,
"upvote_percentage": true
},
"person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"counts": {"person_id": 0,
"post_count": 0,
"comment_count": 0
}
},
"follows": [{"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"follower": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
}
}
],
"moderates": [{"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"moderator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
}
}
],
"community_blocks": [{"person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
}
}
],
"instance_blocks": [{"person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"instance": {"id": 0,
"domain": "string",
"published": "string",
"updated": "string",
"software": "string",
"version": "string"
},
"site": {"id": 0,
"name": "string",
"sidebar": "string",
"published": "string",
"updated": "string",
"icon": "string",
"banner": "string",
"description": "string",
"actor_id": "string",
"last_refreshed_at": "string",
"inbox_url": "string",
"public_key": "string",
"instance_id": 0,
"content_warning": "string"
}
}
],
"person_blocks": [{"person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"target": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
}
}
],
"discussion_languages": [0
]
},
"all_languages": [{"id": 0,
"code": "string",
"name": "string"
}
],
"discussion_languages": [0
],
"taglines": [{"id": 0,
"local_site_id": 0,
"content": "string",
"published": "string",
"updated": "string"
}
],
"custom_emojis": [{"custom_emoji": {"id": 0,
"local_site_id": 0,
"shortcode": "string",
"image_url": "string",
"alt_text": "string",
"category": "string",
"published": "string",
"updated": "string"
},
"keywords": [{"custom_emoji_id": 0,
"keyword": "string"
}
]
}
],
"blocked_urls": [{"id": 0,
"url": "string",
"published": "string",
"updated": "string"
}
]
}

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

Payload

Content type

application/json

{"person_id": 0,
"added": true
}

Response samples

Content type

application/json

{"admins": [{"person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"counts": {"person_id": 0,
"post_count": 0,
"comment_count": 0
},
"is_admin": true
}
]
}

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": [{"registration_application": {"id": 0,
"local_user_id": 0,
"answer": "string",
"admin_id": 0,
"deny_reason": "string",
"published": "string"
},
"creator_local_user": {"id": 0,
"person_id": 0,
"email": "string",
"show_nsfw": true,
"theme": "string",
"default_sort_type": "Active",
"default_listing_type": "All",
"interface_language": "string",
"show_avatars": true,
"send_notifications_to_email": true,
"show_scores": true,
"show_bot_accounts": true,
"show_read_posts": true,
"email_verified": true,
"accepted_application": true,
"open_links_in_new_tab": true,
"blur_nsfw": true,
"auto_expand": true,
"infinite_scroll_enabled": true,
"admin": true,
"post_listing_mode": "List",
"totp_2fa_enabled": true,
"enable_keyboard_navigation": true,
"enable_animated_images": true,
"collapse_bot_comments": true
},
"creator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"admin": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
}
}
]
}

Approve a registration application

Authorizations:

bearerAuthcookieAuth

Request Body schema: application/json

id required	integer (RegistrationApplicationId)
approve required	boolean (ApproveRegistrationApplication.approve)
deny_reason	string (ApproveRegistrationApplication.deny_reason)

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"approve": true,
"deny_reason": "string"
}

Response samples

Content type

application/json

{"registration_application": {"registration_application": {"id": 0,
"local_user_id": 0,
"answer": "string",
"admin_id": 0,
"deny_reason": "string",
"published": "string"
},
"creator_local_user": {"id": 0,
"person_id": 0,
"email": "string",
"show_nsfw": true,
"theme": "string",
"default_sort_type": "Active",
"default_listing_type": "All",
"interface_language": "string",
"show_avatars": true,
"send_notifications_to_email": true,
"show_scores": true,
"show_bot_accounts": true,
"show_read_posts": true,
"email_verified": true,
"accepted_application": true,
"open_links_in_new_tab": true,
"blur_nsfw": true,
"auto_expand": true,
"infinite_scroll_enabled": true,
"admin": true,
"post_listing_mode": "List",
"totp_2fa_enabled": true,
"enable_keyboard_navigation": true,
"enable_animated_images": true,
"collapse_bot_comments": true
},
"creator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"admin": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
}
}
}

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

Payload

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

Payload

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

Payload

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

Payload

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

Payload

Content type

application/json

{"post_id": 0,
"page": 0,
"limit": 0
}

Response samples

Content type

application/json

{"post_likes": [{"creator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"creator_banned_from_community": true,
"score": 0
}
]
}

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

Payload

Content type

application/json

{"comment_id": 0,
"page": 0,
"limit": 0
}

Response samples

Content type

application/json

{"comment_likes": [{"creator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"creator_banned_from_community": true,
"score": 0
}
]
}

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

Payload

Content type

application/json

{"page": 0,
"limit": 0
}

Response samples

Content type

application/json

{"images": [{"local_image": {"local_user_id": 0,
"pictrs_alias": "string",
"pictrs_delete_token": "string",
"published": "string"
},
"person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
}
}
]
}

Get the application a user submitted when they first registered their account

Authorizations:

bearerAuthcookieAuth

Request Body schema: application/json

person_id

required

integer (PersonId)

Responses

Request samples

Payload

Content type

application/json

{"person_id": 0
}

Response samples

Content type

application/json

{"registration_application": {"registration_application": {"id": 0,
"local_user_id": 0,
"answer": "string",
"admin_id": 0,
"deny_reason": "string",
"published": "string"
},
"creator_local_user": {"id": 0,
"person_id": 0,
"email": "string",
"show_nsfw": true,
"theme": "string",
"default_sort_type": "Active",
"default_listing_type": "All",
"interface_language": "string",
"show_avatars": true,
"send_notifications_to_email": true,
"show_scores": true,
"show_bot_accounts": true,
"show_read_posts": true,
"email_verified": true,
"accepted_application": true,
"open_links_in_new_tab": true,
"blur_nsfw": true,
"auto_expand": true,
"infinite_scroll_enabled": true,
"admin": true,
"post_listing_mode": "List",
"totp_2fa_enabled": true,
"enable_keyboard_navigation": true,
"enable_animated_images": true,
"collapse_bot_comments": true
},
"creator": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"admin": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
}
}
}

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

Payload

Content type

application/json

{"community_id": 0,
"removed": true,
"reason": "string"
}

Response samples

Content type

application/json

{"community_view": {"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"subscribed": "Subscribed",
"blocked": true,
"counts": {"community_id": 0,
"subscribers": 0,
"posts": 0,
"comments": 0,
"published": "string",
"users_active_day": 0,
"users_active_week": 0,
"users_active_month": 0,
"users_active_half_year": 0,
"subscribers_local": 0
},
"banned_from_community": true
},
"discussion_languages": [0
]
}

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

Payload

Content type

application/json

{"community_id": 0,
"person_id": 0
}

Response samples

Content type

application/json

{"community_view": {"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"
},
"subscribed": "Subscribed",
"blocked": true,
"counts": {"community_id": 0,
"subscribers": 0,
"posts": 0,
"comments": 0,
"published": "string",
"users_active_day": 0,
"users_active_week": 0,
"users_active_month": 0,
"users_active_half_year": 0,
"subscribers_local": 0
},
"banned_from_community": true
},
"discussion_languages": [0
]
}

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

Payload

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": {"person": {"id": 0,
"name": "string",
"display_name": "string",
"avatar": "string",
"banned": true,
"published": "string",
"updated": "string",
"actor_id": "string",
"bio": "string",
"local": true,
"banner": "string",
"deleted": true,
"matrix_user_id": "string",
"bot_account": true,
"ban_expires": "string",
"instance_id": 0
},
"counts": {"person_id": 0,
"post_count": 0,
"comment_count": 0
},
"is_admin": true
},
"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

Payload

Content type

application/json

{"community_id": 0,
"person_id": 0,
"added": true
}

Response samples

Content type

application/json

{"moderators": [{"community": {"id": 0,
"name": "string",
"title": "string",
"description": "string",
"removed": true,
"published": "string",
"updated": "string",
"deleted": true,
"nsfw": true,
"actor_id": "string",
"local": true,
"icon": "string",
"banner": "string",
"hidden": true,
"posting_restricted_to_mods": true,
"instance_id": 0,
"visibility": "Public"