Download OpenAPI specification:Download
Documentation for interacting with content on Mbin through the API
entry_id required | integer The entry to purge |
{- "title": "An error occurred",
- "status": 401,
- "detail": "Unauthorized"
}
entry_id required | integer The entry to move |
target_id required | integer The magazine to move the entry to |
{- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
comment_id required | integer The comment to purge |
{- "title": "An error occurred",
- "status": 401,
- "detail": "Unauthorized"
}
comment_id required | integer The comment to purge |
{- "title": "An error occurred",
- "status": 401,
- "detail": "Unauthorized"
}
p | integer >= 1 Default: 1 Page of users to retrieve |
perPage | integer [ 1 .. 100 ] Default: 48 Number of users per page |
group | string Default: "all" Enum: "all" "local" "remote" What group of users to retrieve |
{- "items": [
- {
- "isBanned": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
user_id required | integer The user to ban |
{- "isBanned": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
user_id required | integer The user to unban |
{- "isBanned": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
user_id required | integer The user to delete |
{- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
user_id required | integer The user to verify |
{- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
p | integer >= 1 Default: 1 Page of users to retrieve |
{- "items": [
- {
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
{- "KBIN_DOMAIN": "string",
- "KBIN_TITLE": "string",
- "KBIN_META_TITLE": "string",
- "KBIN_META_KEYWORDS": "string",
- "KBIN_META_DESCRIPTION": "string",
- "KBIN_DEFAULT_LANG": "string",
- "KBIN_CONTACT_EMAIL": "string",
- "KBIN_SENDER_EMAIL": "string",
- "MBIN_DEFAULT_THEME": "string",
- "KBIN_JS_ENABLED": true,
- "KBIN_FEDERATION_ENABLED": true,
- "KBIN_REGISTRATIONS_ENABLED": true,
- "KBIN_BANNED_INSTANCES": [
- "string"
], - "KBIN_HEADER_LOGO": true,
- "KBIN_CAPTCHA_ENABLED": true,
- "KBIN_MERCURE_ENABLED": true,
- "KBIN_FEDERATION_PAGE_ENABLED": true,
- "KBIN_ADMIN_ONLY_OAUTH_CLIENTS": true,
- "MBIN_SSO_ONLY_MODE": true,
- "MBIN_PRIVATE_INSTANCE": true,
- "KBIN_FEDERATED_SEARCH_ONLY_LOGGEDIN": true,
- "MBIN_SIDEBAR_SECTIONS_LOCAL_ONLY": true,
- "MBIN_SSO_REGISTRATIONS_ENABLED": true,
- "MBIN_RESTRICT_MAGAZINE_CREATION": true,
- "MBIN_SSO_SHOW_FIRST": true,
- "MAX_IMAGE_BYTES": 0,
- "MBIN_DOWNVOTES_MODE": "string",
- "MBIN_NEW_USERS_NEED_APPROVAL": true
}
KBIN_DOMAIN required | string |
KBIN_TITLE required | string |
KBIN_META_TITLE required | string |
KBIN_META_KEYWORDS required | string |
KBIN_META_DESCRIPTION required | string |
KBIN_DEFAULT_LANG required | string |
KBIN_CONTACT_EMAIL required | string |
KBIN_SENDER_EMAIL required | string |
MBIN_DEFAULT_THEME required | string |
KBIN_JS_ENABLED required | boolean |
KBIN_FEDERATION_ENABLED required | boolean |
KBIN_REGISTRATIONS_ENABLED required | boolean |
KBIN_BANNED_INSTANCES required | Array of strings |
KBIN_HEADER_LOGO required | boolean |
KBIN_CAPTCHA_ENABLED required | boolean |
KBIN_MERCURE_ENABLED required | boolean |
KBIN_FEDERATION_PAGE_ENABLED required | boolean |
KBIN_ADMIN_ONLY_OAUTH_CLIENTS required | boolean |
MBIN_SSO_ONLY_MODE required | boolean |
MBIN_PRIVATE_INSTANCE required | boolean |
KBIN_FEDERATED_SEARCH_ONLY_LOGGEDIN required | boolean |
MBIN_SIDEBAR_SECTIONS_LOCAL_ONLY required | boolean |
MBIN_SSO_REGISTRATIONS_ENABLED required | boolean |
MBIN_RESTRICT_MAGAZINE_CREATION required | boolean |
MBIN_SSO_SHOW_FIRST required | boolean |
MAX_IMAGE_BYTES required | integer |
MBIN_DOWNVOTES_MODE required | string |
MBIN_NEW_USERS_NEED_APPROVAL required | boolean |
{- "KBIN_DOMAIN": "string",
- "KBIN_TITLE": "string",
- "KBIN_META_TITLE": "string",
- "KBIN_META_KEYWORDS": "string",
- "KBIN_META_DESCRIPTION": "string",
- "KBIN_DEFAULT_LANG": "string",
- "KBIN_CONTACT_EMAIL": "string",
- "KBIN_SENDER_EMAIL": "string",
- "MBIN_DEFAULT_THEME": "string",
- "KBIN_JS_ENABLED": true,
- "KBIN_FEDERATION_ENABLED": true,
- "KBIN_REGISTRATIONS_ENABLED": true,
- "KBIN_BANNED_INSTANCES": [
- "string"
], - "KBIN_HEADER_LOGO": true,
- "KBIN_CAPTCHA_ENABLED": true,
- "KBIN_MERCURE_ENABLED": true,
- "KBIN_FEDERATION_PAGE_ENABLED": true,
- "KBIN_ADMIN_ONLY_OAUTH_CLIENTS": true,
- "MBIN_SSO_ONLY_MODE": true,
- "MBIN_PRIVATE_INSTANCE": true,
- "KBIN_FEDERATED_SEARCH_ONLY_LOGGEDIN": true,
- "MBIN_SIDEBAR_SECTIONS_LOCAL_ONLY": true,
- "MBIN_SSO_REGISTRATIONS_ENABLED": true,
- "MBIN_RESTRICT_MAGAZINE_CREATION": true,
- "MBIN_SSO_SHOW_FIRST": true,
- "MAX_IMAGE_BYTES": 0,
- "MBIN_DOWNVOTES_MODE": "string",
- "MBIN_NEW_USERS_NEED_APPROVAL": true
}
{- "KBIN_DOMAIN": "string",
- "KBIN_TITLE": "string",
- "KBIN_META_TITLE": "string",
- "KBIN_META_KEYWORDS": "string",
- "KBIN_META_DESCRIPTION": "string",
- "KBIN_DEFAULT_LANG": "string",
- "KBIN_CONTACT_EMAIL": "string",
- "KBIN_SENDER_EMAIL": "string",
- "MBIN_DEFAULT_THEME": "string",
- "KBIN_JS_ENABLED": true,
- "KBIN_FEDERATION_ENABLED": true,
- "KBIN_REGISTRATIONS_ENABLED": true,
- "KBIN_BANNED_INSTANCES": [
- "string"
], - "KBIN_HEADER_LOGO": true,
- "KBIN_CAPTCHA_ENABLED": true,
- "KBIN_MERCURE_ENABLED": true,
- "KBIN_FEDERATION_PAGE_ENABLED": true,
- "KBIN_ADMIN_ONLY_OAUTH_CLIENTS": true,
- "MBIN_SSO_ONLY_MODE": true,
- "MBIN_PRIVATE_INSTANCE": true,
- "KBIN_FEDERATED_SEARCH_ONLY_LOGGEDIN": true,
- "MBIN_SIDEBAR_SECTIONS_LOCAL_ONLY": true,
- "MBIN_SSO_REGISTRATIONS_ENABLED": true,
- "MBIN_RESTRICT_MAGAZINE_CREATION": true,
- "MBIN_SSO_SHOW_FIRST": true,
- "MAX_IMAGE_BYTES": 0,
- "MBIN_DOWNVOTES_MODE": "string",
- "MBIN_NEW_USERS_NEED_APPROVAL": true
}
page required | string Enum: "about" "contact" "faq" "privacyPolicy" "terms" |
body required | string |
{- "body": "string"
}
{- "about": "string",
- "contact": "string",
- "faq": "string",
- "privacyPolicy": "string",
- "terms": "string",
- "downvotesMode": "disabled"
}
start | string <date> The start date of the window to retrieve views in. If not provided defaults to 1 |
end | string <date> The end date of the window to retrieve views in. If not provided defaults to today |
resolution required | string Enum: "all" "year" "month" "day" "hour" "second" "milliseconds" The size of chunks to aggregate views in |
{- "data": [
- {
- "client": "string",
- "datetime": "string",
- "count": 0
}
]
}
client_identifier required | string The OAuth2 client to retrieve |
{- "identifier": "string",
- "name": "string",
- "contactEmail": "string",
- "description": "string",
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "active": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "grants": [
- "string"
], - "scopes": [
- "string"
]
}
p | integer >= 1 Default: 1 Page of clients to retrieve |
perPage | integer [ 1 .. 100 ] Default: 15 Number of clients per page |
{- "items": [
- {
- "identifier": "string",
- "name": "string",
- "contactEmail": "string",
- "description": "string",
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "active": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "grants": [
- "string"
], - "scopes": [
- "string"
]
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
instances required | Array of strings <url> [ items <url > ] |
{- "instances": [
- "string"
]
}
{- "instances": [
- "string"
]
}
list | string or null Default: null The list from which to retrieve the bookmarks. If not set the default list will be used |
sort | string or null Default: "hot" Enum: "active" "hot" "newest" "oldest" "top" "commented" The sorting method to use during entry fetch |
time | string or null Default: "∞" Enum: "3h" "6h" "12h" "1d" "1w" "1m" "1y" "∞" "all" The maximum age of retrieved entries |
federation | string or null Default: "all" Enum: "all" "local" Whether to include federated posts |
type | string or null Default: "all" Enum: "article" "link" "image" "video" "all" The type of entries to fetch. If set only entries will be returned |
p | integer or null >= 1 Default: 1 Page of entries to retrieve |
perPage | integer or null [ 1 .. 100 ] Default: 25 Number of entries to retrieve per page |
{- "items": [
- {
- "itemType": "string",
- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
list_name required | string The name of the list to be edited |
name required | string The name of the list |
isDefault | boolean Default: false Whether this is the default list |
count | integer Default: 0 The total number of items in the list |
{- "name": "string",
- "isDefault": false,
- "count": 0
}
{- "name": "string",
- "isDefault": false,
- "count": 0
}
subject_id required | integer The id of the subject to be added to the default list |
subject_type required | stringentry|entry_comment|post|post_comment Enum: "entry" "entry_comment" "post" "post_comment" the type of the subject |
{- "bookmarks": [
- "string"
]
}
subject_id required | integer The id of the subject to be added to the specified list |
subject_type required | stringentry|entry_comment|post|post_comment Enum: "entry" "entry_comment" "post" "post_comment" the type of the subject |
list_name required | string |
{- "bookmarks": [
- "string"
]
}
subject_id required | integer The id of the subject to be removed |
subject_type required | stringentry|entry_comment|post|post_comment Enum: "entry" "entry_comment" "post" "post_comment" the type of the subject |
{- "bookmarks": [
- "string"
]
}
subject_id required | integer The id of the subject to be removed |
subject_type required | stringentry|entry_comment|post|post_comment Enum: "entry" "entry_comment" "post" "post_comment" the type of the subject |
list_name required | string |
{- "bookmarks": [
- "string"
]
}
domain_id required | integer The domain to retrieve entries from |
sort | any Default: "hot" Enum: "active" "hot" "newest" "oldest" "top" "commented" The sorting method to use during entry fetch |
time | any Default: "∞" Enum: "3h" "6h" "12h" "1d" "1w" "1m" "1y" "∞" "all" The maximum age of retrieved entries |
p | integer >= 1 Default: 1 Page of entries to retrieve |
perPage | integer [ 1 .. 100 ] Default: 25 Number of entries to retrieve per page |
lang[] | Array of strings[ items [ 2 .. 3 ] characters ] Language(s) of entries to return |
usePreferredLangs | boolean Default: false Filter by a user's preferred languages? (Requires authentication and takes precedence over lang[]) |
{- "items": [
- {
- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
domain_id required | integer The domain to retrieve comments from |
sort | string Default: "hot" Enum: "newest" "top" "hot" "newest" "oldest" The sorting method to use during comment fetch |
time | string Default: "∞" Enum: "3h" "6h" "12h" "1d" "1w" "1m" "1y" "∞" "all" The maximum age of retrieved entries |
p | integer >= 1 Default: 1 Page of comments to retrieve |
perPage | integer [ 1 .. 100 ] Default: 25 Number of comments to retrieve per page |
d | integer [ 0 .. 25 ] Default: 10 Depth of comment children to retrieve |
lang[] | Array of strings[ items [ 2 .. 3 ] characters ] Language(s) of entries to return |
usePreferredLangs | boolean Default: false Filter by a user's preferred languages? (Requires authentication and takes precedence over lang[]) |
{- "items": [
- {
- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isAdult": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "apId": "string",
- "children": [
- {
- "commentid": 0,
- "user": {
- "userId": 0,
- "username": "test"
}, - "magazine": {
- "magazineId": 0,
- "name": "test"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "string"
], - "createdAt": "2023-06-18 11:59:41-07:00",
- "editedAt": "2023-06-18 11:59:41-07:00",
- "lastActive": "2023-06-18 12:00:45-07:00",
- "childCount": 0,
- "children": [ ]
}
], - "childCount": 0,
- "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
p | integer >= 1 Default: 1 Page of domains to retrieve |
perPage | integer [ 1 .. 100 ] Default: 100 Number of domains per page |
q | string Domain search term |
{- "items": [
- {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
p | integer >= 1 Default: 1 Page of domains to retrieve |
perPage | integer [ 1 .. 100 ] Default: 100 Number of domains per page |
{- "items": [
- {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
p | integer >= 1 Default: 1 Page of domains to retrieve |
perPage | integer [ 1 .. 100 ] Default: 100 Number of domains per page |
{- "items": [
- {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
domain_id required | integer The domain to subscribe to |
{- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}
domain_id required | integer The domain to unsubscribe from |
{- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}
{- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
entry_id required | integer The id of the entry to update |
title | string or null |
tags required | Array of strings |
isOc | boolean Default: false |
body | string or null |
lang | string or null [ 2 .. 3 ] characters |
isAdult | boolean Default: false |
{- "title": "Posted from the API!",
- "tags": [
- "cat",
- "blep",
- "cute"
], - "isOc": false,
- "body": "We can post cat pics from the API now! What are you going to do with this power?",
- "lang": "en",
- "isAdult": false
}
{- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
entry_id required | integer The entry to report |
reason | string or null |
{- "reason": "string"
}
{- "title": "An error occurred",
- "status": 401,
- "detail": "Unauthorized"
}
entry_id required | integer The entry to vote upon |
choice required | integer Enum: -1 0 1 The user's voting choice. 0 clears the user's vote. |
{- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
entry_id required | integer The entry to favourite |
{- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
sort | any Default: "hot" Enum: "active" "hot" "newest" "oldest" "top" "commented" The sorting method to use during entry fetch |
time | any Default: "∞" Enum: "3h" "6h" "12h" "1d" "1w" "1m" "1y" "∞" "all" The maximum age of retrieved entries |
p | integer >= 1 Default: 1 Page of entries to retrieve |
perPage | integer [ 1 .. 100 ] Default: 25 Number of entries to retrieve per page |
federation | string or null Default: "all" Enum: "all" "federated" "local" What type of federated entries to retrieve |
{- "items": [
- {
- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
sort | any Default: "newest" Enum: "active" "hot" "newest" "oldest" "top" "commented" The sorting method to use during entry fetch |
time | any Default: "∞" Enum: "3h" "6h" "12h" "1d" "1w" "1m" "1y" "∞" "all" The maximum age of retrieved entries |
p | integer >= 1 Default: 1 Page of entries to retrieve |
perPage | integer [ 1 .. 100 ] Default: 25 Number of entries to retrieve per page |
federation | string or null Default: "all" Enum: "all" "federated" "local" What type of federated entries to retrieve |
{- "items": [
- {
- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
sort | any Default: "top" Enum: "active" "hot" "newest" "oldest" "top" "commented" The sorting method to use during entry fetch |
time | any Default: "∞" Enum: "3h" "6h" "12h" "1d" "1w" "1m" "1y" "∞" "all" The maximum age of retrieved entries |
p | integer >= 1 Default: 1 Page of entries to retrieve |
perPage | integer [ 1 .. 100 ] Default: 25 Number of entries to retrieve per page |
federation | string or null Default: "all" Enum: "all" "federated" "local" What type of federated entries to retrieve |
{- "items": [
- {
- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
sort | any Default: "hot" Enum: "active" "hot" "newest" "oldest" "top" "commented" The sorting method to use during entry fetch |
time | any Default: "∞" Enum: "3h" "6h" "12h" "1d" "1w" "1m" "1y" "∞" "all" The maximum age of retrieved entries |
p | integer >= 1 Default: 1 Page of entries to retrieve |
perPage | integer [ 1 .. 100 ] Default: 25 Number of entries to retrieve per page |
lang[] | Array of strings Language(s) of entries to return |
usePreferredLangs | boolean Default: false Filter by a user's preferred languages? (Requires authentication and takes precedence over lang[]) |
federation | string or null Default: "all" Enum: "all" "federated" "local" What type of federated entries to retrieve |
{- "items": [
- {
- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
entry_id required | integer The entry to retrieve comments from |
sortBy | string Default: "hot" Enum: "newest" "top" "hot" "newest" "oldest" The order to retrieve comments by |
time | string Default: "∞" Enum: "3h" "6h" "12h" "1d" "1w" "1m" "1y" "∞" "all" The maximum age of retrieved comments |
p | integer Default: 1 The page of comments to retrieve |
perPage | integer [ 1 .. 100 ] Default: 15 The number of top level comments per page |
d | integer [ 0 .. 25 ] Default: 10 The depth of comment trees retrieved |
lang[] | Array of strings Language(s) of comments to return |
usePreferredLangs | boolean Default: false Filter by a user's preferred languages? (Requires authentication and takes precedence over lang[]) |
{- "items": [
- {
- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isAdult": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "apId": "string",
- "children": [
- {
- "commentid": 0,
- "user": {
- "userId": 0,
- "username": "test"
}, - "magazine": {
- "magazineId": 0,
- "name": "test"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "string"
], - "createdAt": "2023-06-18 11:59:41-07:00",
- "editedAt": "2023-06-18 11:59:41-07:00",
- "lastActive": "2023-06-18 12:00:45-07:00",
- "childCount": 0,
- "children": [ ]
}
], - "childCount": 0,
- "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
entry_id required | integer Entry to which the new comment will belong |
body | string or null |
lang | string or null [ 2 .. 3 ] characters |
isAdult | boolean Default: false |
{- "body": "We can post cat pics from the API now! What are you going to do with this power?",
- "lang": "en",
- "isAdult": false
}
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isAdult": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "apId": "string",
- "children": [
- {
- "commentid": 0,
- "user": {
- "userId": 0,
- "username": "test"
}, - "magazine": {
- "magazineId": 0,
- "name": "test"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "string"
], - "createdAt": "2023-06-18 11:59:41-07:00",
- "editedAt": "2023-06-18 11:59:41-07:00",
- "lastActive": "2023-06-18 12:00:45-07:00",
- "childCount": 0,
- "children": [ ]
}
], - "childCount": 0,
- "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
entry_id required | integer Entry to which the new comment will belong |
body | string or null |
lang | string or null [ 2 .. 3 ] characters |
isAdult | boolean Default: false |
alt | string or null |
uploadImage required | string <binary> |
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isAdult": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "apId": "string",
- "children": [
- {
- "commentid": 0,
- "user": {
- "userId": 0,
- "username": "test"
}, - "magazine": {
- "magazineId": 0,
- "name": "test"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "string"
], - "createdAt": "2023-06-18 11:59:41-07:00",
- "editedAt": "2023-06-18 11:59:41-07:00",
- "lastActive": "2023-06-18 12:00:45-07:00",
- "childCount": 0,
- "children": [ ]
}
], - "childCount": 0,
- "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
entry_id required | integer Entry to which the new comment will belong |
comment_id required | string |
body | string or null |
lang | string or null [ 2 .. 3 ] characters |
isAdult | boolean Default: false |
{- "body": "We can post cat pics from the API now! What are you going to do with this power?",
- "lang": "en",
- "isAdult": false
}
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isAdult": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "apId": "string",
- "children": [
- {
- "commentid": 0,
- "user": {
- "userId": 0,
- "username": "test"
}, - "magazine": {
- "magazineId": 0,
- "name": "test"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "string"
], - "createdAt": "2023-06-18 11:59:41-07:00",
- "editedAt": "2023-06-18 11:59:41-07:00",
- "lastActive": "2023-06-18 12:00:45-07:00",
- "childCount": 0,
- "children": [ ]
}
], - "childCount": 0,
- "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
entry_id required | integer Entry to which the new comment will belong |
comment_id required | string |
body | string or null |
lang | string or null [ 2 .. 3 ] characters |
isAdult | boolean Default: false |
alt | string or null |
uploadImage required | string <binary> |
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isAdult": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "apId": "string",
- "children": [
- {
- "commentid": 0,
- "user": {
- "userId": 0,
- "username": "test"
}, - "magazine": {
- "magazineId": 0,
- "name": "test"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "string"
], - "createdAt": "2023-06-18 11:59:41-07:00",
- "editedAt": "2023-06-18 11:59:41-07:00",
- "lastActive": "2023-06-18 12:00:45-07:00",
- "childCount": 0,
- "children": [ ]
}
], - "childCount": 0,
- "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
comment_id required | integer The comment to retrieve |
d | integer [ 0 .. 25 ] Default: 10 Comment tree depth to retrieve |
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isAdult": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "apId": "string",
- "children": [
- {
- "commentid": 0,
- "user": {
- "userId": 0,
- "username": "test"
}, - "magazine": {
- "magazineId": 0,
- "name": "test"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "string"
], - "createdAt": "2023-06-18 11:59:41-07:00",
- "editedAt": "2023-06-18 11:59:41-07:00",
- "lastActive": "2023-06-18 12:00:45-07:00",
- "childCount": 0,
- "children": [ ]
}
], - "childCount": 0,
- "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
comment_id required | integer The id of the comment to update |
d | integer Default: -1 Comment tree depth to retrieve (-1 for unlimited depth) |
body | string or null |
lang | string or null [ 2 .. 3 ] characters |
isAdult | boolean Default: false |
{- "body": "We can post cat pics from the API now! What are you going to do with this power?",
- "lang": "en",
- "isAdult": false
}
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isAdult": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "apId": "string",
- "children": [
- {
- "commentid": 0,
- "user": {
- "userId": 0,
- "username": "test"
}, - "magazine": {
- "magazineId": 0,
- "name": "test"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "string"
], - "createdAt": "2023-06-18 11:59:41-07:00",
- "editedAt": "2023-06-18 11:59:41-07:00",
- "lastActive": "2023-06-18 12:00:45-07:00",
- "childCount": 0,
- "children": [ ]
}
], - "childCount": 0,
- "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
comment_id required | integer The comment to report |
reason | string or null |
{- "reason": "string"
}
{- "title": "An error occurred",
- "status": 401,
- "detail": "Unauthorized"
}
comment_id required | integer The comment to vote upon |
choice required | integer Enum: -1 0 1 The user's voting choice. 0 clears the user's vote. |
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isAdult": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "apId": "string",
- "children": [
- {
- "commentid": 0,
- "user": {
- "userId": 0,
- "username": "test"
}, - "magazine": {
- "magazineId": 0,
- "name": "test"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "string"
], - "createdAt": "2023-06-18 11:59:41-07:00",
- "editedAt": "2023-06-18 11:59:41-07:00",
- "lastActive": "2023-06-18 12:00:45-07:00",
- "childCount": 0,
- "children": [ ]
}
], - "childCount": 0,
- "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
comment_id required | integer The comment to favourite |
d | integer Default: -1 Comment tree depth to retrieve (-1 for unlimited depth) |
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isAdult": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "apId": "string",
- "children": [
- {
- "commentid": 0,
- "user": {
- "userId": 0,
- "username": "test"
}, - "magazine": {
- "magazineId": 0,
- "name": "test"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "string"
], - "createdAt": "2023-06-18 11:59:41-07:00",
- "editedAt": "2023-06-18 11:59:41-07:00",
- "lastActive": "2023-06-18 12:00:45-07:00",
- "childCount": 0,
- "children": [ ]
}
], - "childCount": 0,
- "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
p | integer >= 1 Default: 1 Page of moderation log to retrieve |
perPage | integer [ 1 .. 100 ] Default: 25 Number of moderation log items to retrieve per page |
{- "items": [
- {
- "type": "log_entry_deleted",
- "createdAt": "2019-08-24T14:15:22Z",
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "moderator": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
{- "softwareName": "mbin",
- "softwareVersion": "2.0.0",
- "websiteContactEmail": "contact@mbin.social",
- "websiteTitle": "Mbin",
- "websiteOpenRegistrations": true,
- "websiteFederationEnabled": true,
- "websiteDefaultLang": "en"
}
{- "items": [
- {
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
{- "items": [
- {
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
start | string <date> The start date of the window to retrieve votes in. If not provided defaults to 1 (resolution) ago |
end | string <date> The end date of the window to retrieve votes in. If not provided defaults to today |
resolution required | string Enum: "all" "year" "month" "day" "hour" The size of chunks to aggregate votes in |
local | boolean Default: false Exclude federated votes? |
{- "entry": [
- {
- "datetime": "string",
- "boost": 0,
- "down": 0,
- "up": 0
}
], - "entry_comment": [
- {
- "datetime": "string",
- "boost": 0,
- "down": 0,
- "up": 0
}
], - "post": [
- {
- "datetime": "string",
- "boost": 0,
- "down": 0,
- "up": 0
}
], - "post_comment": [
- {
- "datetime": "string",
- "boost": 0,
- "down": 0,
- "up": 0
}
]
}
start | string <date> The start date of the window to retrieve submissions in. If not provided defaults to 1 (resolution) ago |
end | string <date> The end date of the window to retrieve submissions in. If not provided defaults to today |
resolution required | string Enum: "all" "year" "month" "day" "hour" The size of chunks to aggregate content submissions in |
local | boolean Default: false Exclude federated content? |
{- "entry": [
- {
- "datetime": "string",
- "count": 0
}
], - "entry_comment": [
- {
- "datetime": "string",
- "count": 0
}
], - "post": [
- {
- "datetime": "string",
- "count": 0
}
], - "post_comment": [
- {
- "datetime": "string",
- "count": 0
}
]
}
magazine_id required | integer The magazine to create the entry in |
title | string or null |
tags required | Array of strings |
isOc | boolean Default: false |
body | string or null |
lang | string or null [ 2 .. 3 ] characters |
isAdult | boolean Default: false |
{- "title": "Posted from the API!",
- "tags": [
- "cat",
- "blep",
- "cute"
], - "isOc": false,
- "body": "We can post cat pics from the API now! What are you going to do with this power?",
- "lang": "en",
- "isAdult": false
}
{- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
magazine_id required | integer The magazine to create the entry in |
title | string or null |
url | string or null |
tags required | Array of strings |
isOc | boolean Default: false |
body | string or null |
lang | string or null [ 2 .. 3 ] characters |
isAdult | boolean Default: false |
{- "title": "Posted from the API!",
- "url": "string",
- "tags": [
- "cat",
- "blep",
- "cute"
], - "isOc": false,
- "body": "We can post cat pics from the API now! What are you going to do with this power?",
- "lang": "en",
- "isAdult": false
}
{- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
magazine_id required | integer The magazine to create the entry in |
title | string or null |
tags required | Array of strings |
isOc | boolean Default: false |
lang | string or null [ 2 .. 3 ] characters |
isAdult | boolean Default: false |
alt | string or null |
uploadImage required | string <binary> |
{- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
magazine_id required | integer Magazine to retrieve posts from |
p | integer >= 1 Default: 1 Page of posts to retrieve |
perPage | integer [ 1 .. 100 ] Default: 15 Number of posts to retrieve per page |
sort | string Default: "hot" Enum: "active" "hot" "newest" "oldest" "top" "commented" Sort method to use when retrieving posts |
time | string Default: "∞" Enum: "3h" "6h" "12h" "1d" "1w" "1m" "1y" "∞" "all" Max age of retrieved posts |
lang[] | Array of strings[ items [ 2 .. 3 ] characters ] Language(s) of posts to return |
usePreferredLangs | boolean Default: false Filter by a user's preferred languages? (Requires authentication and takes precedence over lang[]) |
federation | string or null Default: "all" Enum: "all" "federated" "local" What type of federated entries to retrieve |
{- "items": [
- {
- "postId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "isPinned": false,
- "slug": "string",
- "comments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "tags": [
- "string"
], - "mentions": [
- "string"
], - "apId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
magazine_id required | string |
body | string or null |
lang | string or null [ 2 .. 3 ] characters |
isAdult | boolean Default: false |
{- "body": "We can post cat pics from the API now! What are you going to do with this power?",
- "lang": "en",
- "isAdult": false
}
{- "postId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "isPinned": false,
- "slug": "string",
- "comments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "tags": [
- "string"
], - "mentions": [
- "string"
], - "apId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
magazine_id required | string |
body | string or null |
lang | string or null [ 2 .. 3 ] characters |
isAdult | boolean Default: false |
alt | string or null |
uploadImage required | string <binary> |
{- "postId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "isPinned": false,
- "slug": "string",
- "comments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "tags": [
- "string"
], - "mentions": [
- "string"
], - "apId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
magazine_id required | integer The magazine to retrieve entries from |
sort | any Default: "hot" Enum: "active" "hot" "newest" "oldest" "top" "commented" The sorting method to use during entry fetch |
time | any Default: "∞" Enum: "3h" "6h" "12h" "1d" "1w" "1m" "1y" "∞" "all" The maximum age of retrieved entries |
p | integer >= 1 Default: 1 Page of entries to retrieve |
perPage | integer [ 1 .. 100 ] Default: 25 Number of entries to retrieve per page |
lang[] | Array of strings[ items [ 2 .. 3 ] characters ] Language(s) of entries to return |
usePreferredLangs | boolean Default: false Filter by a user's preferred languages? (Requires authentication and takes precedence over lang[]) |
{- "items": [
- {
- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
p | integer >= 1 Default: 1 Page of magazines to retrieve |
perPage | integer [ 1 .. 100 ] Default: 48 Number of magazines per page |
q | string Magazine search term |
sort | string Default: "hot" Enum: "active" "hot" "newest" Sort method to use when retrieving magazines |
federation | string Default: "all" Enum: "all" "federated" "local" What type of federated magazines to retrieve |
hide_adult | string Default: "hide" Enum: "hide" "show" "only" Options for retrieving adult magazines |
{- "items": [
- {
- "owner": {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}, - "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "name": "string",
- "title": "string",
- "description": "string",
- "rules": "string",
- "subscriptionsCount": 0,
- "entryCount": 0,
- "entryCommentCount": 0,
- "postCount": 0,
- "postCommentCount": 0,
- "isAdult": false,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "moderators": [
- {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}
], - "apId": "string",
- "apProfileId": "string",
- "magazineId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "isPostingRestrictedToMods": false,
- "localSubscribers": 0,
- "notificationStatus": "Default"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
p | integer >= 1 Default: 1 Page of magazines to retrieve |
perPage | integer [ 1 .. 100 ] Default: 48 Number of magazines per page |
{- "items": [
- {
- "owner": {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}, - "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "name": "string",
- "title": "string",
- "description": "string",
- "rules": "string",
- "subscriptionsCount": 0,
- "entryCount": 0,
- "entryCommentCount": 0,
- "postCount": 0,
- "postCommentCount": 0,
- "isAdult": false,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "moderators": [
- {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}
], - "apId": "string",
- "apProfileId": "string",
- "magazineId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "isPostingRestrictedToMods": false,
- "localSubscribers": 0,
- "notificationStatus": "Default"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
p | integer >= 1 Default: 1 Page of magazines to retrieve |
perPage | integer [ 1 .. 100 ] Default: 48 Number of magazines per page |
{- "items": [
- {
- "owner": {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}, - "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "name": "string",
- "title": "string",
- "description": "string",
- "rules": "string",
- "subscriptionsCount": 0,
- "entryCount": 0,
- "entryCommentCount": 0,
- "postCount": 0,
- "postCommentCount": 0,
- "isAdult": false,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "moderators": [
- {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}
], - "apId": "string",
- "apProfileId": "string",
- "magazineId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "isPostingRestrictedToMods": false,
- "localSubscribers": 0,
- "notificationStatus": "Default"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
p | integer >= 1 Default: 1 Page of magazines to retrieve |
perPage | integer [ 1 .. 100 ] Default: 48 Number of magazines per page |
{- "items": [
- {
- "owner": {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}, - "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "name": "string",
- "title": "string",
- "description": "string",
- "rules": "string",
- "subscriptionsCount": 0,
- "entryCount": 0,
- "entryCommentCount": 0,
- "postCount": 0,
- "postCommentCount": 0,
- "isAdult": false,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "moderators": [
- {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}
], - "apId": "string",
- "apProfileId": "string",
- "magazineId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "isPostingRestrictedToMods": false,
- "localSubscribers": 0,
- "notificationStatus": "Default"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
magazine_id required | integer The magazine to retrieve |
{- "owner": {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}, - "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "name": "string",
- "title": "string",
- "description": "string",
- "rules": "string",
- "subscriptionsCount": 0,
- "entryCount": 0,
- "entryCommentCount": 0,
- "postCount": 0,
- "postCommentCount": 0,
- "isAdult": false,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "moderators": [
- {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}
], - "apId": "string",
- "apProfileId": "string",
- "magazineId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "isPostingRestrictedToMods": false,
- "localSubscribers": 0,
- "notificationStatus": "Default"
}
magazine_name required | string The magazine to retrieve |
{- "owner": {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}, - "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "name": "string",
- "title": "string",
- "description": "string",
- "rules": "string",
- "subscriptionsCount": 0,
- "entryCount": 0,
- "entryCommentCount": 0,
- "postCount": 0,
- "postCommentCount": 0,
- "isAdult": false,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "moderators": [
- {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}
], - "apId": "string",
- "apProfileId": "string",
- "magazineId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "isPostingRestrictedToMods": false,
- "localSubscribers": 0,
- "notificationStatus": "Default"
}
magazine_id required | integer The magazine to block |
{- "owner": {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}, - "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "name": "string",
- "title": "string",
- "description": "string",
- "rules": "string",
- "subscriptionsCount": 0,
- "entryCount": 0,
- "entryCommentCount": 0,
- "postCount": 0,
- "postCommentCount": 0,
- "isAdult": false,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "moderators": [
- {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}
], - "apId": "string",
- "apProfileId": "string",
- "magazineId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "isPostingRestrictedToMods": false,
- "localSubscribers": 0,
- "notificationStatus": "Default"
}
magazine_id required | integer The magazine to unblock |
{- "owner": {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}, - "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "name": "string",
- "title": "string",
- "description": "string",
- "rules": "string",
- "subscriptionsCount": 0,
- "entryCount": 0,
- "entryCommentCount": 0,
- "postCount": 0,
- "postCommentCount": 0,
- "isAdult": false,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "moderators": [
- {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}
], - "apId": "string",
- "apProfileId": "string",
- "magazineId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "isPostingRestrictedToMods": false,
- "localSubscribers": 0,
- "notificationStatus": "Default"
}
magazine_id required | integer The magazine to subscribe to |
{- "owner": {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}, - "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "name": "string",
- "title": "string",
- "description": "string",
- "rules": "string",
- "subscriptionsCount": 0,
- "entryCount": 0,
- "entryCommentCount": 0,
- "postCount": 0,
- "postCommentCount": 0,
- "isAdult": false,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "moderators": [
- {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}
], - "apId": "string",
- "apProfileId": "string",
- "magazineId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "isPostingRestrictedToMods": false,
- "localSubscribers": 0,
- "notificationStatus": "Default"
}
magazine_id required | integer The magazine to unsubscribe from |
{- "owner": {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}, - "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "name": "string",
- "title": "string",
- "description": "string",
- "rules": "string",
- "subscriptionsCount": 0,
- "entryCount": 0,
- "entryCommentCount": 0,
- "postCount": 0,
- "postCommentCount": 0,
- "isAdult": false,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "moderators": [
- {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}
], - "apId": "string",
- "apProfileId": "string",
- "magazineId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "isPostingRestrictedToMods": false,
- "localSubscribers": 0,
- "notificationStatus": "Default"
}
magazine_id required | integer The id of the magazine to retrieve the theme from |
{- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "customCss": "string",
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}
}
magazine_id required | integer Magazine to get mod log from |
p | integer >= 1 Default: 1 Page of moderation log to retrieve |
perPage | integer [ 1 .. 100 ] Default: 25 Number of moderation log items to retrieve per page |
{- "items": [
- {
- "type": "log_entry_deleted",
- "createdAt": "2019-08-24T14:15:22Z",
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "moderator": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
name | string or null |
title | string or null |
description | string or null |
rules | string or null |
isAdult | boolean or null |
isPostingRestrictedToMods | boolean or null |
{- "name": "string",
- "title": "string",
- "description": "string",
- "rules": "string",
- "isAdult": true,
- "isPostingRestrictedToMods": true
}
{- "owner": {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}, - "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "name": "string",
- "title": "string",
- "description": "string",
- "rules": "string",
- "subscriptionsCount": 0,
- "entryCount": 0,
- "entryCommentCount": 0,
- "postCount": 0,
- "postCommentCount": 0,
- "isAdult": false,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "moderators": [
- {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}
], - "apId": "string",
- "apProfileId": "string",
- "magazineId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "isPostingRestrictedToMods": false,
- "localSubscribers": 0,
- "notificationStatus": "Default"
}
magazine_id required | integer The id of the magazine to update |
iconId | integer or null |
title | string or null |
description | string or null |
rules | string or null |
isAdult | boolean or null |
isPostingRestrictedToMods | boolean or null |
{- "iconId": 0,
- "title": "string",
- "description": "string",
- "rules": "string",
- "isAdult": true,
- "isPostingRestrictedToMods": true
}
{- "owner": {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}, - "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "name": "string",
- "title": "string",
- "description": "string",
- "rules": "string",
- "subscriptionsCount": 0,
- "entryCount": 0,
- "entryCommentCount": 0,
- "postCount": 0,
- "postCommentCount": 0,
- "isAdult": false,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "moderators": [
- {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}
], - "apId": "string",
- "apProfileId": "string",
- "magazineId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "isPostingRestrictedToMods": false,
- "localSubscribers": 0,
- "notificationStatus": "Default"
}
magazine_id required | integer The id of the magazine to update |
user_id required | integer The id of the user to add as moderator |
{- "owner": {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}, - "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "name": "string",
- "title": "string",
- "description": "string",
- "rules": "string",
- "subscriptionsCount": 0,
- "entryCount": 0,
- "entryCommentCount": 0,
- "postCount": 0,
- "postCommentCount": 0,
- "isAdult": false,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "moderators": [
- {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}
], - "apId": "string",
- "apProfileId": "string",
- "magazineId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "isPostingRestrictedToMods": false,
- "localSubscribers": 0,
- "notificationStatus": "Default"
}
magazine_id required | integer The id of the magazine to update |
user_id required | integer The id of the user to remove as moderator |
{- "owner": {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}, - "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "name": "string",
- "title": "string",
- "description": "string",
- "rules": "string",
- "subscriptionsCount": 0,
- "entryCount": 0,
- "entryCommentCount": 0,
- "postCount": 0,
- "postCommentCount": 0,
- "isAdult": false,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "moderators": [
- {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}
], - "apId": "string",
- "apProfileId": "string",
- "magazineId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "isPostingRestrictedToMods": false,
- "localSubscribers": 0,
- "notificationStatus": "Default"
}
magazine_id required | integer The id of the magazine to update |
name required | string [ 1 .. 20 ] characters |
{- "name": "string"
}
{- "owner": {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}, - "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "name": "string",
- "title": "string",
- "description": "string",
- "rules": "string",
- "subscriptionsCount": 0,
- "entryCount": 0,
- "entryCommentCount": 0,
- "postCount": 0,
- "postCommentCount": 0,
- "isAdult": false,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "moderators": [
- {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}
], - "apId": "string",
- "apProfileId": "string",
- "magazineId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "isPostingRestrictedToMods": false,
- "localSubscribers": 0,
- "notificationStatus": "Default"
}
magazine_id required | integer The id of the magazine to update |
badge_id required | integer The id of the badge to delete |
{- "owner": {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}, - "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "name": "string",
- "title": "string",
- "description": "string",
- "rules": "string",
- "subscriptionsCount": 0,
- "entryCount": 0,
- "entryCommentCount": 0,
- "postCount": 0,
- "postCommentCount": 0,
- "isAdult": false,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "moderators": [
- {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}
], - "apId": "string",
- "apProfileId": "string",
- "magazineId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "isPostingRestrictedToMods": false,
- "localSubscribers": 0,
- "notificationStatus": "Default"
}
magazine_id required | integer The id of the magazine to update |
tag required | string The tag to add |
{- "owner": {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}, - "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "name": "string",
- "title": "string",
- "description": "string",
- "rules": "string",
- "subscriptionsCount": 0,
- "entryCount": 0,
- "entryCommentCount": 0,
- "postCount": 0,
- "postCommentCount": 0,
- "isAdult": false,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "moderators": [
- {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}
], - "apId": "string",
- "apProfileId": "string",
- "magazineId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "isPostingRestrictedToMods": false,
- "localSubscribers": 0,
- "notificationStatus": "Default"
}
magazine_id required | integer The id of the magazine to update |
tag required | string The tag to remove |
{- "owner": {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}, - "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "name": "string",
- "title": "string",
- "description": "string",
- "rules": "string",
- "subscriptionsCount": 0,
- "entryCount": 0,
- "entryCommentCount": 0,
- "postCount": 0,
- "postCommentCount": 0,
- "isAdult": false,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "moderators": [
- {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}
], - "apId": "string",
- "apProfileId": "string",
- "magazineId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "isPostingRestrictedToMods": false,
- "localSubscribers": 0,
- "notificationStatus": "Default"
}
magazine_id required | integer The id of the magazine to update |
customCss | string or null |
backgroundImage | string or null Enum: "shape1" "shape2" |
uploadImage required | string <binary> |
{- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "customCss": "string",
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}
}
magazine_id required | integer The id of the magazine to remove the icon from |
{- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "customCss": "string",
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}
}
magazine_id required | integer The id of the magazine to retrieve stats from |
start | string <date> The start date of the window to retrieve votes in. If not provided defaults to 1 (resolution) ago |
end | string <date> The end date of the window to retrieve votes in. If not provided defaults to today |
resolution required | string Enum: "all" "year" "month" "day" "hour" The size of chunks to aggregate votes in |
local | boolean Default: false Exclude federated votes? |
{- "entry": [
- {
- "datetime": "string",
- "boost": 0,
- "down": 0,
- "up": 0
}
], - "entry_comment": [
- {
- "datetime": "string",
- "boost": 0,
- "down": 0,
- "up": 0
}
], - "post": [
- {
- "datetime": "string",
- "boost": 0,
- "down": 0,
- "up": 0
}
], - "post_comment": [
- {
- "datetime": "string",
- "boost": 0,
- "down": 0,
- "up": 0
}
]
}
magazine_id required | integer The id of the magazine to retrieve stats from |
start | string <date> The start date of the window to retrieve submissions in. If not provided defaults to 1 (resolution) ago |
end | string <date> The end date of the window to retrieve submissions in. If not provided defaults to today |
resolution required | string Enum: "all" "year" "month" "day" "hour" The size of chunks to aggregate content submissions in |
local | boolean Default: false Exclude federated content? |
{- "entry": [
- {
- "datetime": "string",
- "count": 0
}
], - "entry_comment": [
- {
- "datetime": "string",
- "count": 0
}
], - "post": [
- {
- "datetime": "string",
- "count": 0
}
], - "post_comment": [
- {
- "datetime": "string",
- "count": 0
}
]
}
message_id required | integer The message to retrieve |
{- "sender": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "body": "string",
- "status": "new",
- "threadId": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "messageId": 0
}
message_id required | integer The message to read |
{- "sender": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "body": "string",
- "status": "new",
- "threadId": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "messageId": 0
}
message_id required | integer The message to mark as new |
{- "sender": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "body": "string",
- "status": "new",
- "threadId": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "messageId": 0
}
p | integer >= 1 Default: 1 Page of messages to retrieve |
perPage | integer [ 1 .. 100 ] Default: 25 Number of messages per page |
d | integer [ 0 .. 100 ] Default: 25 Number of replies per thread |
{- "items": [
- {
- "participants": [
- {
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
], - "messageCount": 0,
- "messages": [
- {
- "sender": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "body": "string",
- "status": "new",
- "threadId": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "messageId": 0
}
], - "threadId": 0
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
thread_id required | integer Thread being replied to |
d | integer [ 0 .. 100 ] Default: 25 Number of replies returned |
body required | string [ 2 .. 5000 ] characters |
apId | string or null |
{- "body": "string",
- "apId": "string"
}
{- "participants": [
- {
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
], - "messageCount": 0,
- "messages": [
- {
- "sender": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "body": "string",
- "status": "new",
- "threadId": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "messageId": 0
}
], - "threadId": 0
}
thread_id required | integer Thread from which to retrieve messages |
sort required | string Default: "newest" Enum: "newest" "oldest" Order to retrieve messages by |
p | integer >= 1 Default: 1 Page of messages to retrieve |
perPage | integer [ 1 .. 100 ] Default: 25 Number of messages per page |
{- "items": [
- {
- "sender": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "body": "string",
- "status": "new",
- "threadId": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "messageId": 0
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}, - "participants": [
- {
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
]
}
user_id required | integer User being messaged |
d | integer [ 0 .. 100 ] Default: 25 Number of replies returned |
body required | string [ 2 .. 5000 ] characters |
apId | string or null |
{- "body": "string",
- "apId": "string"
}
{- "participants": [
- {
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
], - "messageCount": 0,
- "messages": [
- {
- "sender": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "body": "string",
- "status": "new",
- "threadId": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "messageId": 0
}
], - "threadId": 0
}
entry_id required | integer The entry to pin or unpin |
{- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
entry_id required | integer The entry to trash |
{- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
entry_id required | integer The entry to restore |
{- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
entry_id required | integer The entry to set adult status on |
adult required | boolean Default: true new isAdult status |
{- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
entry_id required | integer The entry to change language of |
lang required | string [ 2 .. 3 ] characters new language |
{- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
comment_id required | integer The comment to trash |
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isAdult": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "apId": "string",
- "children": [
- {
- "commentid": 0,
- "user": {
- "userId": 0,
- "username": "test"
}, - "magazine": {
- "magazineId": 0,
- "name": "test"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "string"
], - "createdAt": "2023-06-18 11:59:41-07:00",
- "editedAt": "2023-06-18 11:59:41-07:00",
- "lastActive": "2023-06-18 12:00:45-07:00",
- "childCount": 0,
- "children": [ ]
}
], - "childCount": 0,
- "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
comment_id required | integer The comment to restore |
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isAdult": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "apId": "string",
- "children": [
- {
- "commentid": 0,
- "user": {
- "userId": 0,
- "username": "test"
}, - "magazine": {
- "magazineId": 0,
- "name": "test"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "string"
], - "createdAt": "2023-06-18 11:59:41-07:00",
- "editedAt": "2023-06-18 11:59:41-07:00",
- "lastActive": "2023-06-18 12:00:45-07:00",
- "childCount": 0,
- "children": [ ]
}
], - "childCount": 0,
- "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
comment_id required | integer The comment to set adult status on |
adult required | boolean Default: true new isAdult status |
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isAdult": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "apId": "string",
- "children": [
- {
- "commentid": 0,
- "user": {
- "userId": 0,
- "username": "test"
}, - "magazine": {
- "magazineId": 0,
- "name": "test"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "string"
], - "createdAt": "2023-06-18 11:59:41-07:00",
- "editedAt": "2023-06-18 11:59:41-07:00",
- "lastActive": "2023-06-18 12:00:45-07:00",
- "childCount": 0,
- "children": [ ]
}
], - "childCount": 0,
- "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
comment_id required | integer The comment to change language of |
lang required | string [ 2 .. 3 ] characters new language |
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isAdult": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "apId": "string",
- "children": [
- {
- "commentid": 0,
- "user": {
- "userId": 0,
- "username": "test"
}, - "magazine": {
- "magazineId": 0,
- "name": "test"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "string"
], - "createdAt": "2023-06-18 11:59:41-07:00",
- "editedAt": "2023-06-18 11:59:41-07:00",
- "lastActive": "2023-06-18 12:00:45-07:00",
- "childCount": 0,
- "children": [ ]
}
], - "childCount": 0,
- "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
post_id required | integer The post to pin or unpin |
{- "postId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "isPinned": false,
- "slug": "string",
- "comments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "tags": [
- "string"
], - "mentions": [
- "string"
], - "apId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
post_id required | integer The post to trash |
{- "postId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "isPinned": false,
- "slug": "string",
- "comments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "tags": [
- "string"
], - "mentions": [
- "string"
], - "apId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
post_id required | integer The post to restore |
{- "postId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "isPinned": false,
- "slug": "string",
- "comments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "tags": [
- "string"
], - "mentions": [
- "string"
], - "apId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
post_id required | integer The post to set adult status on |
adult required | boolean Default: true new isAdult status |
{- "postId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "isPinned": false,
- "slug": "string",
- "comments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "tags": [
- "string"
], - "mentions": [
- "string"
], - "apId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
post_id required | integer The post to change language of |
lang required | string [ 2 .. 3 ] characters new language |
{- "postId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "isPinned": false,
- "slug": "string",
- "comments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "tags": [
- "string"
], - "mentions": [
- "string"
], - "apId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
comment_id required | integer The comment to trash |
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "apId": "string",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "childCount": 0,
- "children": [
- {
- "commentId": 0,
- "userId": 0,
- "magazineId": 0,
- "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "comment body",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "sometag"
], - "createdAt": "2023-06-18 11:59:41+00:00",
- "lastActive": "2023-06-18 12:00:45+00:00",
- "childCount": 0,
- "children": [ ]
}
], - "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "visibility": "private"
}
comment_id required | integer The comment to restore |
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "apId": "string",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "childCount": 0,
- "children": [
- {
- "commentId": 0,
- "userId": 0,
- "magazineId": 0,
- "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "comment body",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "sometag"
], - "createdAt": "2023-06-18 11:59:41+00:00",
- "lastActive": "2023-06-18 12:00:45+00:00",
- "childCount": 0,
- "children": [ ]
}
], - "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "visibility": "private"
}
comment_id required | integer The comment to set adult status on |
adult required | boolean Default: true new isAdult status |
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "apId": "string",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "childCount": 0,
- "children": [
- {
- "commentId": 0,
- "userId": 0,
- "magazineId": 0,
- "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "comment body",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "sometag"
], - "createdAt": "2023-06-18 11:59:41+00:00",
- "lastActive": "2023-06-18 12:00:45+00:00",
- "childCount": 0,
- "children": [ ]
}
], - "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "visibility": "private"
}
comment_id required | integer The comment to change language of |
lang required | string [ 2 .. 3 ] characters new language |
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "apId": "string",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "childCount": 0,
- "children": [
- {
- "commentId": 0,
- "userId": 0,
- "magazineId": 0,
- "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "comment body",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "sometag"
], - "createdAt": "2023-06-18 11:59:41+00:00",
- "lastActive": "2023-06-18 12:00:45+00:00",
- "childCount": 0,
- "children": [ ]
}
], - "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "visibility": "private"
}
magazine_id required | integer The magazine to ban the user in |
user_id required | integer The user to ban |
reason | string or null |
expiredAt | string or null <date-time> |
{- "reason": "string",
- "expiredAt": "2019-08-24T14:15:22Z"
}
{- "banId": 0,
- "reason": "string",
- "expiredAt": "2019-08-24T14:15:22Z",
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "bannedUser": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "bannedBy": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "expired": true
}
magazine_id required | integer The magazine the user is banned in |
user_id required | integer The user to unban |
{- "banId": 0,
- "reason": "string",
- "expiredAt": "2019-08-24T14:15:22Z",
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "bannedUser": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "bannedBy": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "expired": true
}
magazine_id required | integer The magazine of the report |
report_id required | integer The report to retrieve |
{- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "reported": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "reporting": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "subject": { },
- "reason": "string",
- "status": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "consideredAt": "2019-08-24T14:15:22Z",
- "consideredBy": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "weight": 0,
- "reportId": 0,
- "type": "entry_report"
}
magazine_id required | integer Magazine to retrieve reports from |
p | integer >= 1 Default: 1 Page of reports to retrieve |
perPage | integer [ 1 .. 100 ] Default: 48 Number of reports per page |
status | string Default: "pending" Enum: "any" "appeal" "approved" "closed" "pending" "rejected" Filter by report status |
{- "items": [
- {
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "reported": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "reporting": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "subject": { },
- "reason": "string",
- "status": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "consideredAt": "2019-08-24T14:15:22Z",
- "consideredBy": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "weight": 0,
- "reportId": 0,
- "type": "entry_report"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
magazine_id required | integer The magazine the report is in |
report_id required | integer The report to accept |
{- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "reported": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "reporting": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "subject": { },
- "reason": "string",
- "status": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "consideredAt": "2019-08-24T14:15:22Z",
- "consideredBy": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "weight": 0,
- "reportId": 0,
- "type": "entry_report"
}
magazine_id required | integer The magazine the report is in |
report_id required | integer The report to reject |
{- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "reported": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "reporting": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "subject": { },
- "reason": "string",
- "status": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "consideredAt": "2019-08-24T14:15:22Z",
- "consideredBy": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "weight": 0,
- "reportId": 0,
- "type": "entry_report"
}
magazine_id required | integer Magazine to retrieve bans from |
p | integer >= 1 Default: 1 Page of bans to retrieve |
perPage | integer [ 1 .. 100 ] Default: 48 Number of bans per page |
{- "items": [
- {
- "banId": 0,
- "reason": "string",
- "expiredAt": "2019-08-24T14:15:22Z",
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "bannedUser": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "bannedBy": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "expired": true
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
magazine_id required | integer Magazine to retrieve trash from |
p | integer >= 1 Default: 1 Page of trash to retrieve |
perPage | integer [ 1 .. 100 ] Default: 48 Number of trash per page |
{- "items": [
- {
- "itemType": "string",
- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
notification_id required | integer The notification to read |
{- "notificationId": 0,
- "type": "entry_created_notification",
- "status": "all",
- "subject": {
- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}, - "reportId": 0
}
{- "title": "An error occurred",
- "status": 401,
- "detail": "Unauthorized"
}
notification_id required | integer The notification to mark as new |
{- "notificationId": 0,
- "type": "entry_created_notification",
- "status": "all",
- "subject": {
- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}, - "reportId": 0
}
{- "title": "An error occurred",
- "status": 401,
- "detail": "Unauthorized"
}
status required | string Default: "all" Enum: "all" "new" "read" Notification status to retrieve |
p | integer >= 1 Default: 1 Page of notifications to retrieve |
perPage | integer [ 1 .. 100 ] Default: 25 Number of notifications per page |
{- "items": [
- {
- "notificationId": 0,
- "type": "entry_created_notification",
- "status": "all",
- "subject": {
- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}, - "reportId": 0
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
notification_id required | integer The notification to retrieve |
{- "notificationId": 0,
- "type": "entry_created_notification",
- "status": "all",
- "subject": {
- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}, - "reportId": 0
}
endpoint required | string The URL of the push endpoint messages will be sent to, normally you'll get this address when you register your application on a push service |
serverKey required | string On web push this would be called the 'auth' key, which is used to authenticate the server to the push service. According to https://web-push-book.gauntface.com/web-push-protocol/ this is a 'just' a 'secret' |
contentPublicKey required | string The public key of your key pair (client public key), which is used to encrypt the content. This should be a ECDH, p256 key |
{- "endpoint": "string",
- "serverKey": "string",
- "contentPublicKey": "string"
}
{- "title": "An error occurred",
- "status": 401,
- "detail": "Unauthorized"
}
{- "title": "An error occurred",
- "status": 401,
- "detail": "Unauthorized"
}
{- "title": "An error occurred",
- "status": 401,
- "detail": "Unauthorized"
}
target_id | integer The id of the target |
target_type | any Enum: "entry" "post" "magazine" "user" The type of the target |
setting required | stringDefault|Loud|Muted Enum: "Default" "Loud" "Muted" The new notification setting |
targetType required | stringentry|post|magazine|user Enum: "entry" "post" "magazine" "user" |
targetId required | string |
{- "title": "An error occurred",
- "status": 401,
- "detail": "Unauthorized"
}
p | integer >= 1 Default: 1 Page of posts to retrieve |
perPage | integer [ 1 .. 100 ] Default: 15 Number of posts to retrieve per page |
sort | string Default: "hot" Enum: "active" "hot" "newest" "oldest" "top" "commented" Sort method to use when retrieving posts |
time | string Default: "∞" Enum: "3h" "6h" "12h" "1d" "1w" "1m" "1y" "∞" "all" Max age of retrieved posts |
lang[] | Array of strings[ items [ 2 .. 3 ] characters ] Language(s) of posts to return |
usePreferredLangs | boolean Default: false Filter by a user's preferred languages? (Requires authentication and takes precedence over lang[]) |
federation | string or null Default: "all" Enum: "all" "federated" "local" What type of federated entries to retrieve |
{- "items": [
- {
- "postId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "isPinned": false,
- "slug": "string",
- "comments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "tags": [
- "string"
], - "mentions": [
- "string"
], - "apId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
p | integer >= 1 Default: 1 Page of posts to retrieve |
perPage | integer [ 1 .. 100 ] Default: 15 Number of posts to retrieve per page |
sort | string Default: "newest" Enum: "active" "hot" "newest" "oldest" "top" "commented" Sort method to use when retrieving posts |
time | string Default: "∞" Enum: "3h" "6h" "12h" "1d" "1w" "1m" "1y" "∞" "all" Max age of retrieved posts |
federation | string or null Default: "all" Enum: "all" "federated" "local" What type of federated entries to retrieve |
{- "items": [
- {
- "postId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "isPinned": false,
- "slug": "string",
- "comments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "tags": [
- "string"
], - "mentions": [
- "string"
], - "apId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
p | integer >= 1 Default: 1 Page of posts to retrieve |
perPage | integer [ 1 .. 100 ] Default: 15 Number of posts to retrieve per page |
sort | string Default: "hot" Enum: "active" "hot" "newest" "oldest" "top" "commented" Sort method to use when retrieving posts |
time | string Default: "∞" Enum: "3h" "6h" "12h" "1d" "1w" "1m" "1y" "∞" "all" Max age of retrieved posts |
federation | string or null Default: "all" Enum: "all" "federated" "local" What type of federated entries to retrieve |
{- "items": [
- {
- "postId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "isPinned": false,
- "slug": "string",
- "comments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "tags": [
- "string"
], - "mentions": [
- "string"
], - "apId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
p | integer >= 1 Default: 1 Page of posts to retrieve |
perPage | integer [ 1 .. 100 ] Default: 15 Number of posts to retrieve per page |
sort | string Default: "hot" Enum: "active" "hot" "newest" "oldest" "top" "commented" Sort method to use when retrieving posts |
time | string Default: "∞" Enum: "3h" "6h" "12h" "1d" "1w" "1m" "1y" "∞" "all" Max age of retrieved posts |
lang[] | Array of strings[ items [ 2 .. 3 ] characters ] Language(s) of posts to return |
usePreferredLangs | boolean Default: false Filter by a user's preferred languages? (Requires authentication and takes precedence over lang[]) |
federation | string or null Default: "all" Enum: "all" "federated" "local" What type of federated entries to retrieve |
{- "items": [
- {
- "postId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "isPinned": false,
- "slug": "string",
- "comments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "tags": [
- "string"
], - "mentions": [
- "string"
], - "apId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
{- "postId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "isPinned": false,
- "slug": "string",
- "comments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "tags": [
- "string"
], - "mentions": [
- "string"
], - "apId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
post_id required | integer The id of the post to update |
body | string or null |
lang | string or null [ 2 .. 3 ] characters |
isAdult | boolean Default: false |
{- "body": "We can post cat pics from the API now! What are you going to do with this power?",
- "lang": "en",
- "isAdult": false
}
{- "postId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "isPinned": false,
- "slug": "string",
- "comments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "tags": [
- "string"
], - "mentions": [
- "string"
], - "apId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
post_id required | integer The post to report |
reason | string or null |
{- "reason": "string"
}
{- "title": "An error occurred",
- "status": 401,
- "detail": "Unauthorized"
}
post_id required | integer The post to vote upon |
choice required | integer Default: 1 Enum: -1 0 1 The user's voting choice. 0 clears the user's vote. |
{- "postId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "isPinned": false,
- "slug": "string",
- "comments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "tags": [
- "string"
], - "mentions": [
- "string"
], - "apId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
post_id required | integer The post to favourite |
{- "postId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "isPinned": false,
- "slug": "string",
- "comments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "tags": [
- "string"
], - "mentions": [
- "string"
], - "apId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
post_id required | integer Post to retrieve comments from |
sort | string Default: "hot" Enum: "active" "hot" "newest" "oldest" "top" "commented" Sort method to use when retrieving comments |
time | string Default: "∞" Enum: "3h" "6h" "12h" "1d" "1w" "1m" "1y" "∞" "all" Max age of retrieved posts |
p | integer >= 1 Default: 1 Page of comments to retrieve |
d | integer [ 0 .. 25 ] Default: 10 Max depth of comment tree to retrieve |
perPage | integer [ 1 .. 100 ] Default: 15 Number of posts per page to retrieve |
lang[] | Array of strings Language(s) of comments to return |
usePreferredLangs | boolean Default: false Filter by a user's preferred languages? (Requires authentication and takes precedence over lang[]) |
{- "items": [
- {
- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "apId": "string",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "childCount": 0,
- "children": [
- {
- "commentId": 0,
- "userId": 0,
- "magazineId": 0,
- "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "comment body",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "sometag"
], - "createdAt": "2023-06-18 11:59:41+00:00",
- "lastActive": "2023-06-18 12:00:45+00:00",
- "childCount": 0,
- "children": [ ]
}
], - "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "visibility": "private"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
comment_id required | integer The post comment to retrieve |
d | integer [ 0 .. 25 ] Default: 10 Comment tree depth to retrieve |
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "apId": "string",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "childCount": 0,
- "children": [
- {
- "commentId": 0,
- "userId": 0,
- "magazineId": 0,
- "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "comment body",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "sometag"
], - "createdAt": "2023-06-18 11:59:41+00:00",
- "lastActive": "2023-06-18 12:00:45+00:00",
- "childCount": 0,
- "children": [ ]
}
], - "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "visibility": "private"
}
comment_id required | integer The id of the comment to update |
d | integer Default: -1 Comment tree depth to retrieve (-1 for unlimited depth) |
body | string or null |
lang | string or null [ 2 .. 3 ] characters |
isAdult | boolean Default: false |
{- "body": "We can post cat pics from the API now! What are you going to do with this power?",
- "lang": "en",
- "isAdult": false
}
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "apId": "string",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "childCount": 0,
- "children": [
- {
- "commentId": 0,
- "userId": 0,
- "magazineId": 0,
- "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "comment body",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "sometag"
], - "createdAt": "2023-06-18 11:59:41+00:00",
- "lastActive": "2023-06-18 12:00:45+00:00",
- "childCount": 0,
- "children": [ ]
}
], - "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "visibility": "private"
}
post_id required | integer Post to which the new comment will belong |
body | string or null |
lang | string or null [ 2 .. 3 ] characters |
isAdult | boolean Default: false |
{- "body": "We can post cat pics from the API now! What are you going to do with this power?",
- "lang": "en",
- "isAdult": false
}
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "apId": "string",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "childCount": 0,
- "children": [
- {
- "commentId": 0,
- "userId": 0,
- "magazineId": 0,
- "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "comment body",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "sometag"
], - "createdAt": "2023-06-18 11:59:41+00:00",
- "lastActive": "2023-06-18 12:00:45+00:00",
- "childCount": 0,
- "children": [ ]
}
], - "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "visibility": "private"
}
post_id required | integer Post to which the new comment will belong |
body | string or null |
lang | string or null [ 2 .. 3 ] characters |
isAdult | boolean Default: false |
alt | string or null |
uploadImage required | string <binary> |
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "apId": "string",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "childCount": 0,
- "children": [
- {
- "commentId": 0,
- "userId": 0,
- "magazineId": 0,
- "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "comment body",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "sometag"
], - "createdAt": "2023-06-18 11:59:41+00:00",
- "lastActive": "2023-06-18 12:00:45+00:00",
- "childCount": 0,
- "children": [ ]
}
], - "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "visibility": "private"
}
post_id required | integer Post to which the new comment will belong |
comment_id required | string |
body | string or null |
lang | string or null [ 2 .. 3 ] characters |
isAdult | boolean Default: false |
{- "body": "We can post cat pics from the API now! What are you going to do with this power?",
- "lang": "en",
- "isAdult": false
}
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "apId": "string",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "childCount": 0,
- "children": [
- {
- "commentId": 0,
- "userId": 0,
- "magazineId": 0,
- "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "comment body",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "sometag"
], - "createdAt": "2023-06-18 11:59:41+00:00",
- "lastActive": "2023-06-18 12:00:45+00:00",
- "childCount": 0,
- "children": [ ]
}
], - "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "visibility": "private"
}
post_id required | integer Post to which the new comment will belong |
comment_id required | string |
body | string or null |
lang | string or null [ 2 .. 3 ] characters |
isAdult | boolean Default: false |
alt | string or null |
uploadImage required | string <binary> |
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "apId": "string",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "childCount": 0,
- "children": [
- {
- "commentId": 0,
- "userId": 0,
- "magazineId": 0,
- "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "comment body",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "sometag"
], - "createdAt": "2023-06-18 11:59:41+00:00",
- "lastActive": "2023-06-18 12:00:45+00:00",
- "childCount": 0,
- "children": [ ]
}
], - "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "visibility": "private"
}
comment_id required | integer The post to report |
reason | string or null |
{- "reason": "string"
}
{- "title": "An error occurred",
- "status": 401,
- "detail": "Unauthorized"
}
comment_id required | integer The comment to favourite |
d | integer Default: -1 Comment tree depth to retrieve (-1 for unlimited depth) |
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "apId": "string",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "childCount": 0,
- "children": [
- {
- "commentId": 0,
- "userId": 0,
- "magazineId": 0,
- "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "comment body",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "sometag"
], - "createdAt": "2023-06-18 11:59:41+00:00",
- "lastActive": "2023-06-18 12:00:45+00:00",
- "childCount": 0,
- "children": [ ]
}
], - "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "visibility": "private"
}
comment_id required | integer The comment to vote upon |
choice required | integer Enum: -1 0 1 The user's voting choice. 0 clears the user's vote. |
{- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "apId": "string",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "childCount": 0,
- "children": [
- {
- "commentId": 0,
- "userId": 0,
- "magazineId": 0,
- "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "comment body",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "sometag"
], - "createdAt": "2023-06-18 11:59:41+00:00",
- "lastActive": "2023-06-18 12:00:45+00:00",
- "childCount": 0,
- "children": [ ]
}
], - "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "visibility": "private"
}
p | integer >= 1 Default: 1 Page of items to retrieve |
perPage | integer [ 1 .. 100 ] Default: 25 Number of items per page |
q required | string Search term |
authorId | integer User id of the author |
magazineId | integer Id of the magazine |
type | string Enum: "" "entry" "post" The type of content |
{- "items": [
- {
- "itemType": "string",
- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}, - "apActors": [
- {
- "type": "string",
- "object": {
- "owner": {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}, - "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "name": "string",
- "title": "string",
- "description": "string",
- "rules": "string",
- "subscriptionsCount": 0,
- "entryCount": 0,
- "entryCommentCount": 0,
- "postCount": 0,
- "postCommentCount": 0,
- "isAdult": false,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "moderators": [
- {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}
], - "apId": "string",
- "apProfileId": "string",
- "magazineId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "isPostingRestrictedToMods": false,
- "localSubscribers": 0,
- "notificationStatus": "Default"
}
}
], - "apObjects": [
- {
- "itemType": "string",
- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
]
}
grant_type required | string Enum: "authorization_code" "refresh_token" "client_credentials" One of the three grant types available |
client_id required | string |
client_secret | string Required if using the client_credentials or authorization_code flow with a confidential client |
code_verifier | string Required if using the PKCE extension to authorization_code flow |
code | string Required during authorization_code flow. The code retrieved after redirect during authorization_code flow. |
refresh_token | string Required during refresh_token flow. This is the refresh token obtained after a successful authorization_code flow. |
redirect_uri | string Required during authorization_code flow. One of the valid redirect_uris that were registered for your client during client creation. |
scope | string Required during client_credentials flow. A space-delimited list of scopes the client token will be provided. |
You can create a public or confidential client with any of 3 flows available. It's
recommended that you pick either client_credentials
, or authorization_code
and refresh_token
.
When creating clients with the client_credentials grant type, you must provide a unique username and contact email. The username and email will be used to create a new bot user, which your client authenticates as during the client_credentials flow. This user will be tagged as a bot on all of their posts, comments, and on their profile. In addition, the bot will not be allowed to use the API to vote on content.
If you are creating a client that will be used on a native app or webapp, the client should be marked as public. This will skip generation of a client secret and will require the client to use the PKCE (https://www.oauth.com/oauth2-servers/pkce/) extension during authorization_code flow. A public client cannot use the client_credentials flow. Public clients are recommended because apps running on user devices technically cannot store secrets safely - if they're determined enough, the user could retrieve the secret from their device's memory.
name required | string |
contactEmail required | string |
description | string or null |
public | boolean or null Native applications installed on user devices and web apps are considered public since they cannot store secrets securely, so they should use PKCE. https://www.oauth.com/oauth2-servers/pkce/ |
username | string or null[a-zA-Z0-9_\-]{1,30} Required if using the client_credentials grant type. Will attempt to create a bot user with the given username. |
redirectUris | Array of strings Default: [] |
grants | Array of strings non-empty Default: [] Items Enum: "client_credentials" "authorization_code" "refresh_token" |
scopes | Array of strings non-empty Default: ["read"] Items Enum: "read" "write" "delete" "subscribe" "block" "vote" "report" "domain" "domain:subscribe" "domain:block" "entry" "entry:create" "entry:edit" "entry:delete" "entry:vote" "entry:report" "entry_comment" "entry_comment:create" "entry_comment:edit" "entry_comment:delete" "entry_comment:vote" "entry_comment:report" "magazine" "magazine:subscribe" "magazine:block" "post" "post:create" "post:edit" "post:delete" "post:vote" "post:report" "post_comment" "post_comment:create" "post_comment:edit" "post_comment:delete" "post_comment:vote" "post_comment:report" "user" "user:profile" "user:profile:read" "user:profile:edit" "bookmark" "bookmark:add" "bookmark:remove" "bookmark_list" "bookmark_list:read" "bookmark_list:edit" "bookmark_list:delete" "user:message" "user:message:read" "user:message:create" "user:notification" "user:notification:read" "user:notification:delete" "user:notification:edit" "user:oauth_clients" "user:oauth_clients:read" "user:oauth_clients:edit" "user:follow" "user:block" "moderate" "moderate:entry" "moderate:entry:language" "moderate:entry:pin" "moderate:entry:set_adult" "moderate:entry:trash" "moderate:entry_comment" "moderate:entry_comment:language" "moderate:entry_comment:set_adult" "moderate:entry_comment:trash" "moderate:post" "moderate:post:language" "moderate:post:pin" "moderate:post:set_adult" "moderate:post:trash" "moderate:post_comment" "moderate:post_comment:language" "moderate:post_comment:set_adult" "moderate:post_comment:trash" "moderate:magazine" "moderate:magazine:ban" "moderate:magazine:ban:read" "moderate:magazine:ban:create" "moderate:magazine:ban:delete" "moderate:magazine:list" "moderate:magazine:reports" "moderate:magazine:reports:read" "moderate:magazine:reports:action" "moderate:magazine:trash:read" "moderate:magazine_admin" "moderate:magazine_admin:create" "moderate:magazine_admin:delete" "moderate:magazine_admin:update" "moderate:magazine_admin:theme" "moderate:magazine_admin:moderators" "moderate:magazine_admin:badges" "moderate:magazine_admin:tags" "moderate:magazine_admin:stats" "admin" "admin:entry:purge" "admin:entry_comment:purge" "admin:post:purge" "admin:post_comment:purge" "admin:magazine" "admin:magazine:move_entry" "admin:magazine:purge" "admin:user" "admin:user:ban" "admin:user:verify" "admin:user:delete" "admin:user:purge" "admin:instance" "admin:instance:stats" "admin:instance:settings" "admin:instance:settings:read" "admin:instance:settings:edit" "admin:instance:information:edit" "admin:federation" "admin:federation:read" "admin:federation:update" "admin:oauth_clients" "admin:oauth_clients:read" "admin:oauth_clients:revoke" |
{- "name": "string",
- "contactEmail": "string",
- "description": "string",
- "public": true,
- "username": "string",
- "grants": [
- "authorization_code",
- "refresh_token"
], - "scopes": [
- "read"
]
}
{- "identifier": "string",
- "secret": "string",
- "name": "string",
- "contactEmail": "string",
- "description": "string",
- "user": { },
- "grants": [
- "authorization_code",
- "refresh_token"
], - "scopes": [
- "read"
], - "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}
}
This is useful if a confidential client has had their secret compromised and a new client needs to be created. A public client cannot be deleted in this manner since it does not have a secret to be compromised
client_id required | string |
client_secret required | string |
{- "title": "An error occurred",
- "status": 400,
- "detail": "Bad Request"
}
The image uploaded to this endpoint will be shown to users on the consent page as your application's logo.
You can create a public or confidential client with any of 3 flows available. It's
recommended that you pick either client_credentials
, or authorization_code
and refresh_token
.
When creating clients with the client_credentials grant type, you must provide a unique username and contact email. The username and email will be used to create a new bot user, which your client authenticates as during the client_credentials flow. This user will be tagged as a bot on all of their posts, comments, and on their profile. In addition, the bot will not be allowed to use the API to vote on content.
If you are creating a client that will be used on a native app or webapp, the client should be marked as public. This will skip generation of a client secret and will require the client to use the PKCE (https://www.oauth.com/oauth2-servers/pkce/) extension during authorization_code flow. A public client cannot use the client_credentials flow. Public clients are recommended because apps running on user devices technically cannot store secrets safely - if they're determined enough, the user could retrieve the secret from their device's memory.
name required | string |
contactEmail required | string |
description | string or null |
public | boolean or null Native applications installed on user devices and web apps are considered public since they cannot store secrets securely, so they should use PKCE. https://www.oauth.com/oauth2-servers/pkce/ |
username | string or null[a-zA-Z0-9_\-]{1,30} Required if using the client_credentials grant type. Will attempt to create a bot user with the given username. |
redirectUris | Array of strings Default: [] |
grants | Array of strings non-empty Default: [] Items Enum: "client_credentials" "authorization_code" "refresh_token" |
scopes | Array of strings non-empty Default: ["read"] Items Enum: "read" "write" "delete" "subscribe" "block" "vote" "report" "domain" "domain:subscribe" "domain:block" "entry" "entry:create" "entry:edit" "entry:delete" "entry:vote" "entry:report" "entry_comment" "entry_comment:create" "entry_comment:edit" "entry_comment:delete" "entry_comment:vote" "entry_comment:report" "magazine" "magazine:subscribe" "magazine:block" "post" "post:create" "post:edit" "post:delete" "post:vote" "post:report" "post_comment" "post_comment:create" "post_comment:edit" "post_comment:delete" "post_comment:vote" "post_comment:report" "user" "user:profile" "user:profile:read" "user:profile:edit" "bookmark" "bookmark:add" "bookmark:remove" "bookmark_list" "bookmark_list:read" "bookmark_list:edit" "bookmark_list:delete" "user:message" "user:message:read" "user:message:create" "user:notification" "user:notification:read" "user:notification:delete" "user:notification:edit" "user:oauth_clients" "user:oauth_clients:read" "user:oauth_clients:edit" "user:follow" "user:block" "moderate" "moderate:entry" "moderate:entry:language" "moderate:entry:pin" "moderate:entry:set_adult" "moderate:entry:trash" "moderate:entry_comment" "moderate:entry_comment:language" "moderate:entry_comment:set_adult" "moderate:entry_comment:trash" "moderate:post" "moderate:post:language" "moderate:post:pin" "moderate:post:set_adult" "moderate:post:trash" "moderate:post_comment" "moderate:post_comment:language" "moderate:post_comment:set_adult" "moderate:post_comment:trash" "moderate:magazine" "moderate:magazine:ban" "moderate:magazine:ban:read" "moderate:magazine:ban:create" "moderate:magazine:ban:delete" "moderate:magazine:list" "moderate:magazine:reports" "moderate:magazine:reports:read" "moderate:magazine:reports:action" "moderate:magazine:trash:read" "moderate:magazine_admin" "moderate:magazine_admin:create" "moderate:magazine_admin:delete" "moderate:magazine_admin:update" "moderate:magazine_admin:theme" "moderate:magazine_admin:moderators" "moderate:magazine_admin:badges" "moderate:magazine_admin:tags" "moderate:magazine_admin:stats" "admin" "admin:entry:purge" "admin:entry_comment:purge" "admin:post:purge" "admin:post_comment:purge" "admin:magazine" "admin:magazine:move_entry" "admin:magazine:purge" "admin:user" "admin:user:ban" "admin:user:verify" "admin:user:delete" "admin:user:purge" "admin:instance" "admin:instance:stats" "admin:instance:settings" "admin:instance:settings:read" "admin:instance:settings:edit" "admin:instance:information:edit" "admin:federation" "admin:federation:read" "admin:federation:update" "admin:oauth_clients" "admin:oauth_clients:read" "admin:oauth_clients:revoke" |
uploadImage required | string <binary> |
{- "identifier": "string",
- "secret": "string",
- "name": "string",
- "contactEmail": "string",
- "description": "string",
- "user": { },
- "grants": [
- "authorization_code",
- "refresh_token"
], - "scopes": [
- "read"
], - "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}
}
{- "title": "An error occurred",
- "status": 403,
- "detail": "Forbidden"
}
consent_id required | integer Client consent to retrieve |
{- "consentId": 0,
- "client": "string",
- "description": "string",
- "clientLogo": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "scopesGranted": [
- "read"
], - "scopesAvailable": [
- "read"
]
}
The API cannot, however, add extra scopes the user has not consented to. That's what the OAuth flow is for ;) This endpoint will not revoke any tokens that currently exist with the given scopes, those tokens will need to be revoked elsewhere.
consent_id required | integer Client consent to update |
scopes required | Array of strings Items Enum: "read" "write" "delete" "subscribe" "block" "vote" "report" "domain" "domain:subscribe" "domain:block" "entry" "entry:create" "entry:edit" "entry:delete" "entry:vote" "entry:report" "entry_comment" "entry_comment:create" "entry_comment:edit" "entry_comment:delete" "entry_comment:vote" "entry_comment:report" "magazine" "magazine:subscribe" "magazine:block" "post" "post:create" "post:edit" "post:delete" "post:vote" "post:report" "post_comment" "post_comment:create" "post_comment:edit" "post_comment:delete" "post_comment:vote" "post_comment:report" "user" "user:profile" "user:profile:read" "user:profile:edit" "bookmark" "bookmark:add" "bookmark:remove" "bookmark_list" "bookmark_list:read" "bookmark_list:edit" "bookmark_list:delete" "user:message" "user:message:read" "user:message:create" "user:notification" "user:notification:read" "user:notification:delete" "user:notification:edit" "user:oauth_clients" "user:oauth_clients:read" "user:oauth_clients:edit" "user:follow" "user:block" "moderate" "moderate:entry" "moderate:entry:language" "moderate:entry:pin" "moderate:entry:set_adult" "moderate:entry:trash" "moderate:entry_comment" "moderate:entry_comment:language" "moderate:entry_comment:set_adult" "moderate:entry_comment:trash" "moderate:post" "moderate:post:language" "moderate:post:pin" "moderate:post:set_adult" "moderate:post:trash" "moderate:post_comment" "moderate:post_comment:language" "moderate:post_comment:set_adult" "moderate:post_comment:trash" "moderate:magazine" "moderate:magazine:ban" "moderate:magazine:ban:read" "moderate:magazine:ban:create" "moderate:magazine:ban:delete" "moderate:magazine:list" "moderate:magazine:reports" "moderate:magazine:reports:read" "moderate:magazine:reports:action" "moderate:magazine:trash:read" "moderate:magazine_admin" "moderate:magazine_admin:create" "moderate:magazine_admin:delete" "moderate:magazine_admin:update" "moderate:magazine_admin:theme" "moderate:magazine_admin:moderators" "moderate:magazine_admin:badges" "moderate:magazine_admin:tags" "moderate:magazine_admin:stats" "admin" "admin:entry:purge" "admin:entry_comment:purge" "admin:post:purge" "admin:post_comment:purge" "admin:magazine" "admin:magazine:move_entry" "admin:magazine:purge" "admin:user" "admin:user:ban" "admin:user:verify" "admin:user:delete" "admin:user:purge" "admin:instance" "admin:instance:stats" "admin:instance:settings" "admin:instance:settings:read" "admin:instance:settings:edit" "admin:instance:information:edit" "admin:federation" "admin:federation:read" "admin:federation:update" "admin:oauth_clients" "admin:oauth_clients:read" "admin:oauth_clients:revoke" The scopes the app has permission to access |
{- "scopes": [
- "read"
]
}
{- "consentId": 0,
- "client": "string",
- "description": "string",
- "clientLogo": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "scopesGranted": [
- "read"
], - "scopesAvailable": [
- "read"
]
}
p | integer >= 1 Default: 1 Page of clients to retrieve |
perPage | integer [ 1 .. 100 ] Default: 15 Number of clients to retrieve per page |
{- "items": [
- {
- "consentId": 0,
- "client": "string",
- "description": "string",
- "clientLogo": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "scopesGranted": [
- "read"
], - "scopesAvailable": [
- "read"
]
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
p | integer >= 1 Default: 1 Page of users to retrieve |
perPage | integer [ 1 .. 100 ] Default: 48 Number of users per page |
group | string Default: "all" Enum: "all" "local" "remote" What group of users to retrieve |
q | string The term to search for |
withAbout | boolean Only include users with a filled in profile |
{- "items": [
- {
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
p | integer >= 1 Default: 1 Page of users to retrieve |
perPage | integer [ 1 .. 100 ] Default: 48 Number of users per page |
{- "items": [
- {
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
p | integer >= 1 Default: 1 Page of users to retrieve |
perPage | integer [ 1 .. 100 ] Default: 48 Number of users per page |
{- "items": [
- {
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
p | integer >= 1 Default: 1 Page of users to retrieve |
perPage | integer [ 1 .. 100 ] Default: 48 Number of users per page |
{- "items": [
- {
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
{- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
about | string or null |
{- "about": "string"
}
{- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
{- "notifyOnNewEntry": null,
- "notifyOnNewEntryReply": null,
- "notifyOnNewEntryCommentReply": null,
- "notifyOnNewPost": null,
- "notifyOnNewPostReply": null,
- "notifyOnNewPostCommentReply": null,
- "hideAdult": null,
- "showProfileSubscriptions": null,
- "showProfileFollowings": null,
- "addMentionsEntries": true,
- "addMentionsPosts": true,
- "homepage": "front",
- "frontDefaultSort": "active",
- "commentDefaultSort": "newest",
- "featuredMagazines": null,
- "preferredLanguages": null,
- "customCss": null,
- "ignoreMagazinesCustomCss": null,
- "notifyOnUserSignup": null
}
notifyOnNewEntry | boolean or null Default: null |
notifyOnNewEntryReply | boolean or null Default: null |
notifyOnNewEntryCommentReply | boolean or null Default: null |
notifyOnNewPost | boolean or null Default: null |
notifyOnNewPostReply | boolean or null Default: null |
notifyOnNewPostCommentReply | boolean or null Default: null |
hideAdult | boolean or null Default: null |
showProfileSubscriptions | boolean or null Default: null |
showProfileFollowings | boolean or null Default: null |
addMentionsEntries | boolean or null |
addMentionsPosts | boolean or null |
homepage | string or null Default: null Enum: "front" "front_subscribed" "front_moderated" "front_favourite" |
frontDefaultSort | string or null Default: null Enum: "active" "hot" "newest" "top" "commented" |
commentDefaultSort | string or null Default: null Enum: "newest" "top" "hot" "newest" "oldest" |
featuredMagazines | Array of strings or null Default: null |
preferredLanguages | Array of strings or null Default: null |
customCss | string or null Default: null |
ignoreMagazinesCustomCss | boolean or null Default: null |
notifyOnUserSignup | boolean or null Default: null |
{- "notifyOnNewEntry": null,
- "notifyOnNewEntryReply": null,
- "notifyOnNewEntryCommentReply": null,
- "notifyOnNewPost": null,
- "notifyOnNewPostReply": null,
- "notifyOnNewPostCommentReply": null,
- "hideAdult": null,
- "showProfileSubscriptions": null,
- "showProfileFollowings": null,
- "addMentionsEntries": true,
- "addMentionsPosts": true,
- "homepage": "front",
- "frontDefaultSort": "active",
- "commentDefaultSort": "newest",
- "featuredMagazines": null,
- "preferredLanguages": null,
- "customCss": null,
- "ignoreMagazinesCustomCss": null,
- "notifyOnUserSignup": null
}
{- "notifyOnNewEntry": null,
- "notifyOnNewEntryReply": null,
- "notifyOnNewEntryCommentReply": null,
- "notifyOnNewPost": null,
- "notifyOnNewPostReply": null,
- "notifyOnNewPostCommentReply": null,
- "hideAdult": null,
- "showProfileSubscriptions": null,
- "showProfileFollowings": null,
- "addMentionsEntries": true,
- "addMentionsPosts": true,
- "homepage": "front",
- "frontDefaultSort": "active",
- "commentDefaultSort": "newest",
- "featuredMagazines": null,
- "preferredLanguages": null,
- "customCss": null,
- "ignoreMagazinesCustomCss": null,
- "notifyOnUserSignup": null
}
uploadImage required | string <binary> |
{- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
{- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
uploadImage required | string <binary> |
{- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
{- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
{- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
{- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
user_id required | integer User from which to retrieve followed users |
p | integer >= 1 Default: 1 Page of users to retrieve |
perPage | integer [ 1 .. 100 ] Default: 48 Number of users per page |
{- "items": [
- {
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
user_id required | integer User from which to retrieve following users |
p | integer >= 1 Default: 1 Page of users to retrieve |
perPage | integer [ 1 .. 100 ] Default: 48 Number of users per page |
{- "items": [
- {
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
user_id required | integer The user to block |
{- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
user_id required | integer The user to unblock |
{- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
user_id required | integer The user to follow |
{- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
user_id required | integer The user to unfollow |
{- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "cover": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "followersCount": 0,
- "about": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "apProfileId": "string",
- "apId": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "userId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "notificationStatus": "Default",
- "reputationPoints": 0
}
user_id required | integer User from which to retrieve subscribed magazines |
p | integer >= 1 Default: 1 Page of magazines to retrieve |
perPage | integer [ 1 .. 100 ] Default: 48 Number of magazines per page |
{- "items": [
- {
- "owner": {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}, - "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "name": "string",
- "title": "string",
- "description": "string",
- "rules": "string",
- "subscriptionsCount": 0,
- "entryCount": 0,
- "entryCommentCount": 0,
- "postCount": 0,
- "postCommentCount": 0,
- "isAdult": false,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "moderators": [
- {
- "magazineId": 0,
- "userId": 0,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "username": "string",
- "apId": "string"
}
], - "apId": "string",
- "apProfileId": "string",
- "magazineId": 0,
- "serverSoftware": "string",
- "serverSoftwareVersion": "string",
- "isPostingRestrictedToMods": false,
- "localSubscribers": 0,
- "notificationStatus": "Default"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
user_id required | integer User from which to retrieve subscribed domains |
p | integer >= 1 Default: 1 Page of domains to retrieve |
perPage | integer [ 1 .. 100 ] Default: 100 Number of domains per page |
{- "items": [
- {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
user_id required | integer The user whose entries to retrieve |
sort | any Default: "hot" Enum: "active" "hot" "newest" "oldest" "top" "commented" The sorting method to use during entry fetch |
time | any Default: "∞" Enum: "3h" "6h" "12h" "1d" "1w" "1m" "1y" "∞" "all" The maximum age of retrieved entries |
p | integer >= 1 Default: 1 Page of entries to retrieve |
perPage | integer [ 1 .. 100 ] Default: 25 Number of entries to retrieve per page |
lang[] | Array of strings[ items [ 2 .. 3 ] characters ] Language(s) of entries to return |
usePreferredLangs | boolean Default: false Filter by a user's preferred languages? (Requires authentication and takes precedence over lang[]) |
{- "items": [
- {
- "entryId": 0,
- "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "domain": {
- "name": "string",
- "entryCount": 0,
- "subscriptionsCount": 0,
- "isUserSubscribed": true,
- "isBlockedByUser": true,
- "domainId": 0
}, - "title": "string",
- "url": "string",
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "tags": [
- "string"
], - "badges": [
- {
- "magazineId": 0,
- "name": "string",
- "badgeId": 0
}
], - "numComments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isOc": false,
- "isAdult": false,
- "isPinned": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "type": "article",
- "slug": "string",
- "apId": "string",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "isAuthorModeratorInMagazine": true,
- "bookmarks": [
- "string"
], - "crosspostedEntries": [
- { }
], - "visibility": "private"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
user_id required | integer The user whose comments should be retrieved |
sort | string Default: "hot" Enum: "newest" "top" "hot" "newest" "oldest" The sorting method to use during comment fetch |
time | string Default: "∞" Enum: "3h" "6h" "12h" "1d" "1w" "1m" "1y" "∞" "all" The maximum age of retrieved entries |
p | integer >= 1 Default: 1 Page of comments to retrieve |
perPage | integer [ 1 .. 100 ] Default: 25 Number of comments to retrieve per page |
d | integer [ 0 .. 25 ] Default: 10 Depth of comment children to retrieve |
lang[] | Array of strings[ items [ 2 .. 3 ] characters ] Language(s) of entries to return |
usePreferredLangs | boolean Default: false Filter by a user's preferred languages? (Requires authentication and takes precedence over lang[]) |
{- "items": [
- {
- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "isAdult": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "apId": "string",
- "children": [
- {
- "commentid": 0,
- "user": {
- "userId": 0,
- "username": "test"
}, - "magazine": {
- "magazineId": 0,
- "name": "test"
}, - "entryId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "string"
], - "createdAt": "2023-06-18 11:59:41-07:00",
- "editedAt": "2023-06-18 11:59:41-07:00",
- "lastActive": "2023-06-18 12:00:45-07:00",
- "childCount": 0,
- "children": [ ]
}
], - "childCount": 0,
- "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
user_id required | integer User whose posts to retrieve |
p | integer >= 1 Default: 1 Page of posts to retrieve |
perPage | integer [ 1 .. 100 ] Default: 15 Number of posts to retrieve per page |
sort | string Default: "hot" Enum: "active" "hot" "newest" "oldest" "top" "commented" Sort method to use when retrieving posts |
time | string Default: "∞" Enum: "3h" "6h" "12h" "1d" "1w" "1m" "1y" "∞" "all" Max age of retrieved posts |
lang[] | Array of strings[ items [ 2 .. 3 ] characters ] Language(s) of posts to return |
usePreferredLangs | boolean Default: false Filter by a user's preferred languages? (Requires authentication and takes precedence over lang[]) |
{- "items": [
- {
- "postId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "isPinned": false,
- "slug": "string",
- "comments": 0,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "tags": [
- "string"
], - "mentions": [
- "string"
], - "apId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "canAuthUserModerate": true,
- "notificationStatus": "Default",
- "bookmarks": [
- "string"
], - "isAuthorModeratorInMagazine": true,
- "visibility": "private"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}
user_id required | integer User whose comments to retrieve |
p | integer >= 1 Default: 1 Page of comments to retrieve |
d | integer [ 0 .. 25 ] Default: 10 Max depth of comment tree to retrieve |
perPage | integer [ 1 .. 100 ] Default: 15 Number of posts per page to retrieve |
sort | string Default: "hot" Enum: "active" "hot" "newest" "oldest" "top" "commented" Sort method to use when retrieving comments |
time | string Default: "∞" Enum: "3h" "6h" "12h" "1d" "1w" "1m" "1y" "∞" "all" Max age of retrieved posts |
lang[] | Array of strings Language(s) of comments to return |
usePreferredLangs | boolean Default: false Filter by a user's preferred languages? (Requires authentication and takes precedence over lang[]) |
{- "items": [
- {
- "commentId": 0,
- "user": {
- "userId": 0,
- "username": "string",
- "isBot": true,
- "isFollowedByUser": true,
- "isFollowerOfUser": true,
- "isBlockedByUser": true,
- "isAdmin": true,
- "isGlobalModerator": true,
- "avatar": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "apId": "string",
- "apProfileId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "magazine": {
- "name": "string",
- "magazineId": 0,
- "icon": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "isUserSubscribed": true,
- "isBlockedByUser": true,
- "apId": "string",
- "apProfileId": "string"
}, - "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "string",
- "sourceUrl": "string",
- "storageUrl": "string",
- "altText": "string",
- "width": 0,
- "height": 0,
- "blurHash": "string"
}, - "body": "string",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "isFavourited": true,
- "userVote": 0,
- "apId": "string",
- "mentions": [
- "string"
], - "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "editedAt": "2019-08-24T14:15:22Z",
- "lastActive": "2019-08-24T14:15:22Z",
- "childCount": 0,
- "children": [
- {
- "commentId": 0,
- "userId": 0,
- "magazineId": 0,
- "postId": 0,
- "parentId": 0,
- "rootId": 0,
- "image": {
- "filePath": "x/y/z.png",
- "width": 3000,
- "height": 4000
}, - "body": "comment body",
- "lang": "en",
- "isAdult": false,
- "uv": 0,
- "dv": 0,
- "favourites": 0,
- "visibility": "visible",
- "apId": "string",
- "mentions": [
- "@user@instance"
], - "tags": [
- "sometag"
], - "createdAt": "2023-06-18 11:59:41+00:00",
- "lastActive": "2023-06-18 12:00:45+00:00",
- "childCount": 0,
- "children": [ ]
}
], - "canAuthUserModerate": true,
- "bookmarks": [
- "string"
], - "visibility": "private"
}
], - "pagination": {
- "count": 0,
- "currentPage": 0,
- "maxPage": 0,
- "perPage": 0
}
}