Download OpenAPI specification:
A javascript / typescript client for Lemmy
| image_upload_disabled | boolean |
| image_allow_video_uploads | boolean |
| image_max_upload_size | number <double> |
| image_max_banner_size | number <double> |
| image_max_avatar_size | number <double> |
| image_max_thumbnail_size | number <double> |
| image_upload_timeout_seconds | number <double> |
| image_proxy_bypass_domains | string |
| image_mode | string (ImageMode) Enum: "none" "store_link_previews" "proxy_all_images" A mode for setting how pictrs handles images. |
| suggested_multi_community_id | number <double> (MultiCommunityId) |
| email_notifications_disabled | boolean |
| nsfw_content_disallowed | boolean |
| comment_downvotes | string (FederationMode) Enum: "all" "local" "disable" The federation mode for an item |
| comment_upvotes | string (FederationMode) Enum: "all" "local" "disable" The federation mode for an item |
| post_downvotes | string (FederationMode) Enum: "all" "local" "disable" The federation mode for an item |
| post_upvotes | string (FederationMode) Enum: "all" "local" "disable" The federation mode for an item |
| federation_signed_fetch | boolean |
| reports_email_admins | boolean |
| content_warning | string |
| oauth_registration | boolean |
| registration_mode | string (RegistrationMode) Enum: "closed" "require_application" "open" The registration mode for your site. Determines what happens after a user signs up. |
| federation_enabled | boolean |
| rate_limit_import_user_settings_interval_seconds | number <double> |
| rate_limit_import_user_settings_max_requests | number <double> |
| rate_limit_search_interval_seconds | number <double> |
| rate_limit_search_max_requests | number <double> |
| rate_limit_comment_interval_seconds | number <double> |
| rate_limit_comment_max_requests | number <double> |
| rate_limit_image_interval_seconds | number <double> |
| rate_limit_image_max_requests | number <double> |
| rate_limit_register_interval_seconds | number <double> |
| rate_limit_register_max_requests | number <double> |
| rate_limit_post_interval_seconds | number <double> |
| rate_limit_post_max_requests | number <double> |
| rate_limit_message_interval_seconds | number <double> |
| rate_limit_message_max_requests | number <double> |
| slur_filter_regex | string |
| discussion_languages | Array of numbers <double> (LanguageId) [ items <double > ] |
| application_email_admins | boolean |
| legal_information | string |
| default_comment_sort_type | string (CommentSortType) Enum: "hot" "top" "new" "old" "controversial" The comment sort types. See here for descriptions: https://join-lemmy.org/docs/en/users/03-votes-and-ranking.html |
| default_items_per_page | number <double> |
| default_post_time_range_seconds | number <double> |
| default_post_sort_type | string (PostSortType) Enum: "active" "hot" "new" "old" "top" "most_comments" "new_comments" "controversial" "scaled" The post sort types. See here for descriptions: https://join-lemmy.org/docs/en/users/03-votes-and-ranking.html |
| default_post_listing_mode | string (PostListingMode) Enum: "list" "card" "small_card" A post-view mode that changes how multiple post listings look. |
| default_post_listing_type | string (ListingType) Enum: "all" "local" "subscribed" "moderator_view" "suggested" A listing type for post and comment list fetches. |
| default_theme | string |
| private_instance | boolean |
| application_question | string |
| email_verification_required | boolean |
| community_creation_admin_only | boolean |
| summary | string |
| sidebar | string |
| name required | string |
{- "image_upload_disabled": true,
- "image_allow_video_uploads": true,
- "image_max_upload_size": 0.1,
- "image_max_banner_size": 0.1,
- "image_max_avatar_size": 0.1,
- "image_max_thumbnail_size": 0.1,
- "image_upload_timeout_seconds": 0.1,
- "image_proxy_bypass_domains": "string",
- "image_mode": "none",
- "suggested_multi_community_id": 0.1,
- "email_notifications_disabled": true,
- "nsfw_content_disallowed": true,
- "comment_downvotes": "all",
- "comment_upvotes": "all",
- "post_downvotes": "all",
- "post_upvotes": "all",
- "federation_signed_fetch": true,
- "reports_email_admins": true,
- "content_warning": "string",
- "oauth_registration": true,
- "registration_mode": "closed",
- "federation_enabled": true,
- "rate_limit_import_user_settings_interval_seconds": 0.1,
- "rate_limit_import_user_settings_max_requests": 0.1,
- "rate_limit_search_interval_seconds": 0.1,
- "rate_limit_search_max_requests": 0.1,
- "rate_limit_comment_interval_seconds": 0.1,
- "rate_limit_comment_max_requests": 0.1,
- "rate_limit_image_interval_seconds": 0.1,
- "rate_limit_image_max_requests": 0.1,
- "rate_limit_register_interval_seconds": 0.1,
- "rate_limit_register_max_requests": 0.1,
- "rate_limit_post_interval_seconds": 0.1,
- "rate_limit_post_max_requests": 0.1,
- "rate_limit_message_interval_seconds": 0.1,
- "rate_limit_message_max_requests": 0.1,
- "slur_filter_regex": "string",
- "discussion_languages": [
- 0.1
], - "application_email_admins": true,
- "legal_information": "string",
- "default_comment_sort_type": "hot",
- "default_items_per_page": 0.1,
- "default_post_time_range_seconds": 0.1,
- "default_post_sort_type": "active",
- "default_post_listing_mode": "list",
- "default_post_listing_type": "all",
- "default_theme": "string",
- "private_instance": true,
- "application_question": "string",
- "email_verification_required": true,
- "community_creation_admin_only": true,
- "summary": "string",
- "sidebar": "string",
- "name": "string"
}{- "state": "empty"
}| image_upload_disabled | boolean |
| image_allow_video_uploads | boolean |
| image_max_upload_size | number <double> |
| image_max_banner_size | number <double> |
| image_max_avatar_size | number <double> |
| image_max_thumbnail_size | number <double> |
| image_upload_timeout_seconds | number <double> |
| image_proxy_bypass_domains | string Allows bypassing proxy for specific image hosts when using [[ImageMode.ProxyAllImages]]. Use a comma-delimited string. Example: i.imgur.com,postimg.cc |
| image_mode | string (ImageMode) Enum: "none" "store_link_previews" "proxy_all_images" A mode for setting how pictrs handles images. |
| suggested_multi_community_id | number <double> (MultiCommunityId) |
| email_notifications_disabled | boolean Dont send email notifications to users for new replies, mentions etc |
| nsfw_content_disallowed | boolean Block NSFW content being created |
| comment_downvotes | string (FederationMode) Enum: "all" "local" "disable" The federation mode for an item |
| comment_upvotes | string (FederationMode) Enum: "all" "local" "disable" The federation mode for an item |
| post_downvotes | string (FederationMode) Enum: "all" "local" "disable" The federation mode for an item |
| post_upvotes | string (FederationMode) Enum: "all" "local" "disable" The federation mode for an item |
| oauth_registration | boolean Whether or not external auth methods can auto-register users. |
| content_warning | string If present, nsfw content is visible by default. Should be displayed by frontends/clients when the site is first opened by a user. |
| reports_email_admins | boolean Whether to email admins for new reports. |
| registration_mode | string (RegistrationMode) Enum: "closed" "require_application" "open" The registration mode for your site. Determines what happens after a user signs up. |
| blocked_urls | Array of strings A list of blocked URLs |
| federation_enabled | boolean Whether to enable federation. |
| rate_limit_import_user_settings_interval_seconds | number <double> |
| rate_limit_import_user_settings_max_requests | number <double> The number of settings imports or exports allowed in a given time frame. |
| rate_limit_search_interval_seconds | number <double> |
| rate_limit_search_max_requests | number <double> The number of searches allowed in a given time frame. |
| rate_limit_comment_interval_seconds | number <double> |
| rate_limit_comment_max_requests | number <double> The number of comments allowed in a given time frame. |
| rate_limit_image_interval_seconds | number <double> |
| rate_limit_image_max_requests | number <double> The number of image uploads allowed in a given time frame. |
| rate_limit_register_interval_seconds | number <double> |
| rate_limit_register_max_requests | number <double> The number of registrations allowed in a given time frame. |
| rate_limit_post_interval_seconds | number <double> |
| rate_limit_post_max_requests | number <double> The number of posts allowed in a given time frame. |
| rate_limit_message_interval_seconds | number <double> |
| rate_limit_message_max_requests | number <double> The number of messages allowed in a given time frame. |
| slur_filter_regex | string A regex string of items to filter. |
| discussion_languages | Array of numbers <double> (LanguageId) [ items <double > ] A list of allowed discussion languages. |
| federation_signed_fetch | boolean Whether to sign outgoing Activitypub fetches with private key of local instance. Some Fediverse instances and platforms require this. |
| application_email_admins | boolean Whether to email admins when receiving a new application. |
| legal_information | string An optional page of legal information |
| default_comment_sort_type | string (CommentSortType) Enum: "hot" "top" "new" "old" "controversial" The comment sort types. See here for descriptions: https://join-lemmy.org/docs/en/users/03-votes-and-ranking.html |
| default_items_per_page | number <double> A default fetch limit for number of items returned. |
| default_post_time_range_seconds | number <double> A default time range limit to apply to post sorts, in seconds. 0 means none. |
| default_post_sort_type | string (PostSortType) Enum: "active" "hot" "new" "old" "top" "most_comments" "new_comments" "controversial" "scaled" The post sort types. See here for descriptions: https://join-lemmy.org/docs/en/users/03-votes-and-ranking.html |
| default_post_listing_mode | string (PostListingMode) Enum: "list" "card" "small_card" A post-view mode that changes how multiple post listings look. |
| default_post_listing_type | string (ListingType) Enum: "all" "local" "subscribed" "moderator_view" "suggested" A listing type for post and comment list fetches. |
| default_theme | string The default theme. Usually "browser" |
| private_instance | boolean Whether your instance is public, or private. |
| application_question | string Your application question form. This is in markdown, and can be many questions. |
| email_verification_required | boolean Whether to require email verification. |
| community_creation_admin_only | boolean Limits community creation to admins only. |
| summary | string A shorter, one line description of your site. |
| sidebar | string A sidebar for the site, in markdown. |
| name | string |
{- "image_upload_disabled": true,
- "image_allow_video_uploads": true,
- "image_max_upload_size": 0.1,
- "image_max_banner_size": 0.1,
- "image_max_avatar_size": 0.1,
- "image_max_thumbnail_size": 0.1,
- "image_upload_timeout_seconds": 0.1,
- "image_proxy_bypass_domains": "string",
- "image_mode": "none",
- "suggested_multi_community_id": 0.1,
- "email_notifications_disabled": true,
- "nsfw_content_disallowed": true,
- "comment_downvotes": "all",
- "comment_upvotes": "all",
- "post_downvotes": "all",
- "post_upvotes": "all",
- "oauth_registration": true,
- "content_warning": "string",
- "reports_email_admins": true,
- "registration_mode": "closed",
- "blocked_urls": [
- "string"
], - "federation_enabled": true,
- "rate_limit_import_user_settings_interval_seconds": 0.1,
- "rate_limit_import_user_settings_max_requests": 0.1,
- "rate_limit_search_interval_seconds": 0.1,
- "rate_limit_search_max_requests": 0.1,
- "rate_limit_comment_interval_seconds": 0.1,
- "rate_limit_comment_max_requests": 0.1,
- "rate_limit_image_interval_seconds": 0.1,
- "rate_limit_image_max_requests": 0.1,
- "rate_limit_register_interval_seconds": 0.1,
- "rate_limit_register_max_requests": 0.1,
- "rate_limit_post_interval_seconds": 0.1,
- "rate_limit_post_max_requests": 0.1,
- "rate_limit_message_interval_seconds": 0.1,
- "rate_limit_message_max_requests": 0.1,
- "slur_filter_regex": "string",
- "discussion_languages": [
- 0.1
], - "federation_signed_fetch": true,
- "application_email_admins": true,
- "legal_information": "string",
- "default_comment_sort_type": "hot",
- "default_items_per_page": 0.1,
- "default_post_time_range_seconds": 0.1,
- "default_post_sort_type": "active",
- "default_post_listing_mode": "list",
- "default_post_listing_type": "all",
- "default_theme": "string",
- "private_instance": true,
- "application_question": "string",
- "email_verification_required": true,
- "community_creation_admin_only": true,
- "summary": "string",
- "sidebar": "string",
- "name": "string"
}{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
{- "state": "empty"
}| reason required | string |
| hidden required | boolean |
| community_id required | number <double> (CommunityId) The community id. |
{- "reason": "string",
- "hidden": true,
- "community_id": 0.1
}{- "state": "empty"
}| resolved required | boolean |
| report_id required | number <double> (CommunityReportId) The community report id. |
{- "resolved": true,
- "report_id": 0.1
}{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
| post_id required | number <double> (PostId) The post id. |
{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
| comment_id required | number <double> (CommentId) The comment id. |
{- "state": "empty"
}| resolved required | boolean |
| report_id required | number <double> (PrivateMessageReportId) The private message report id. |
{- "resolved": true,
- "report_id": 0.1
}{- "state": "empty"
}| expires_at | number <double> A time that the ban will expire, in unix epoch seconds. An i64 unix timestamp is used for a simpler API client implementation. |
| reason required | string |
| remove_or_restore_data | boolean Optionally remove or restore all their data. Useful for new troll accounts. If ban is true, then this means remove. If ban is false, it means restore. |
| ban required | boolean |
| person_id required | number <double> (PersonId) The person id. |
{- "expires_at": 0.1,
- "reason": "string",
- "remove_or_restore_data": true,
- "ban": true,
- "person_id": 0.1
}{- "state": "empty"
}| limit | number <double> |
| sort | string (LocalUserSortType) Enum: "new" "old" The local user sort type. |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
| banned_only | boolean |
{- "state": "empty"
}| added required | boolean |
| person_id required | number <double> (PersonId) The person id. |
{- "added": true,
- "person_id": 0.1
}{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
| unread_only | boolean Only shows the unread applications (IE those without an admin actor) |
{- "state": "empty"
}| deny_reason | string |
| approve required | boolean |
| id required | number <double> (RegistrationApplicationId) The registration application id. |
{- "deny_reason": "string",
- "approve": true,
- "id": 0.1
}{- "state": "empty"
}| reason required | string |
| person_id required | number <double> (PersonId) The person id. |
{- "reason": "string",
- "person_id": 0.1
}{- "state": "empty"
}| reason required | string |
| community_id required | number <double> (CommunityId) The community id. |
{- "reason": "string",
- "community_id": 0.1
}{- "state": "empty"
}| reason required | string |
| post_id required | number <double> (PostId) The post id. |
{- "reason": "string",
- "post_id": 0.1
}{- "state": "empty"
}| reason required | string |
| comment_id required | number <double> (CommentId) The comment id. |
{- "reason": "string",
- "comment_id": 0.1
}{- "state": "empty"
}| content required | string |
| id required | number <double> (TaglineId) The tagline id. |
{- "content": "string",
- "id": 0.1
}{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
{- "state": "empty"
}| my_reports_only | boolean If true, view all your created reports. Works for non-admins/mods also. |
| show_community_rule_violations | boolean Only for admins: also show reports with |
| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
| community_id | number <double> (CommunityId) if no community is given, it returns reports for all communities moderated by the auth user |
| post_id | number <double> (PostId) Filter by the post id. Can return either comment or post reports. |
| type_ | string (ReportType) Enum: "all" "posts" "comments" "private_messages" "communities" Filter the type of report. |
| unresolved_only | boolean Only shows the unresolved reports |
{- "state": "empty"
}| expires_at | number <double> A time that the block will expire, in unix epoch seconds. An i64 unix timestamp is used for a simpler API client implementation. |
| reason required | string |
| block required | boolean |
| instance required | string |
{- "expires_at": 0.1,
- "reason": "string",
- "block": true,
- "instance": "string"
}{- "state": "empty"
}| reason required | string |
| allow required | boolean |
| instance required | string |
{- "reason": "string",
- "allow": true,
- "instance": "string"
}{- "state": "empty"
}| delete_content required | boolean |
| password required | string (SensitiveString) |
{- "delete_content": true,
- "password": "string"
}{- "state": "empty"
}| discussion_languages required | Array of strings |
| blocking_keywords required | Array of strings |
| blocked_instances_persons required | Array of strings |
| blocked_instances_communities required | Array of strings |
| blocked_users required | Array of strings |
| blocked_communities required | Array of strings |
| saved_comments required | Array of strings |
| saved_posts required | Array of strings |
| followed_communities required | Array of strings |
object (LocalUser) A local user. | |
| bot_account | boolean |
| matrix_id | string |
| banner | string |
| avatar | string |
| bio | string |
| display_name | string |
{- "discussion_languages": [
- "string"
], - "blocking_keywords": [
- "string"
], - "blocked_instances_persons": [
- "string"
], - "blocked_instances_communities": [
- "string"
], - "blocked_users": [
- "string"
], - "blocked_communities": [
- "string"
], - "saved_comments": [
- "string"
], - "saved_posts": [
- "string"
], - "followed_communities": [
- "string"
], - "settings": {
- "default_items_per_page": 0.1,
- "show_person_votes": true,
- "show_upvote_percentage": true,
- "show_downvotes": "show",
- "show_upvotes": true,
- "show_score": true,
- "default_post_time_range_seconds": 0.1,
- "hide_media": true,
- "auto_mark_fetched_posts_as_read": true,
- "default_comment_sort_type": "hot",
- "private_messages_enabled": true,
- "last_donation_notification_at": "string",
- "collapse_bot_comments": true,
- "animated_images_enabled": true,
- "totp_2fa_enabled": true,
- "post_listing_mode": "list",
- "admin": true,
- "infinite_scroll_enabled": true,
- "blur_nsfw": true,
- "open_links_in_new_tab": true,
- "accepted_application": true,
- "email_verified": true,
- "show_read_posts": true,
- "show_bot_accounts": true,
- "send_notifications_to_email": true,
- "show_avatars": true,
- "interface_language": "string",
- "default_listing_type": "all",
- "default_post_sort_type": "active",
- "theme": "string",
- "show_nsfw": true,
- "email": "string",
- "person_id": 0.1,
- "id": 0.1
}, - "bot_account": true,
- "matrix_id": "string",
- "banner": "string",
- "avatar": "string",
- "bio": "string",
- "display_name": "string"
}{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
{- "state": "empty"
}| enabled required | boolean |
| totp_token required | string |
{- "enabled": true,
- "totp_token": "string"
}{- "state": "empty"
}{- "state": "empty"
}| block required | boolean |
| community_id required | number <double> (CommunityId) The community id. |
{- "block": true,
- "community_id": 0.1
}{- "state": "empty"
}| stay_logged_in | boolean If this is true the login is valid forever, otherwise it expires after one week. |
| answer | string An answer is mandatory if require application is enabled on the server |
| honeypot | string A form field to trick signup bots. Should be None. |
| captcha_answer | string Your captcha answer. |
| captcha_uuid | string The UUID of the captcha item. |
string (SensitiveString) | |
| show_nsfw | boolean |
| password_verify required | string (SensitiveString) |
| password required | string (SensitiveString) |
| username required | string |
{- "stay_logged_in": true,
- "answer": "string",
- "honeypot": "string",
- "captcha_answer": "string",
- "captcha_uuid": "string",
- "email": "string",
- "show_nsfw": true,
- "password_verify": "string",
- "password": "string",
- "username": "string"
}{- "state": "empty"
}| stay_logged_in | boolean If this is true the login is valid forever, otherwise it expires after one week. |
| totp_2fa_token | string May be required, if totp is enabled for their account. |
| password required | string (SensitiveString) |
| username_or_email required | string (SensitiveString) |
{- "stay_logged_in": true,
- "totp_2fa_token": "string",
- "password": "string",
- "username_or_email": "string"
}{- "state": "empty"
}| block required | boolean |
| person_id required | number <double> (PersonId) The person id. |
{- "block": true,
- "person_id": 0.1
}{- "state": "empty"
}| password_verify required | string (SensitiveString) |
| password required | string (SensitiveString) |
| token required | string (SensitiveString) |
{- "password_verify": "string",
- "password": "string",
- "token": "string"
}{- "state": "empty"
}| read required | boolean |
| notification_id required | number <double> (NotificationId) |
{- "read": true,
- "notification_id": 0.1
}{- "state": "empty"
}| show_person_votes | boolean Whether to show vote totals given to others. |
| hide_media | boolean Whether to hide posts containing images/videos. |
| auto_mark_fetched_posts_as_read | boolean Whether to automatically mark fetched posts as read. |
| show_upvote_percentage | boolean |
| show_downvotes | string (VoteShow) Enum: "show" "show_for_others" "hide" Lets you show votes for others only, show all votes, or hide all votes. |
| show_upvotes | boolean |
| show_score | boolean Some vote display mode settings |
| collapse_bot_comments | boolean Whether to auto-collapse bot comments. |
| private_messages_enabled | boolean Whether a user can send / receive private messages |
| animated_images_enabled | boolean Whether user avatars or inline images in the UI that are gifs should be allowed to play or should be paused |
| infinite_scroll_enabled | boolean Enable infinite scroll |
| open_links_in_new_tab | boolean Open links in a new tab |
| blocking_keywords | Array of strings |
| discussion_languages | Array of numbers <double> (LanguageId) [ items <double > ] A list of languages you are able to see discussion in. |
| show_read_posts | boolean Whether to show read posts. |
| show_bot_accounts | boolean Whether to show bot accounts. |
| bot_account | boolean Whether this account is a bot account. Users can hide these accounts easily if they wish. |
| send_notifications_to_email | boolean Sends notifications to your email. |
| show_avatars | boolean Whether to show or hide avatars. |
| matrix_user_id | string Your matrix user id. Ex: |
| bio | string Your bio / info, in markdown. |
string (SensitiveString) | |
| display_name | string Your display name, which can contain strange characters, and does not need to be unique. |
| interface_language | string The language of the lemmy interface |
| default_comment_sort_type | string (CommentSortType) Enum: "hot" "top" "new" "old" "controversial" The comment sort types. See here for descriptions: https://join-lemmy.org/docs/en/users/03-votes-and-ranking.html |
| default_items_per_page | number <double> A default fetch limit for number of items returned. |
| default_post_time_range_seconds | number <double> A default time range limit to apply to post sorts, in seconds. 0 means none. |
| default_post_sort_type | string (PostSortType) Enum: "active" "hot" "new" "old" "top" "most_comments" "new_comments" "controversial" "scaled" The post sort types. See here for descriptions: https://join-lemmy.org/docs/en/users/03-votes-and-ranking.html |
| post_listing_mode | string (PostListingMode) Enum: "list" "card" "small_card" A post-view mode that changes how multiple post listings look. |
| default_listing_type | string (ListingType) Enum: "all" "local" "subscribed" "moderator_view" "suggested" A listing type for post and comment list fetches. |
| theme | string Your user's theme. |
| blur_nsfw | boolean Blur nsfw posts. |
| show_nsfw | boolean Show nsfw posts. |
{- "show_person_votes": true,
- "hide_media": true,
- "auto_mark_fetched_posts_as_read": true,
- "show_upvote_percentage": true,
- "show_downvotes": "show",
- "show_upvotes": true,
- "show_score": true,
- "collapse_bot_comments": true,
- "private_messages_enabled": true,
- "animated_images_enabled": true,
- "infinite_scroll_enabled": true,
- "open_links_in_new_tab": true,
- "blocking_keywords": [
- "string"
], - "discussion_languages": [
- 0.1
], - "show_read_posts": true,
- "show_bot_accounts": true,
- "bot_account": true,
- "send_notifications_to_email": true,
- "show_avatars": true,
- "matrix_user_id": "string",
- "bio": "string",
- "email": "string",
- "display_name": "string",
- "interface_language": "string",
- "default_comment_sort_type": "hot",
- "default_items_per_page": 0.1,
- "default_post_time_range_seconds": 0.1,
- "default_post_sort_type": "active",
- "post_listing_mode": "list",
- "default_listing_type": "all",
- "theme": "string",
- "blur_nsfw": true,
- "show_nsfw": true
}{- "state": "empty"
}| stay_logged_in | boolean If this is true the login is valid forever, otherwise it expires after one week. |
| old_password required | string (SensitiveString) |
| new_password_verify required | string (SensitiveString) |
| new_password required | string (SensitiveString) |
{- "stay_logged_in": true,
- "old_password": "string",
- "new_password_verify": "string",
- "new_password": "string"
}{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
| creator_id | number <double> (PersonId) The person id. |
| unread_only | boolean |
NotificationType (string) or string (NotificationTypeFilter) A list of possible types for the inbox. |
{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
| type_ | string (PersonContentType) Enum: "all" "comments" "posts" A list of possible types for a person's content. |
{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
| like_type | string (LikeType) Enum: "all" "liked_only" "disliked_only" The like_type for a persons liked content. |
| type_ | string (PersonContentType) Enum: "all" "comments" "posts" A list of possible types for a person's content. |
{- "state": "empty"
}| block required | boolean |
| instance_id required | number <double> (InstanceId) The instance id. |
{- "block": true,
- "instance_id": 0.1
}{- "state": "empty"
}| block required | boolean |
| instance_id required | number <double> (InstanceId) The instance id. |
{- "block": true,
- "instance_id": 0.1
}{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
{- "state": "empty"
}| id required | number <double> (CommunityId) The community id. |
{- "id": 0.1
}{- "state": "empty"
}| id required | number <double> (CommunityId) The community id. |
{- "id": 0.1
}{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
| bulk_action_parent_id | number <double> (ModlogId) Return only child entries triggered by this parent modlog action. |
| show_bulk | boolean When |
| comment_id | number <double> (CommentId) Filter by comment. |
| post_id | number <double> (PostId) Filter by post. Will include comments of that post. |
| other_person_id | number <double> (PersonId) Filter by the other / modded person. |
| listing_type | string (ListingType) Enum: "all" "local" "subscribed" "moderator_view" "suggested" Filter by listing type. When not using All, it will remove the non-community modlog entries, such as site bans, instance blocks, adding an admin, etc. |
ModlogKind (string) or string (ModlogKindFilter) Filter by the modlog action type. | |
| community_id | number <double> (CommunityId) Filter by the community. |
| mod_person_id | number <double> (PersonId) Filter by the moderator. |
{- "state": "empty"
}| limit | number <double> |
| page_cursor | string |
| show_nsfw | boolean If true, then show the nsfw posts (even if your user setting is to hide them) |
| post_url_only | boolean |
| title_only | boolean |
| listing_type | string (ListingType) Enum: "all" "local" "subscribed" "moderator_view" "suggested" A listing type for post and comment list fetches. |
| time_range_seconds | number <double> Filter to within a given time range, in seconds. IE 60 would give results for the past minute. |
| type_ | string (SearchType) Enum: "all" "comments" "posts" "communities" "users" "multi_communities" The type of content returned from a search. |
| creator_username | string |
| creator_id | number <double> (PersonId) The person id. |
| community_name | string |
| community_id | number <double> (CommunityId) The community id. |
| search_term required | string The search query. Can be a plain text, or an object ID which will be resolved
(eg |
{- "state": "empty"
}| q required | string Can be the full url, or a shortened version like: !fediverse@lemmy.ml |
{- "state": "empty"
}| limit | number <double> |
| sort | string (LocalUserSortType) Enum: "new" "old" The local user sort type. |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
| banned_only | boolean |
{- "state": "empty"
}| enabled | boolean |
| use_pkce | boolean |
| account_linking_enabled | boolean |
| auto_verify_email | boolean |
| scopes required | string |
| client_secret required | string |
| client_id required | string |
| id_claim required | string |
| userinfo_endpoint required | string |
| token_endpoint required | string |
| authorization_endpoint required | string |
| issuer required | string |
| display_name required | string |
{- "enabled": true,
- "use_pkce": true,
- "account_linking_enabled": true,
- "auto_verify_email": true,
- "scopes": "string",
- "client_secret": "string",
- "client_id": "string",
- "id_claim": "string",
- "userinfo_endpoint": "string",
- "token_endpoint": "string",
- "authorization_endpoint": "string",
- "issuer": "string",
- "display_name": "string"
}{- "state": "empty"
}| enabled | boolean |
| use_pkce | boolean |
| account_linking_enabled | boolean |
| auto_verify_email | boolean |
| scopes | string |
| client_secret | string |
| id_claim | string |
| userinfo_endpoint | string |
| token_endpoint | string |
| authorization_endpoint | string |
| display_name | string |
| id required | number <double> (OAuthProviderId) The oauth provider id. |
{- "enabled": true,
- "use_pkce": true,
- "account_linking_enabled": true,
- "auto_verify_email": true,
- "scopes": "string",
- "client_secret": "string",
- "id_claim": "string",
- "userinfo_endpoint": "string",
- "token_endpoint": "string",
- "authorization_endpoint": "string",
- "display_name": "string",
- "id": 0.1
}{- "state": "empty"
}| id required | number <double> (OAuthProviderId) The oauth provider id. |
{- "id": 0.1
}{- "state": "empty"
}| stay_logged_in | boolean If this is true the login is valid forever, otherwise it expires after one week. |
| pkce_code_verifier | string |
| answer | string An answer is mandatory if require application is enabled on the server |
| username | string Username is mandatory at registration time |
| show_nsfw | boolean |
| redirect_uri required | string |
| oauth_provider_id required | number <double> (OAuthProviderId) The oauth provider id. |
| code required | string |
{- "stay_logged_in": true,
- "pkce_code_verifier": "string",
- "answer": "string",
- "username": "string",
- "show_nsfw": true,
- "redirect_uri": "string",
- "oauth_provider_id": 0.1,
- "code": "string"
}{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
| kind required | string (GetFederatedInstancesKind) Enum: "all" "linked" "allowed" "blocked" |
| domain_filter | string |
{- "state": "empty"
}| visibility | string (CommunityVisibility) Enum: "public" "unlisted" "local_only_public" "local_only_private" "private" Defines who can browse and interact with content in a community. |
| discussion_languages | Array of numbers <double> (LanguageId) [ items <double > ] |
| posting_restricted_to_mods | boolean Whether to restrict posting only to moderators. |
| nsfw | boolean Whether its an NSFW community. |
| banner | string A banner URL. |
| icon | string An icon URL. |
| summary | string A shorter, one line summary of your community. |
| sidebar | string A sidebar for the community in markdown. |
| title required | string A longer title. |
| name required | string The unique name. |
{- "visibility": "public",
- "discussion_languages": [
- 0.1
], - "posting_restricted_to_mods": true,
- "nsfw": true,
- "banner": "string",
- "icon": "string",
- "summary": "string",
- "sidebar": "string",
- "title": "string",
- "name": "string"
}{- "state": "empty"
}| name | string Example: star_trek , or star_trek@xyz.tld |
| id | number <double> (CommunityId) The community id. |
{- "state": "empty"
}| visibility | string (CommunityVisibility) Enum: "public" "unlisted" "local_only_public" "local_only_private" "private" Defines who can browse and interact with content in a community. |
| discussion_languages | Array of numbers <double> (LanguageId) [ items <double > ] |
| posting_restricted_to_mods | boolean Whether to restrict posting only to moderators. |
| nsfw | boolean Whether its an NSFW community. |
| summary | string A shorter, one line summary of your community. |
| sidebar | string A sidebar for the community in markdown. |
| title | string A longer title. |
| community_id required | number <double> (CommunityId) The community id. |
{- "visibility": "public",
- "discussion_languages": [
- 0.1
], - "posting_restricted_to_mods": true,
- "nsfw": true,
- "summary": "string",
- "sidebar": "string",
- "title": "string",
- "community_id": 0.1
}{- "state": "empty"
}| deleted required | boolean |
| community_id required | number <double> (CommunityId) The community id. |
{- "deleted": true,
- "community_id": 0.1
}{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
| search_title_only | boolean |
| search_term | string |
| multi_community_id | number <double> (MultiCommunityId) |
| show_nsfw | boolean |
| time_range_seconds | number <double> Filter to within a given time range, in seconds. IE 60 would give results for the past minute. |
| sort | string (CommunitySortType) Enum: "active_six_months" "active_monthly" "active_weekly" "active_daily" "hot" "new" "old" "name_asc" "name_desc" "comments" "posts" "subscribers" "subscribers_local" The community sort types. See here for descriptions: https://join-lemmy.org/docs/en/users/03-votes-and-ranking.html |
| type_ | string (ListingType) Enum: "all" "local" "subscribed" "moderator_view" "suggested" A listing type for post and comment list fetches. |
{- "state": "empty"
}| follow required | boolean |
| community_id required | number <double> (CommunityId) The community id. |
{- "follow": true,
- "community_id": 0.1
}{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
| all_communities | boolean |
| unread_only | boolean Only shows the unapproved applications |
{- "state": "empty"
}| approve required | boolean |
| follower_id required | number <double> (PersonId) The person id. |
| community_id required | number <double> (CommunityId) The community id. |
{- "approve": true,
- "follower_id": 0.1,
- "community_id": 0.1
}{- "state": "empty"
}| block required | boolean |
| community_id required | number <double> (CommunityId) The community id. |
{- "block": true,
- "community_id": 0.1
}{- "state": "empty"
}| reason required | string |
| hidden required | boolean |
| community_id required | number <double> (CommunityId) The community id. |
{- "reason": "string",
- "hidden": true,
- "community_id": 0.1
}{- "state": "empty"
}| reason required | string |
| removed required | boolean |
| community_id required | number <double> (CommunityId) The community id. |
{- "reason": "string",
- "removed": true,
- "community_id": 0.1
}{- "state": "empty"
}| person_id required | number <double> (PersonId) The person id. |
| community_id required | number <double> (CommunityId) The community id. |
{- "person_id": 0.1,
- "community_id": 0.1
}{- "state": "empty"
}| expires_at | number <double> A time that the ban will expire, in unix epoch seconds. An i64 unix timestamp is used for a simpler API client implementation. |
| reason required | string |
| remove_or_restore_data | boolean Optionally remove or restore all their data. Useful for new troll accounts. If ban is true, then this means remove. If ban is false, it means restore. |
| ban required | boolean |
| person_id required | number <double> (PersonId) The person id. |
| community_id required | number <double> (CommunityId) The community id. |
{- "expires_at": 0.1,
- "reason": "string",
- "remove_or_restore_data": true,
- "ban": true,
- "person_id": 0.1,
- "community_id": 0.1
}{- "state": "empty"
}| added required | boolean |
| person_id required | number <double> (PersonId) The person id. |
| community_id required | number <double> (CommunityId) The community id. |
{- "added": true,
- "person_id": 0.1,
- "community_id": 0.1
}{- "state": "empty"
}| show_nsfw | boolean |
| type_ | string (ListingType) Enum: "all" "local" "subscribed" "moderator_view" "suggested" A listing type for post and comment list fetches. |
{- "state": "empty"
}| reason required | string |
| community_id required | number <double> (CommunityId) The community id. |
{- "reason": "string",
- "community_id": 0.1
}{- "state": "empty"
}| resolved required | boolean |
| report_id required | number <double> (CommunityReportId) The community report id. |
{- "resolved": true,
- "report_id": 0.1
}{- "state": "empty"
}| color | string (TagColor) Enum: "color01" "color02" "color03" "color04" "color05" "color06" "color07" "color08" "color09" "color10" Color of community tag. |
| summary | string |
| display_name | string |
| name required | string |
| community_id required | number <double> (CommunityId) The community id. |
{- "color": "color01",
- "summary": "string",
- "display_name": "string",
- "name": "string",
- "community_id": 0.1
}{- "state": "empty"
}| color | string (TagColor) Enum: "color01" "color02" "color03" "color04" "color05" "color06" "color07" "color08" "color09" "color10" Color of community tag. |
| summary | string |
| display_name | string |
| tag_id required | number <double> (CommunityTagId) The community tag id |
{- "color": "color01",
- "summary": "string",
- "display_name": "string",
- "tag_id": 0.1
}{- "state": "empty"
}| delete required | boolean |
| tag_id required | number <double> (CommunityTagId) The community tag id |
{- "delete": true,
- "tag_id": 0.1
}{- "state": "empty"
}| block required | boolean |
| instance_id required | number <double> (InstanceId) The instance id. |
{- "block": true,
- "instance_id": 0.1
}{- "state": "empty"
}| id required | number <double> (CommunityId) The community id. |
{- "id": 0.1
}{- "state": "empty"
}| id required | number <double> (CommunityId) The community id. |
{- "id": 0.1
}{- "state": "empty"
}| mode required | string (CommunityNotificationsMode) Enum: "all_posts_and_comments" "all_posts" "replies_and_mentions" "mute" Available settings for community notifications |
| community_id required | number <double> (CommunityId) The community id. |
{- "mode": "all_posts_and_comments",
- "community_id": 0.1
}{- "state": "empty"
}| reason required | string |
| removed required | boolean |
| community_id required | number <double> (CommunityId) The community id. |
{- "reason": "string",
- "removed": true,
- "community_id": 0.1
}{- "state": "empty"
}| person_id required | number <double> (PersonId) The person id. |
| community_id required | number <double> (CommunityId) The community id. |
{- "person_id": 0.1,
- "community_id": 0.1
}{- "state": "empty"
}| expires_at | number <double> A time that the ban will expire, in unix epoch seconds. An i64 unix timestamp is used for a simpler API client implementation. |
| reason required | string |
| remove_or_restore_data | boolean Optionally remove or restore all their data. Useful for new troll accounts. If ban is true, then this means remove. If ban is false, it means restore. |
| ban required | boolean |
| person_id required | number <double> (PersonId) The person id. |
| community_id required | number <double> (CommunityId) The community id. |
{- "expires_at": 0.1,
- "reason": "string",
- "remove_or_restore_data": true,
- "ban": true,
- "person_id": 0.1,
- "community_id": 0.1
}{- "state": "empty"
}| added required | boolean |
| person_id required | number <double> (PersonId) The person id. |
| community_id required | number <double> (CommunityId) The community id. |
{- "added": true,
- "person_id": 0.1,
- "community_id": 0.1
}{- "state": "empty"
}| remove_children | boolean Setting this will override whatever |
| reason required | string |
| removed required | boolean |
| post_id required | number <double> (PostId) The post id. |
{- "remove_children": true,
- "reason": "string",
- "removed": true,
- "post_id": 0.1
}{- "state": "empty"
}| feature_type required | string (PostFeatureType) Enum: "local" "community" The feature type for a post. |
| featured required | boolean |
| post_id required | number <double> (PostId) The post id. |
{- "feature_type": "local",
- "featured": true,
- "post_id": 0.1
}{- "state": "empty"
}| resolved required | boolean |
| report_id required | number <double> (PostReportId) The post report id. |
{- "resolved": true,
- "report_id": 0.1
}{- "state": "empty"
}| remove_children | boolean Setting this will override whatever |
| reason required | string |
| removed required | boolean |
| comment_id required | number <double> (CommentId) The comment id. |
{- "remove_children": true,
- "reason": "string",
- "removed": true,
- "comment_id": 0.1
}{- "state": "empty"
}| reason required | string |
| locked required | boolean |
| comment_id required | number <double> (CommentId) The comment id. |
{- "reason": "string",
- "locked": true,
- "comment_id": 0.1
}{- "state": "empty"
}| distinguished required | boolean |
| comment_id required | number <double> (CommentId) The comment id. |
{- "distinguished": true,
- "comment_id": 0.1
}{- "state": "empty"
}| resolved required | boolean |
| report_id required | number <double> (CommentReportId) The comment report id. |
{- "resolved": true,
- "report_id": 0.1
}{- "state": "empty"
}| scheduled_publish_time_at | number <double> Time when this post should be scheduled. Null means publish immediately. |
| tags | Array of numbers <double> (CommunityTagId) [ items <double > ] |
| custom_thumbnail | string Instead of fetching a thumbnail, use a custom one. |
| language_id | number <double> (LanguageId) The language id. |
| nsfw | boolean |
| honeypot | string A honeypot to catch bots. Should be None. |
| alt_text | string An optional alt_text, usable for image posts. |
| body | string An optional body for the post in markdown. |
| url | string |
| community_id required | number <double> (CommunityId) The community id. |
| name required | string |
{- "scheduled_publish_time_at": 0.1,
- "tags": [
- 0.1
], - "custom_thumbnail": "string",
- "language_id": 0.1,
- "nsfw": true,
- "honeypot": "string",
- "alt_text": "string",
- "body": "string",
- "url": "string",
- "community_id": 0.1,
- "name": "string"
}{- "state": "empty"
}| tags | Array of numbers <double> (CommunityTagId) [ items <double > ] |
| scheduled_publish_time_at | number <double> Time when this post should be scheduled. Null means publish immediately. |
| custom_thumbnail | string Instead of fetching a thumbnail, use a custom one. |
| language_id | number <double> (LanguageId) The language id. |
| nsfw | boolean |
| alt_text | string An optional alt_text, usable for image posts. |
| body | string An optional body for the post in markdown. |
| url | string |
| name | string |
| post_id required | number <double> (PostId) The post id. |
{- "tags": [
- 0.1
], - "scheduled_publish_time_at": 0.1,
- "custom_thumbnail": "string",
- "language_id": 0.1,
- "nsfw": true,
- "alt_text": "string",
- "body": "string",
- "url": "string",
- "name": "string",
- "post_id": 0.1
}{- "state": "empty"
}| deleted required | boolean |
| post_id required | number <double> (PostId) The post id. |
{- "deleted": true,
- "post_id": 0.1
}{- "state": "empty"
}| tags | Array of numbers <double> (CommunityTagId) [ items <double > ] |
| nsfw | boolean |
| post_id required | number <double> (PostId) The post id. |
{- "tags": [
- 0.1
], - "nsfw": true,
- "post_id": 0.1
}{- "state": "empty"
}| reason required | string |
| post_id required | number <double> (PostId) The post id. |
{- "reason": "string",
- "post_id": 0.1
}{- "state": "empty"
}| remove_children | boolean Setting this will override whatever |
| reason required | string |
| removed required | boolean |
| post_id required | number <double> (PostId) The post id. |
{- "remove_children": true,
- "reason": "string",
- "removed": true,
- "post_id": 0.1
}{- "state": "empty"
}| read required | boolean |
| post_id required | number <double> (PostId) The post id. |
{- "read": true,
- "post_id": 0.1
}{- "state": "empty"
}| read required | boolean |
| post_ids required | Array of numbers <double> (PostId) [ items <double > ] |
{- "read": true,
- "post_ids": [
- 0.1
]
}{- "state": "empty"
}| hide required | boolean |
| post_id required | number <double> (PostId) The post id. |
{- "hide": true,
- "post_id": 0.1
}{- "state": "empty"
}| reason required | string |
| locked required | boolean |
| post_id required | number <double> (PostId) The post id. |
{- "reason": "string",
- "locked": true,
- "post_id": 0.1
}{- "state": "empty"
}| feature_type required | string (PostFeatureType) Enum: "local" "community" The feature type for a post. |
| featured required | boolean |
| post_id required | number <double> (PostId) The post id. |
{- "feature_type": "local",
- "featured": true,
- "post_id": 0.1
}{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
| search_url_only | boolean |
| search_title_only | boolean |
| search_term | string |
| no_comments_only | boolean If true, then only show posts with no comments |
| mark_as_read | boolean Whether to automatically mark fetched posts as read. |
| hide_media | boolean If false, then show posts with media attached (even if your user setting is to hide them) |
| show_nsfw | boolean If true, then show the nsfw posts (even if your user setting is to hide them) |
| show_read | boolean If true, then show the read posts (even if your user setting is to hide them) |
| show_hidden | boolean |
| multi_community_name | string |
| multi_community_id | number <double> (MultiCommunityId) |
| creator_username | string |
| creator_id | number <double> (PersonId) The person id. |
| community_name | string |
| community_id | number <double> (CommunityId) The community id. |
| time_range_seconds | number <double> Filter to within a given time range, in seconds. IE 60 would give results for the past minute. Use Zero to override the local_site and local_user time_range. |
| sort | string (PostSortType) Enum: "active" "hot" "new" "old" "top" "most_comments" "new_comments" "controversial" "scaled" The post sort types. See here for descriptions: https://join-lemmy.org/docs/en/users/03-votes-and-ranking.html |
| type_ | string (ListingType) Enum: "all" "local" "subscribed" "moderator_view" "suggested" A listing type for post and comment list fetches. |
{- "state": "empty"
}| is_upvote | boolean True means Upvote, False means Downvote, and None means remove vote. |
| post_id required | number <double> (PostId) The post id. |
{- "is_upvote": true,
- "post_id": 0.1
}{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
| post_id required | number <double> (PostId) The post id. |
{- "state": "empty"
}| save required | boolean |
| post_id required | number <double> (PostId) The post id. |
{- "save": true,
- "post_id": 0.1
}{- "state": "empty"
}| violates_instance_rules | boolean The post violates rules of the local instance. This report will only be shown to local admins, not to community mods and will not be federated. |
| reason required | string |
| post_id required | number <double> (PostId) The post id. |
{- "violates_instance_rules": true,
- "reason": "string",
- "post_id": 0.1
}{- "state": "empty"
}| resolved required | boolean |
| report_id required | number <double> (PostReportId) The post report id. |
{- "resolved": true,
- "report_id": 0.1
}{- "state": "empty"
}| mode required | string (PostNotificationsMode) Enum: "all_comments" "replies_and_mentions" "mute" Available settings for post notifications |
| post_id required | number <double> (PostId) The post id. |
{- "mode": "all_comments",
- "post_id": 0.1
}{- "state": "empty"
}| language_id | number <double> (LanguageId) The language id. |
| parent_id | number <double> (CommentId) The comment id. |
| post_id required | number <double> (PostId) The post id. |
| content required | string |
{- "language_id": 0.1,
- "parent_id": 0.1,
- "post_id": 0.1,
- "content": "string"
}{- "state": "empty"
}| language_id | number <double> (LanguageId) The language id. |
| content | string |
| comment_id required | number <double> (CommentId) The comment id. |
{- "language_id": 0.1,
- "content": "string",
- "comment_id": 0.1
}{- "state": "empty"
}| deleted required | boolean |
| comment_id required | number <double> (CommentId) The comment id. |
{- "deleted": true,
- "comment_id": 0.1
}{- "state": "empty"
}| remove_children | boolean Setting this will override whatever |
| reason required | string |
| removed required | boolean |
| comment_id required | number <double> (CommentId) The comment id. |
{- "remove_children": true,
- "reason": "string",
- "removed": true,
- "comment_id": 0.1
}{- "state": "empty"
}| reason required | string |
| locked required | boolean |
| comment_id required | number <double> (CommentId) The comment id. |
{- "reason": "string",
- "locked": true,
- "comment_id": 0.1
}{- "state": "empty"
}| is_upvote | boolean True means Upvote, False means Downvote, and None means remove vote. |
| comment_id required | number <double> (CommentId) The comment id. |
{- "is_upvote": true,
- "comment_id": 0.1
}{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
| comment_id required | number <double> (CommentId) The comment id. |
{- "state": "empty"
}| save required | boolean |
| comment_id required | number <double> (CommentId) The comment id. |
{- "save": true,
- "comment_id": 0.1
}{- "state": "empty"
}| distinguished required | boolean |
| comment_id required | number <double> (CommentId) The comment id. |
{- "distinguished": true,
- "comment_id": 0.1
}{- "state": "empty"
}| search_term | string |
| parent_id | number <double> (CommentId) The comment id. |
| post_id | number <double> (PostId) The post id. |
| creator_username | string |
| creator_id | number <double> (PersonId) The person id. |
| community_name | string |
| community_id | number <double> (CommunityId) The community id. |
| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
| max_depth | number <double> |
| time_range_seconds | number <double> Filter to within a given time range, in seconds. IE 60 would give results for the past minute. |
| sort | string (CommentSortType) Enum: "hot" "top" "new" "old" "controversial" The comment sort types. See here for descriptions: https://join-lemmy.org/docs/en/users/03-votes-and-ranking.html |
| type_ | string (ListingType) Enum: "all" "local" "subscribed" "moderator_view" "suggested" A listing type for post and comment list fetches. |
{- "state": "empty"
}| search_term | string |
| parent_id | number <double> (CommentId) The comment id. |
| post_id | number <double> (PostId) The post id. |
| creator_username | string |
| creator_id | number <double> (PersonId) The person id. |
| community_name | string |
| community_id | number <double> (CommunityId) The community id. |
| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
| max_depth | number <double> |
| time_range_seconds | number <double> Filter to within a given time range, in seconds. IE 60 would give results for the past minute. |
| sort | string (CommentSortType) Enum: "hot" "top" "new" "old" "controversial" The comment sort types. See here for descriptions: https://join-lemmy.org/docs/en/users/03-votes-and-ranking.html |
| type_ | string (ListingType) Enum: "all" "local" "subscribed" "moderator_view" "suggested" A listing type for post and comment list fetches. |
{- "state": "empty"
}| reason required | string |
| comment_id required | number <double> (CommentId) The comment id. |
{- "reason": "string",
- "comment_id": 0.1
}{- "state": "empty"
}| violates_instance_rules | boolean The comment violates rules of the local instance. This report will only be shown to local admins, not to community mods and will not be federated. |
| reason required | string |
| comment_id required | number <double> (CommentId) The comment id. |
{- "violates_instance_rules": true,
- "reason": "string",
- "comment_id": 0.1
}{- "state": "empty"
}| resolved required | boolean |
| report_id required | number <double> (CommentReportId) The comment report id. |
{- "resolved": true,
- "report_id": 0.1
}{- "state": "empty"
}| recipient_id required | number <double> (PersonId) The person id. |
| content required | string |
{- "recipient_id": 0.1,
- "content": "string"
}{- "state": "empty"
}| content required | string |
| private_message_id required | number <double> (PrivateMessageId) The private message id. |
{- "content": "string",
- "private_message_id": 0.1
}{- "state": "empty"
}| deleted required | boolean |
| private_message_id required | number <double> (PrivateMessageId) The private message id. |
{- "deleted": true,
- "private_message_id": 0.1
}{- "state": "empty"
}| reason required | string |
| private_message_id required | number <double> (PrivateMessageId) The private message id. |
{- "reason": "string",
- "private_message_id": 0.1
}{- "state": "empty"
}| resolved required | boolean |
| report_id required | number <double> (PrivateMessageReportId) The private message report id. |
{- "resolved": true,
- "report_id": 0.1
}{- "state": "empty"
}| username | string Example: dessalines , or dessalines@xyz.tld |
| person_id | number <double> (PersonId) The person id. |
{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
| community_name | string |
| community_id | number <double> (CommunityId) The community id. |
| username | string Example: dessalines , or dessalines@xyz.tld |
| person_id | number <double> (PersonId) The person id. |
| type_ | string (PersonContentType) Enum: "all" "comments" "posts" A list of possible types for a person's content. |
{- "state": "empty"
}| note required | string |
| person_id required | number <double> (PersonId) The person id. |
{- "note": "string",
- "person_id": 0.1
}{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
| search_title_only | boolean |
| search_term | string |
| sort | string (PersonSortType) Enum: "new" "old" "post_score" "comment_score" The person sort type. |
| type_ | string (PersonListingType) Enum: "all" "local" A listing type for person fetches |
{- "state": "empty"
}| block required | boolean |
| instance_id required | number <double> (InstanceId) The instance id. |
{- "block": true,
- "instance_id": 0.1
}{- "state": "empty"
}| keywords required | Array of strings |
| alt_text required | string |
| image_url required | string (DbUrl) |
| shortcode required | string |
| category required | string |
{- "keywords": [
- "string"
], - "alt_text": "string",
- "image_url": "string",
- "shortcode": "string",
- "category": "string"
}{- "state": "empty"
}| keywords | Array of strings |
| alt_text | string |
| image_url | string (DbUrl) |
| shortcode | string |
| category | string |
| id required | number <double> (CustomEmojiId) The custom emoji id. |
{- "keywords": [
- "string"
], - "alt_text": "string",
- "image_url": "string",
- "shortcode": "string",
- "category": "string",
- "id": 0.1
}{- "state": "empty"
}| id required | number <double> (CustomEmojiId) The custom emoji id. |
{- "id": 0.1
}{- "state": "empty"
}| content required | string |
| id required | number <double> (TaglineId) The tagline id. |
{- "content": "string",
- "id": 0.1
}{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
{- "state": "empty"
}| enabled | boolean |
| use_pkce | boolean |
| account_linking_enabled | boolean |
| auto_verify_email | boolean |
| scopes required | string |
| client_secret required | string |
| client_id required | string |
| id_claim required | string |
| userinfo_endpoint required | string |
| token_endpoint required | string |
| authorization_endpoint required | string |
| issuer required | string |
| display_name required | string |
{- "enabled": true,
- "use_pkce": true,
- "account_linking_enabled": true,
- "auto_verify_email": true,
- "scopes": "string",
- "client_secret": "string",
- "client_id": "string",
- "id_claim": "string",
- "userinfo_endpoint": "string",
- "token_endpoint": "string",
- "authorization_endpoint": "string",
- "issuer": "string",
- "display_name": "string"
}{- "state": "empty"
}| enabled | boolean |
| use_pkce | boolean |
| account_linking_enabled | boolean |
| auto_verify_email | boolean |
| scopes | string |
| client_secret | string |
| id_claim | string |
| userinfo_endpoint | string |
| token_endpoint | string |
| authorization_endpoint | string |
| display_name | string |
| id required | number <double> (OAuthProviderId) The oauth provider id. |
{- "enabled": true,
- "use_pkce": true,
- "account_linking_enabled": true,
- "auto_verify_email": true,
- "scopes": "string",
- "client_secret": "string",
- "id_claim": "string",
- "userinfo_endpoint": "string",
- "token_endpoint": "string",
- "authorization_endpoint": "string",
- "display_name": "string",
- "id": 0.1
}{- "state": "empty"
}| id required | number <double> (OAuthProviderId) The oauth provider id. |
{- "id": 0.1
}{- "state": "empty"
}| stay_logged_in | boolean If this is true the login is valid forever, otherwise it expires after one week. |
| pkce_code_verifier | string |
| answer | string An answer is mandatory if require application is enabled on the server |
| username | string Username is mandatory at registration time |
| show_nsfw | boolean |
| redirect_uri required | string |
| oauth_provider_id required | number <double> (OAuthProviderId) The oauth provider id. |
| code required | string |
{- "stay_logged_in": true,
- "pkce_code_verifier": "string",
- "answer": "string",
- "username": "string",
- "show_nsfw": true,
- "redirect_uri": "string",
- "oauth_provider_id": 0.1,
- "code": "string"
}{- "state": "empty"
}| sidebar | string |
| summary | string |
| title | string |
| name required | string |
{- "sidebar": "string",
- "summary": "string",
- "title": "string",
- "name": "string"
}{- "state": "empty"
}| deleted | boolean |
| sidebar | string |
| summary | string |
| title | string |
| id required | number <double> (MultiCommunityId) |
{- "deleted": true,
- "sidebar": "string",
- "summary": "string",
- "title": "string",
- "id": 0.1
}{- "state": "empty"
}| community_id required | number <double> (CommunityId) The community id. |
| id required | number <double> (MultiCommunityId) |
{- "community_id": 0.1,
- "id": 0.1
}{- "state": "empty"
}| community_id required | number <double> (CommunityId) The community id. |
| id required | number <double> (MultiCommunityId) |
{- "community_id": 0.1,
- "id": 0.1
}{- "state": "empty"
}| limit | number <double> |
| page_cursor | string (PaginationCursor) To get the next or previous page, pass this string unchanged as Do not attempt to parse or modify the cursor string. The format is internal and may change in minor Lemmy versions. |
| search_title_only | boolean |
| search_term | string |
| time_range_seconds | number <double> Filter to within a given time range, in seconds. IE 60 would give results for the past minute. |
| creator_id | number <double> (PersonId) The person id. |
| sort | string (MultiCommunitySortType) Enum: "new" "old" "name_asc" "name_desc" "communities" "subscribers" "subscribers_local" |
| type_ | string (MultiCommunityListingType) Enum: "all" "local" "subscribed" A listing type for multi-community fetches. |
{- "state": "empty"
}| follow required | boolean |
| multi_community_id required | number <double> (MultiCommunityId) |
{- "follow": true,
- "multi_community_id": 0.1
}{- "state": "empty"
}