Download OpenAPI specification:Download
This is documentation for client Pleroma API. Most of the endpoints and entities come from Mastodon API and have custom extensions on top.
While this document aims to be a complete guide to the client API Pleroma exposes, the details are still being worked out. Some endpoints may have incomplete or poorly worded documentation. You might want to check the following resources if something is not clear:
Please report such occurrences on our issue tracker. Feel free to submit API questions or proposals there too!
Adds the given account to endorsed accounts list.
follow
write:accounts
) id required | string Example: 123 Account ID or nickname |
{- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}
Mute the given account. Clients should filter statuses and notifications from this account, if received (e.g. due to a boost in the Home timeline).
follow
write:mutes
) id required | string Example: 123 Account ID or nickname |
boolean or string or integer Default: true Mute notifications in addition to statuses? Defaults to | |
duration | integer Expire the mute in |
expires_in | integer Default: 0 Deprecated, use |
Parameters
duration | integer Nullable Expire the mute in |
expires_in | integer Nullable Default: 0 Deprecated, use |
boolean or string or integer Nullable Default: true Mute notifications in addition to statuses? Defaults to true. |
{- "expires_in": 86400,
- "notifications": true
}
{- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}
Receive notifications for all statuses posted by the account. Deprecated, use notify: true
in follow operation instead.
follow
write:follows
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Account ID |
{- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}
Create a note for the given account.
follow
write:accounts
) id required | string Example: 123 Account ID or nickname |
comment | string Account note body |
Parameters
comment | string Account note body |
{- "comment": "Example note"
}
{- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}
Removes the given account from endorsed accounts list.
follow
write:accounts
) id required | string Example: 123 Account ID or nickname |
{- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}
Remove the given account from followers
follow
write:follows
) id required | string Example: 123 Account ID or nickname |
{- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}
Block the given account. Clients should filter statuses from this account if received (e.g. due to a boost in the Home timeline)
follow
write:blocks
) id required | string Example: 123 Account ID or nickname |
{- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}
Unblock the given account.
follow
write:blocks
) id required | string Example: 123 Account ID or nickname |
{- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}
Unmute the given account.
follow
write:mutes
) id required | string Example: 123 Account ID or nickname |
{- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}
Unfollow the given account
follow
write:follows
) id required | string Example: 123 Account ID or nickname |
{- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}
Stop receiving notifications for all statuses posted by the account. Deprecated, use notify: false
in follow operation instead.
follow
write:follows
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Account ID |
{- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}
Follow the given account
follow
write:follows
) id required | string Example: 123 Account ID or nickname |
Parameters
boolean or string or integer Default: false Receive notifications for all statuses posted by the account? Defaults to false. | |
boolean or string or integer Default: true Receive this account's reblogs in home timeline? Defaults to true. |
{- "notify": true,
- "reblogs": true
}
{- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}
follow
write:follows
) Parameters
uri required | string <uri> Nullable |
{
}
{- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}
Find out whether a given account is followed, blocked, muted, etc.
read:follows
) Array of strings or string Example: id=123 Account IDs |
[- {
- "blocked_by": true,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": true,
- "followed_by": true,
- "following": true,
- "id": "1",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - {
- "blocked_by": true,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": true,
- "following": true,
- "id": "2",
- "muting": true,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": true,
- "showing_reblogs": true,
- "subscribing": false
}, - {
- "blocked_by": false,
- "blocking": true,
- "domain_blocking": true,
- "endorsed": false,
- "followed_by": true,
- "following": true,
- "id": "3",
- "muting": true,
- "muting_notifications": false,
- "note": "",
- "notifying": true,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": true
}
]
Only returns data if the user has opted into sharing it. See hide_favorites
in Update account credentials.
read:favourites
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Account ID |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
]
{- "acct": "string",
- "bot": true,
- "created_at": "2019-08-24T14:15:22Z",
- "display_name": "string",
- "emojis": [
- {
- "shortcode": "fatyoshi",
- "visible_in_picker": true
}
], - "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 0,
- "id": "string",
- "is_active": true,
- "is_confirmed": true,
- "local": true,
- "locked": true,
- "mute_expires_at": "2019-08-24T14:15:22Z",
- "nickname": "string",
- "note": "string",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "also_known_as": [
- "string"
], - "ap_id": "string",
- "avatar_description": "string",
- "birthday": "2019-08-24",
- "chat_token": "string",
- "header_description": "string",
- "hide_favorites": true,
- "hide_followers": true,
- "hide_followers_count": true,
- "hide_follows": true,
- "hide_follows_count": true,
- "is_admin": true,
- "is_confirmed": true,
- "is_moderator": true,
- "notification_settings": {
- "block_from_strangers": true,
- "hide_notification_contents": true
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": { },
- "show_birthday": true,
- "skip_thread_containment": true,
- "tags": [
- "string"
], - "unread_conversation_count": 0
}, - "roles": {
- "admin": true,
- "moderator": true
}, - "source": {
- "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "note": "string",
- "pleroma": {
- "actor_type": "Application",
- "discoverable": true,
- "no_rich_text": true,
- "show_role": true
}, - "privacy": "public",
- "sensitive": true
}, - "statuses_count": 0,
- "username": "string"
}
Obtain a list of all accounts that follow a given account, filtered for accounts you follow.
read:follows
) Array of strings or string Example: id=123 Account IDs |
[- {
- "accounts": [
- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
], - "id": "string"
}
]
Accounts which follow the given account, if network is not hidden by the account owner.
read:accounts
) id required | string Example: 123 Account ID or nickname |
id | string ID of the resource owner |
boolean or string or integer (BooleanLike) Embed relationships into accounts. If this parameter is not set account's | |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
]
Returns endorsed accounts
id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Account ID |
boolean or string or integer (BooleanLike) Embed relationships into accounts. If this parameter is not set account's |
[- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
]
[- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
]
View information about a profile.
id required | string Example: 123 Account ID or nickname |
boolean or string or integer (BooleanLike) Embed relationships into accounts. If this parameter is not set account's |
{- "acct": "string",
- "bot": true,
- "created_at": "2019-08-24T14:15:22Z",
- "display_name": "string",
- "emojis": [
- {
- "shortcode": "fatyoshi",
- "visible_in_picker": true
}
], - "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 0,
- "id": "string",
- "is_active": true,
- "is_confirmed": true,
- "local": true,
- "locked": true,
- "mute_expires_at": "2019-08-24T14:15:22Z",
- "nickname": "string",
- "note": "string",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "also_known_as": [
- "string"
], - "ap_id": "string",
- "avatar_description": "string",
- "birthday": "2019-08-24",
- "chat_token": "string",
- "header_description": "string",
- "hide_favorites": true,
- "hide_followers": true,
- "hide_followers_count": true,
- "hide_follows": true,
- "hide_follows_count": true,
- "is_admin": true,
- "is_confirmed": true,
- "is_moderator": true,
- "notification_settings": {
- "block_from_strangers": true,
- "hide_notification_contents": true
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": { },
- "show_birthday": true,
- "skip_thread_containment": true,
- "tags": [
- "string"
], - "unread_conversation_count": 0
}, - "roles": {
- "admin": true,
- "moderator": true
}, - "source": {
- "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "note": "string",
- "pleroma": {
- "actor_type": "Application",
- "discoverable": true,
- "no_rich_text": true,
- "show_role": true
}, - "privacy": "public",
- "sensitive": true
}, - "statuses_count": 0,
- "username": "string"
}
Statuses posted to the given account. Public (for public statuses only), or user token + read:statuses
(for private statuses the user is authorized to see)
id required | string Example: 123 Account ID or nickname |
boolean or string or integer (BooleanLike) Include only pinned statuses | |
tagged | string With tag |
boolean or string or integer (BooleanLike) Include only statuses with media attached | |
boolean or string or integer (BooleanLike) Include statuses from muted accounts. | |
boolean or string or integer (BooleanLike) Exclude reblogs | |
boolean or string or integer (BooleanLike) Exclude replies | |
exclude_visibilities | Array of strings (VisibilityScope) Items Enum: "public" "unlisted" "local" "private" "direct" "list" Exclude visibilities |
boolean or string or integer (BooleanLike) Include reactions from muted accounts. | |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
]
User lists that you have added this account to.
read:lists
) id required | string Example: 123 Account ID or nickname |
[- {
- "id": "123",
- "title": "my list"
}, - {
- "id": "1337",
- "title": "anotehr list"
}
]
Birthday reminders about users you follow.
read:accounts
) day | integer Day of users' birthdays |
month | integer Month of users' birthdays |
[- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
]
Accounts which the given account is following, if network is not hidden by the account owner.
read:accounts
) id required | string Example: 123 Account ID or nickname |
id | string ID of the resource owner |
boolean or string or integer (BooleanLike) Embed relationships into accounts. If this parameter is not set account's | |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
]
write
) Parameters
album | string The album of the media playing |
artist | string The artist of the media playing |
externalLink | string A URL referencing the media playing |
length | integer The length of the media playing |
title required | string The title of the media playing |
visibility | string Default: "public" Enum: "public" "unlisted" "local" "private" "direct" "list" Scrobble visibility |
{- "album": "Some Album",
- "artist": "Some Artist",
- "length": 180000,
- "title": "Some Title"
}
{- "account": {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}, - "album": "Some Album",
- "artist": "Some Artist",
- "created_at": "2019-09-28T12:40:45.000Z",
- "id": "1234",
- "length": 180000,
- "title": "Some Title"
}
read
) id required | string Example: 123 Account ID or nickname |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "account": {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}, - "album": "Some Album",
- "artist": "Some Artist",
- "created_at": "2019-09-28T12:40:45.000Z",
- "id": "1234",
- "length": 180000,
- "title": "Some Title"
}
]
admin:read:chats
) id required | string The ID of the Chat |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "account_id": "someflakeid",
- "chat_id": "1",
- "content": "Check this out :firefox:",
- "created_at": "2020-04-21T15:11:46.000Z",
- "emojis": [
- {
- "shortcode": "firefox",
- "visible_in_picker": false
}
], - "id": "13",
- "unread": false
}, - {
- "account_id": "someflakeid",
- "chat_id": "1",
- "content": "Whats' up?",
- "created_at": "2020-04-21T15:06:45.000Z",
- "emojis": [ ],
- "id": "12",
- "unread": false
}
]
admin:write:chats
) id required | string The ID of the Chat |
message_id required | string The ID of the message |
{- "account_id": "someflakeid",
- "attachment": null,
- "card": null,
- "chat_id": "1",
- "content": "hey you again",
- "created_at": "2020-04-21T15:06:45.000Z",
- "emojis": [
- {
- "shortcode": "firefox",
- "visible_in_picker": false
}
], - "id": "14",
- "unread": false
}
admin:read
) id required | string Example: 1234 The id of the chat |
{- "account": {
- "acct": "lain@dontbulling.me",
- "bot": false,
- "created_at": "2020-04-16T13:40:15.000Z",
- "display_name": "lain",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 0,
- "following_count": 0,
- "id": "9u6Qw6TAZANpqokMkK",
- "is_locked": false,
- "note": "lain",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": { },
- "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "lain",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "lain"
}, - "id": "1",
- "last_message": {
- "account_id": "someflakeid",
- "attachment": null,
- "card": null,
- "chat_id": "1",
- "content": "hey you again",
- "created_at": "2020-04-21T15:06:45.000Z",
- "emojis": [
- {
- "shortcode": "firefox",
- "visible_in_picker": false
}
], - "id": "14",
- "unread": false
}, - "unread": 2,
- "updated_at": "2020-04-21T15:06:45.000Z"
}
[- "string"
]
admin:write
) name required | string Example: name=cofe Pack Name |
shortcode required | string Example: shortcode=cofe File shortcode |
{- "property1": "string",
- "property2": "string"
}
admin:write
) name required | string Example: name=cofe Pack Name |
Parameters
force | boolean Default: false With true value to overwrite existing emoji with new shortcode |
new_filename required | string New filename for emoji file |
new_shortcode required | string New emoji file shortcode |
shortcode required | string Emoji file shortcode |
{- "force": false,
- "new_filename": "string",
- "new_shortcode": "string",
- "shortcode": "string"
}
{- "property1": "string",
- "property2": "string"
}
admin:write
) name required | string Example: name=cofe Pack Name |
Parameters
required | string or string File needs to be uploaded with the multipart request or link to remote file |
filename | string New emoji file name. If not specified will be taken from original filename. |
shortcode | string Shortcode for new emoji, must be unique for all emoji. If not sended, shortcode will be taken from original filename. |
{- "file": "string",
- "filename": "string",
- "shortcode": "string"
}
{- "property1": "string",
- "property2": "string"
}
admin:write
) Parameters
as | string <uri> Save as |
name required | string <uri> Pack Name |
url required | string <uri> URL of the instance to download from |
{
}
"ok"
admin:write
) url required | string <uri> URL of the instance |
page | integer Default: 1 Page |
page_size | integer Default: 30 Number of emoji to return |
{- "count": 1,
- "packs": {
- "emojos": {
- "files": {
- "emacs": "emacs.png",
- "guix": "guix.png"
}, - "pack": {
- "can-download": true,
- "description": "Test description",
- "download-sha256": "57482F30674FD3DE821FF48C81C00DA4D4AF1F300209253684ABA7075E5FC238",
- "license": "Test license",
- "share-files": true
}
}
}
}
admin:write
) name required | string Example: name=cofe Pack Name |
"ok"
admin:write
) name required | string Example: name=cofe Pack Name |
Parameters
object Metadata to replace the old one |
{- "metadata": {
- "description": "string",
- "fallback-src-sha256": "string",
- "license": "string",
- "share-files": true
}
}
{- "description": "string",
- "fallback-src-sha256": "string",
- "license": "string",
- "share-files": true
}
admin:write
) name required | string Example: name=cofe Pack Name |
"ok"
[- {
- "installed": true,
- "installed_refs": [
- "string"
], - "name": "string",
- "ref": "string"
}
]
admin:read
) Parameters
build_dir | string |
build_url | string |
file | string |
name required | string |
ref | string |
{- "build_dir": "string",
- "build_url": "string",
- "file": "string",
- "name": "string",
- "ref": "string"
}
[- {
- "installed": true,
- "installed_refs": [
- "string"
], - "name": "string",
- "ref": "string"
}
]
admin:read
) admin_token | string Allows authorization via admin token. |
[- {
- "children": [
- {
- "description": "string",
- "key": "string",
- "suggestions": [ ],
- "type": "string"
}
], - "description": "string",
- "group": "string",
- "key": "string",
- "type": "string"
}
]
admin:read
) only_db | boolean Default: false Get only saved in database settings |
admin_token | string Allows authorization via admin token. |
{- "configs": [
- {
- "group": "string",
- "key": "string",
- "value": [ ]
}
], - "need_reboot": true
}
admin:write
) admin_token | string Allows authorization via admin token. |
Parameters
Array of objects |
{- "configs": [
- {
- "delete": true,
- "group": "string",
- "key": "string",
- "subkeys": [
- "string"
], - "value": [ ]
}
]
}
{- "configs": [
- {
- "group": "string",
- "key": "string",
- "value": [ ]
}
], - "need_reboot": true
}
admin:write
) name required | string The document name |
admin_token | string Allows authorization via admin token. |
admin:read
) name required | string The document name |
admin_token | string Allows authorization via admin token. |
{- "error": "Something went wrong"
}
admin:write
) name required | string The document name |
admin_token | string Allows authorization via admin token. |
Parameters
file required | string <binary> The file to be uploaded, using multipart form data. |
{- "file": "string"
}
{ }
admin:write
) id required | string Rule ID |
Parameters
hint | string |
priority | integer |
text | string |
{- "hint": "string",
- "priority": 0,
- "text": "string"
}
{- "hint": "string",
- "id": "string",
- "priority": 0,
- "text": "string"
}
[- {
- "hint": "string",
- "id": "string",
- "priority": 0,
- "text": "string"
}
]
admin:write
) admin_token | string Allows authorization via admin token. |
Parameters
hint | string |
priority | integer |
text required | string |
{- "hint": "string",
- "priority": 0,
- "text": "string"
}
{- "hint": "string",
- "id": "string",
- "priority": 0,
- "text": "string"
}
admin:write:invites
) admin_token | string Allows authorization via admin token. |
Parameters
expires_at | string <date> |
max_use | integer |
{- "expires_at": "2020-04-20",
- "max_use": 0
}
{- "expires_at": null,
- "id": 123,
- "invite_type": "one_time",
- "max_use": null,
- "token": "kSQtDj_GNy2NZsL9AQDFIsHN5qdbguB6qRg3WHw6K1U=",
- "used": true,
- "uses": 0
}
admin:read:invites
) admin_token | string Allows authorization via admin token. |
{- "invites": [
- {
- "expires_at": null,
- "id": 123,
- "invite_type": "one_time",
- "max_use": null,
- "token": "kSQtDj_GNy2NZsL9AQDFIsHN5qdbguB6qRg3WHw6K1U=",
- "used": true,
- "uses": 0
}
]
}
admin:write:invites
) admin_token | string Allows authorization via admin token. |
Parameters
email required | string <email> |
name | string |
{- "email": "user@example.com",
- "name": "string"
}
""
admin:write:invites
) admin_token | string Allows authorization via admin token. |
Parameters
token required | string |
{- "token": "string"
}
{- "expires_at": null,
- "id": 123,
- "invite_type": "one_time",
- "max_use": null,
- "token": "kSQtDj_GNy2NZsL9AQDFIsHN5qdbguB6qRg3WHw6K1U=",
- "used": true,
- "uses": 0
}
admin:write:media_proxy_caches
) admin_token | string Allows authorization via admin token. |
Parameters
urls required | Array of strings <uri> |
{
}
{ }
admin:read:media_proxy_caches
) query | string Page |
page | integer Default: 1 Page |
page_size | integer Default: 50 Number of statuses to return |
admin_token | string Allows authorization via admin token. |
{- "count": 0,
- "page_size": 0,
}
admin:write:media_proxy_caches
) admin_token | string Allows authorization via admin token. |
Parameters
ban | boolean Default: true |
urls required | Array of strings <uri> |
{- "ban": true,
}
{ }
admin:write
) name | string App name |
client_id | string Client ID |
page | integer Default: 1 Page |
trusted | boolean Default: false Trusted apps |
page_size | integer Default: 50 Number of apps to return |
admin_token | string Allows authorization via admin token. |
{- "apps": [
- {
- "client_id": "yHoDSiWYp5mPV6AfsaVOWjdOyt5PhWRiafi6MRd1lSk",
- "client_secret": "nLmis486Vqrv2o65eM9mLQx_m_4gH-Q6PcDpGIMl6FY",
- "id": 1,
- "name": "App name",
- "trusted": true,
}
], - "count": 1,
- "page_size": 50
}
admin:write
) admin_token | string Allows authorization via admin token. |
Parameters
name required | string Application Name |
redirect_uris required | string Where the user should be redirected after authorization. To display the authorization code to the user instead of redirecting to a web page, use |
scopes | Array of strings oAuth scopes |
trusted | boolean Nullable Default: false Is the app trusted? |
website | string Nullable A URL to the homepage of the app |
{- "name": "My App",
- "scopes": [
- "read",
- "write"
], - "trusted": true,
}
{- "client_id": "TWhM-tNSuncnqN7DBJmoyeLnk6K3iJJ71KKXxgL1hPM",
- "client_secret": "ZEaFUFmF0umgBX1qKJDjaU99Q31lDkOU8NutzTOoliw",
- "id": 123,
- "name": "My App",
- "trusted": false,
}
admin:write
) id required | integer Example: 1337 App ID |
admin_token | string Allows authorization via admin token. |
""
admin:write
) id required | integer Example: 1337 App ID |
admin_token | string Allows authorization via admin token. |
Parameters
name | string Application Name |
redirect_uris | string Where the user should be redirected after authorization. To display the authorization code to the user instead of redirecting to a web page, use |
scopes | Array of strings oAuth scopes |
trusted | boolean Nullable Default: false Is the app trusted? |
website | string Nullable A URL to the homepage of the app |
{- "name": "My App",
- "scopes": [
- "read",
- "write"
], - "trusted": true,
}
{- "client_id": "TWhM-tNSuncnqN7DBJmoyeLnk6K3iJJ71KKXxgL1hPM",
- "client_secret": "ZEaFUFmF0umgBX1qKJDjaU99Q31lDkOU8NutzTOoliw",
- "id": 123,
- "name": "My App",
- "trusted": false,
}
admin:write:follows
) admin_token | string Allows authorization via admin token. |
Parameters
force | boolean Default: false |
relay_url | string <uri> |
{- "force": false,
}
admin:read
) admin_token | string Allows authorization via admin token. |
{
}
admin:write:follows
) admin_token | string Allows authorization via admin token. |
Parameters
relay_url | string <uri> |
{
}
{- "followed_back": true
}
admin:read:reports
) state | string Enum: "open" "closed" "resolved" Filter by report state |
rule_id | string Filter by selected rule id |
limit | integer The number of records to retrieve |
page | integer Default: 1 Page number |
page_size | integer Default: 50 Number number of log entries per page |
admin_token | string Allows authorization via admin token. |
{- "reports": [
- {
- "account": {
- "acct": "string",
- "bot": true,
- "created_at": "2019-08-24T14:15:22Z",
- "display_name": "string",
- "emojis": [
- {
- "shortcode": "fatyoshi",
- "visible_in_picker": true
}
], - "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 0,
- "id": "string",
- "is_active": true,
- "is_confirmed": true,
- "local": true,
- "locked": true,
- "mute_expires_at": "2019-08-24T14:15:22Z",
- "nickname": "string",
- "note": "string",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "also_known_as": [
- "string"
], - "ap_id": "string",
- "avatar_description": "string",
- "birthday": "2019-08-24",
- "chat_token": "string",
- "header_description": "string",
- "hide_favorites": true,
- "hide_followers": true,
- "hide_followers_count": true,
- "hide_follows": true,
- "hide_follows_count": true,
- "is_admin": true,
- "is_confirmed": true,
- "is_moderator": true,
- "notification_settings": {
- "block_from_strangers": true,
- "hide_notification_contents": true
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": { },
- "show_birthday": true,
- "skip_thread_containment": true,
- "tags": [
- "string"
], - "unread_conversation_count": 0
}, - "roles": {
- "admin": true,
- "moderator": true
}, - "source": {
- "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "note": "string",
- "pleroma": {
- "actor_type": "Application",
- "discoverable": true,
- "no_rich_text": true,
- "show_role": true
}, - "privacy": "public",
- "sensitive": true
}, - "statuses_count": 0,
- "username": "string"
}, - "actor": {
- "acct": "string",
- "bot": true,
- "created_at": "2019-08-24T14:15:22Z",
- "display_name": "string",
- "emojis": [
- {
- "shortcode": "fatyoshi",
- "visible_in_picker": true
}
], - "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 0,
- "id": "string",
- "is_active": true,
- "is_confirmed": true,
- "local": true,
- "locked": true,
- "mute_expires_at": "2019-08-24T14:15:22Z",
- "nickname": "string",
- "note": "string",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "also_known_as": [
- "string"
], - "ap_id": "string",
- "avatar_description": "string",
- "birthday": "2019-08-24",
- "chat_token": "string",
- "header_description": "string",
- "hide_favorites": true,
- "hide_followers": true,
- "hide_followers_count": true,
- "hide_follows": true,
- "hide_follows_count": true,
- "is_admin": true,
- "is_confirmed": true,
- "is_moderator": true,
- "notification_settings": {
- "block_from_strangers": true,
- "hide_notification_contents": true
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": { },
- "show_birthday": true,
- "skip_thread_containment": true,
- "tags": [
- "string"
], - "unread_conversation_count": 0
}, - "roles": {
- "admin": true,
- "moderator": true
}, - "source": {
- "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "note": "string",
- "pleroma": {
- "actor_type": "Application",
- "discoverable": true,
- "no_rich_text": true,
- "show_role": true
}, - "privacy": "public",
- "sensitive": true
}, - "statuses_count": 0,
- "username": "string"
}, - "content": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "notes": [
- {
- "content": "string",
- "id": 0,
- "inserted_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}
], - "rules": [
- {
- "hint": "string",
- "id": "string",
- "text": "string"
}
], - "state": "open",
- "statuses": [
- {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
]
}
], - "total": 0
}
admin:write:reports
) admin_token | string Allows authorization via admin token. |
Parameters
required | Array of objects |
{- "reports": {
- "reports": [
- {
- "id": "123",
- "state": "closed"
}, - {
- "id": "1337",
- "state": "resolved"
}
]
}
}
""
admin:read:reports
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Report ID |
admin_token | string Allows authorization via admin token. |
{- "account": {
- "acct": "string",
- "bot": true,
- "created_at": "2019-08-24T14:15:22Z",
- "display_name": "string",
- "emojis": [
- {
- "shortcode": "fatyoshi",
- "visible_in_picker": true
}
], - "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 0,
- "id": "string",
- "is_active": true,
- "is_confirmed": true,
- "local": true,
- "locked": true,
- "mute_expires_at": "2019-08-24T14:15:22Z",
- "nickname": "string",
- "note": "string",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "also_known_as": [
- "string"
], - "ap_id": "string",
- "avatar_description": "string",
- "birthday": "2019-08-24",
- "chat_token": "string",
- "header_description": "string",
- "hide_favorites": true,
- "hide_followers": true,
- "hide_followers_count": true,
- "hide_follows": true,
- "hide_follows_count": true,
- "is_admin": true,
- "is_confirmed": true,
- "is_moderator": true,
- "notification_settings": {
- "block_from_strangers": true,
- "hide_notification_contents": true
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": { },
- "show_birthday": true,
- "skip_thread_containment": true,
- "tags": [
- "string"
], - "unread_conversation_count": 0
}, - "roles": {
- "admin": true,
- "moderator": true
}, - "source": {
- "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "note": "string",
- "pleroma": {
- "actor_type": "Application",
- "discoverable": true,
- "no_rich_text": true,
- "show_role": true
}, - "privacy": "public",
- "sensitive": true
}, - "statuses_count": 0,
- "username": "string"
}, - "actor": {
- "acct": "string",
- "bot": true,
- "created_at": "2019-08-24T14:15:22Z",
- "display_name": "string",
- "emojis": [
- {
- "shortcode": "fatyoshi",
- "visible_in_picker": true
}
], - "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 0,
- "id": "string",
- "is_active": true,
- "is_confirmed": true,
- "local": true,
- "locked": true,
- "mute_expires_at": "2019-08-24T14:15:22Z",
- "nickname": "string",
- "note": "string",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "also_known_as": [
- "string"
], - "ap_id": "string",
- "avatar_description": "string",
- "birthday": "2019-08-24",
- "chat_token": "string",
- "header_description": "string",
- "hide_favorites": true,
- "hide_followers": true,
- "hide_followers_count": true,
- "hide_follows": true,
- "hide_follows_count": true,
- "is_admin": true,
- "is_confirmed": true,
- "is_moderator": true,
- "notification_settings": {
- "block_from_strangers": true,
- "hide_notification_contents": true
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": { },
- "show_birthday": true,
- "skip_thread_containment": true,
- "tags": [
- "string"
], - "unread_conversation_count": 0
}, - "roles": {
- "admin": true,
- "moderator": true
}, - "source": {
- "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "note": "string",
- "pleroma": {
- "actor_type": "Application",
- "discoverable": true,
- "no_rich_text": true,
- "show_role": true
}, - "privacy": "public",
- "sensitive": true
}, - "statuses_count": 0,
- "username": "string"
}, - "content": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "notes": [
- {
- "content": "string",
- "id": 0,
- "inserted_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}
], - "rules": [
- {
- "hint": "string",
- "id": "string",
- "text": "string"
}
], - "state": "open",
- "statuses": [
- {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
]
}
admin:write:reports
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Report ID |
admin_token | string Allows authorization via admin token. |
Parameters
content | string The message |
{- "content": "string"
}
""
admin:write:reports
) report_id required | string Report ID |
id required | string Note ID |
admin_token | string Allows authorization via admin token. |
""
admin:read:statuses
) godmode | boolean Default: false Allows to see private statuses |
local_only | boolean Default: false Excludes remote statuses |
with_reblogs | boolean Default: false Allows to see reblogs |
page | integer Default: 1 Page |
page_size | integer Default: 50 Number of statuses to return |
admin_token | string Allows authorization via admin token. |
[- {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
]
admin:write:statuses
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
admin_token | string Allows authorization via admin token. |
{ }
admin:read:statuses
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
admin_token | string Allows authorization via admin token. |
{- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
admin:write:statuses
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
admin_token | string Allows authorization via admin token. |
Parameters
sensitive | boolean Mark status and attached media as sensitive? |
visibility | string (VisibilityScope) Enum: "public" "unlisted" "local" "private" "direct" "list" Status visibility |
{- "sensitive": "false",
- "visibility": "private"
}
{- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
admin:write:accounts
) admin_token | string Allows authorization via admin token. |
Parameters
nicknames | Array of strings |
{- "nicknames": [
- "string"
]
}
{- "user": [
- {
- "actor_type": "string",
- "display_name": "string",
- "email": "user@example.com",
- "id": "string",
- "is_active": true,
- "is_approved": true,
- "is_confirmed": true,
- "local": true,
- "nickname": "string",
- "registration_reason": "string",
- "roles": {
- "admin": true,
- "moderator": true
}, - "tags": [
- "string"
],
}
]
}
admin:write:follows
) admin_token | string Allows authorization via admin token. |
Parameters
followed | string Followed nickname |
follower | string Follower nickname |
{- "followed": "string",
- "follower": "string"
}
"string"
admin:write:accounts
) nickname required | string User nickname |
admin_token | string Allows authorization via admin token. |
{- "actor_type": "string",
- "display_name": "string",
- "email": "user@example.com",
- "id": "string",
- "is_active": true,
- "is_approved": true,
- "is_confirmed": true,
- "local": true,
- "nickname": "string",
- "registration_reason": "string",
- "roles": {
- "admin": true,
- "moderator": true
}, - "tags": [
- "string"
],
}
admin:write:accounts
) admin_token | string Allows authorization via admin token. |
Parameters
nicknames | Array of strings |
{- "nicknames": [
- "string"
]
}
{- "user": [
- {
- "actor_type": "string",
- "display_name": "string",
- "email": "user@example.com",
- "id": "string",
- "is_active": true,
- "is_approved": true,
- "is_confirmed": true,
- "local": true,
- "nickname": "string",
- "registration_reason": "string",
- "roles": {
- "admin": true,
- "moderator": true
}, - "tags": [
- "string"
],
}
]
}
admin:write:accounts
) admin_token | string Allows authorization via admin token. |
Parameters
nicknames | Array of strings |
{- "nicknames": [
- "string"
]
}
{- "user": [
- {
- "actor_type": "string",
- "display_name": "string",
- "email": "user@example.com",
- "id": "string",
- "is_active": true,
- "is_approved": true,
- "is_confirmed": true,
- "local": true,
- "nickname": "string",
- "registration_reason": "string",
- "roles": {
- "admin": true,
- "moderator": true
}, - "tags": [
- "string"
],
}
]
}
admin:write:accounts
) admin_token | string Allows authorization via admin token. |
Parameters
nicknames | Array of strings |
{- "nicknames": [
- "string"
]
}
{- "user": [
- {
- "actor_type": "string",
- "display_name": "string",
- "email": "user@example.com",
- "id": "string",
- "is_active": true,
- "is_approved": true,
- "is_confirmed": true,
- "local": true,
- "nickname": "string",
- "registration_reason": "string",
- "roles": {
- "admin": true,
- "moderator": true
}, - "tags": [
- "string"
],
}
]
}
admin:write:accounts
) nickname | string User nickname |
admin_token | string Allows authorization via admin token. |
Parameters
nicknames | Array of strings |
{- "nicknames": [
- "string"
]
}
[- "string"
]
admin:read:accounts
) filters | string Comma separated list of filters |
query | string Search users query |
name | string Search by display name |
string Search by email | |
page | integer Page Number |
page_size | integer Number of users to return per page |
actor_types | Array of strings (ActorType) Items Enum: "Application" "Group" "Organization" "Person" "Service" Filter by actor type |
tags | Array of strings Filter by tags |
admin_token | string Allows authorization via admin token. |
{- "count": 0,
- "page_size": 0,
- "users": [
- {
- "actor_type": "string",
- "display_name": "string",
- "email": "user@example.com",
- "id": "string",
- "is_active": true,
- "is_approved": true,
- "is_confirmed": true,
- "local": true,
- "nickname": "string",
- "registration_reason": "string",
- "roles": {
- "admin": true,
- "moderator": true
}, - "tags": [
- "string"
],
}
]
}
admin:write:accounts
) admin_token | string Allows authorization via admin token. |
Parameters
Array of objects |
{- "users": [
- {
- "email": "string",
- "nickname": "string",
- "password": "string"
}
]
}
[- {
- "code": 0,
- "data": {
- "email": "user@example.com",
- "nickname": "string"
}, - "type": "string"
}
]
admin:read:accounts
) nickname required | string User nickname or ID |
admin_token | string Allows authorization via admin token. |
{- "actor_type": "string",
- "display_name": "string",
- "email": "user@example.com",
- "id": "string",
- "is_active": true,
- "is_approved": true,
- "is_confirmed": true,
- "local": true,
- "nickname": "string",
- "registration_reason": "string",
- "roles": {
- "admin": true,
- "moderator": true
}, - "tags": [
- "string"
],
}
admin:write:accounts
) admin_token | string Allows authorization via admin token. |
Parameters
nicknames | Array of strings |
{- "nicknames": [
- "string"
]
}
{- "user": [
- {
- "actor_type": "string",
- "display_name": "string",
- "email": "user@example.com",
- "id": "string",
- "is_active": true,
- "is_approved": true,
- "is_confirmed": true,
- "local": true,
- "nickname": "string",
- "registration_reason": "string",
- "roles": {
- "admin": true,
- "moderator": true
}, - "tags": [
- "string"
],
}
]
}
admin:write:follows
) admin_token | string Allows authorization via admin token. |
Parameters
followed | string Followed nickname |
follower | string Follower nickname |
{- "followed": "string",
- "follower": "string"
}
"string"
admin:write
) id required | string announcement id |
admin_token | string Allows authorization via admin token. |
{ }
admin:read
) id required | string announcement id |
admin_token | string Allows authorization via admin token. |
{- "all_day": true,
- "content": "string",
- "emojis": [ ],
- "ends_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "mentions": [ ],
- "pleroma": {
- "raw_content": "string"
}, - "published_at": "2019-08-24T14:15:22Z",
- "reactions": [ ],
- "read": true,
- "starts_at": "2019-08-24T14:15:22Z",
- "statuses": [ ],
- "tags": [ ],
- "updated_at": "2019-08-24T14:15:22Z"
}
admin:write
) id required | string announcement id |
admin_token | string Allows authorization via admin token. |
Parameters
all_day | boolean |
content | string |
ends_at | string <date-time> Nullable |
starts_at | string <date-time> Nullable |
{- "all_day": true,
- "content": "string",
- "ends_at": "2019-08-24T14:15:22Z",
- "starts_at": "2019-08-24T14:15:22Z"
}
{- "all_day": true,
- "content": "string",
- "emojis": [ ],
- "ends_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "mentions": [ ],
- "pleroma": {
- "raw_content": "string"
}, - "published_at": "2019-08-24T14:15:22Z",
- "reactions": [ ],
- "read": true,
- "starts_at": "2019-08-24T14:15:22Z",
- "statuses": [ ],
- "tags": [ ],
- "updated_at": "2019-08-24T14:15:22Z"
}
admin:read
) limit | integer >= 1 the maximum number of announcements to return |
offset | integer >= 0 the offset of the first announcement to return |
admin_token | string Allows authorization via admin token. |
[- {
- "all_day": true,
- "content": "string",
- "emojis": [ ],
- "ends_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "mentions": [ ],
- "pleroma": {
- "raw_content": "string"
}, - "published_at": "2019-08-24T14:15:22Z",
- "reactions": [ ],
- "read": true,
- "starts_at": "2019-08-24T14:15:22Z",
- "statuses": [ ],
- "tags": [ ],
- "updated_at": "2019-08-24T14:15:22Z"
}
]
admin:write
) Parameters
all_day | boolean |
content required | string |
ends_at | string <date-time> Nullable |
starts_at | string <date-time> Nullable |
{- "all_day": true,
- "content": "string",
- "ends_at": "2019-08-24T14:15:22Z",
- "starts_at": "2019-08-24T14:15:22Z"
}
{- "all_day": true,
- "content": "string",
- "emojis": [ ],
- "ends_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "mentions": [ ],
- "pleroma": {
- "raw_content": "string"
}, - "published_at": "2019-08-24T14:15:22Z",
- "reactions": [ ],
- "read": true,
- "starts_at": "2019-08-24T14:15:22Z",
- "statuses": [ ],
- "tags": [ ],
- "updated_at": "2019-08-24T14:15:22Z"
}
[- {
- "client_id": "TWhM-tNSuncnqN7DBJmoyeLnk6K3iJJ71KKXxgL1hPM",
- "client_secret": "ZEaFUFmF0umgBX1qKJDjaU99Q31lDkOU8NutzTOoliw",
- "id": "123",
- "name": "My App",
- "vapid_key": "BCk-QqERU0q-CfYZjcuB6lnyyOYfJ2AifKqfeGIm7Z-HiTU5T9eTG5GxVA0_OH5mMlI4UkkDTpaZwozy0TzdZ2M=",
}
]
Create a new application to obtain OAuth2 credentials
Parameters
client_name required | string A name for your application. |
redirect_uris required | string Where the user should be redirected after authorization. To display the authorization code to the user instead of redirecting to a web page, use |
scopes | string Default: "read" Space separated list of scopes |
website | string Nullable A URL to the homepage of your app |
{- "client_name": "My App",
}
{- "client_id": "TWhM-tNSuncnqN7DBJmoyeLnk6K3iJJ71KKXxgL1hPM",
- "client_secret": "ZEaFUFmF0umgBX1qKJDjaU99Q31lDkOU8NutzTOoliw",
- "id": "123",
- "name": "My App",
- "vapid_key": "BCk-QqERU0q-CfYZjcuB6lnyyOYfJ2AifKqfeGIm7Z-HiTU5T9eTG5GxVA0_OH5mMlI4UkkDTpaZwozy0TzdZ2M=",
}
Confirm that the app's OAuth2 credentials work.
read
) {- "name": "My App",
- "vapid_key": "BCk-QqERU0q-CfYZjcuB6lnyyOYfJ2AifKqfeGIm7Z-HiTU5T9eTG5GxVA0_OH5mMlI4UkkDTpaZwozy0TzdZ2M=",
}
Removes the current Web Push API subscription.
push
) { }
View the PushSubscription currently associated with this access token.
push
) {- "alerts": {
- "favourite": true,
- "follow": true,
- "mention": true,
- "poll": true,
- "reblog": true
}, - "id": "328_183",
- "server_key": "BCk-QqERU0q-CfYZjcuB6lnyyOYfJ2AifKqfeGIm7Z-HiTU5T9eTG5GxVA0_OH5mMlI4UkkDTpaZwozy0TzdZ2M="
}
Add a Web Push API subscription to receive notifications. Each access token can have one push subscription. If you create a new subscription, the old subscription is deleted.
push
) Parameters
object Nullable | |
required | object |
{- "data": {
- "alerts": {
- "follow": true,
- "mention": true,
- "poll": false
}
}, - "subscription": {
- "keys": {
- "auth": "8eDyX_uCN0XRhSbY5hs7Hg==",
- "p256dh": "BCIWgsnyXDv1VkhqL2P7YRBvdeuDnlwAPT2guNhdIoW3IP7GmHh1SMKPLxRf7x8vJy6ZFK3ol2ohgn_-0yP7QQA="
}
}
}
{- "alerts": {
- "favourite": true,
- "follow": true,
- "mention": true,
- "poll": true,
- "reblog": true
}, - "id": "328_183",
- "server_key": "BCk-QqERU0q-CfYZjcuB6lnyyOYfJ2AifKqfeGIm7Z-HiTU5T9eTG5GxVA0_OH5mMlI4UkkDTpaZwozy0TzdZ2M="
}
Updates the current push subscription. Only the data part can be updated. To change fundamentals, a new subscription must be created instead.
push
) Parameters
object Nullable |
{- "data": {
- "alerts": {
- "favourite": true,
- "follow": true,
- "mention": true,
- "poll": true,
- "reblog": true
}
}
}
{- "alerts": {
- "favourite": true,
- "follow": true,
- "mention": true,
- "poll": true,
- "reblog": true
}, - "id": "328_183",
- "server_key": "BCk-QqERU0q-CfYZjcuB6lnyyOYfJ2AifKqfeGIm7Z-HiTU5T9eTG5GxVA0_OH5mMlI4UkkDTpaZwozy0TzdZ2M="
}
write:accounts
) Parameters
email required | string New email. Set to blank to remove the user's email. |
password required | string Current password |
{- "email": "string",
- "password": "string"
}
{- "status": "success"
}
Test to make sure that the user token works.
read:accounts
) {- "acct": "string",
- "bot": true,
- "created_at": "2019-08-24T14:15:22Z",
- "display_name": "string",
- "emojis": [
- {
- "shortcode": "fatyoshi",
- "visible_in_picker": true
}
], - "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 0,
- "id": "string",
- "is_active": true,
- "is_confirmed": true,
- "local": true,
- "locked": true,
- "mute_expires_at": "2019-08-24T14:15:22Z",
- "nickname": "string",
- "note": "string",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "also_known_as": [
- "string"
], - "ap_id": "string",
- "avatar_description": "string",
- "birthday": "2019-08-24",
- "chat_token": "string",
- "header_description": "string",
- "hide_favorites": true,
- "hide_followers": true,
- "hide_followers_count": true,
- "hide_follows": true,
- "hide_follows_count": true,
- "is_admin": true,
- "is_confirmed": true,
- "is_moderator": true,
- "notification_settings": {
- "block_from_strangers": true,
- "hide_notification_contents": true
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": { },
- "show_birthday": true,
- "skip_thread_containment": true,
- "tags": [
- "string"
], - "unread_conversation_count": 0
}, - "roles": {
- "admin": true,
- "moderator": true
}, - "source": {
- "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "note": "string",
- "pleroma": {
- "actor_type": "Application",
- "discoverable": true,
- "no_rich_text": true,
- "show_role": true
}, - "privacy": "public",
- "sensitive": true
}, - "statuses_count": 0,
- "username": "string"
}
write:accounts
) Parameters
password required | string Current password |
target_account required | string The nickname of the target account to move to |
{- "password": "string",
- "target_account": "string"
}
{- "status": "success"
}
write:accounts
) Parameters
alias required | string The nickname of the account to delete from aliases |
{- "alias": "string"
}
{- "status": "success"
}
{- "aliases": [
- "foo@example.org"
]
}
write:accounts
) Parameters
alias required | string The nickname of the account to add to aliases |
{- "alias": "string"
}
{- "status": "success"
}
Update the user's display and preferences.
write:accounts
) Parameters
boolean or string or integer Nullable Whether the user accepts receiving chat messages. | |
actor_type | string (ActorType) Enum: "Application" "Group" "Organization" "Person" "Service" |
boolean or string or integer Nullable Allows automatically follow moved following accounts | |
also_known_as | Array of strings Nullable List of alternate ActivityPub IDs |
avatar | string <binary> Nullable Avatar image encoded using multipart/form-data |
avatar_description | string Nullable Avatar image description. |
string or string Nullable User's birthday | |
boolean or string or integer Nullable Whether the account has a bot flag. | |
default_scope | string (VisibilityScope) Enum: "public" "unlisted" "local" "private" "direct" "list" Status visibility |
boolean or string or integer Nullable Discovery (listing, indexing) of this account by external services (search bots etc.) is allowed. | |
display_name | string Nullable The display name to use for the profile. |
Array of AccountAttributeField (objects) or object Nullable | |
header | string <binary> Nullable Header image encoded using multipart/form-data |
header_description | string Nullable Header image description. |
boolean or string or integer Nullable user's favorites timeline will be hidden | |
boolean or string or integer Nullable user's followers will be hidden | |
boolean or string or integer Nullable user's follower count will be hidden | |
boolean or string or integer Nullable user's follows will be hidden | |
boolean or string or integer Nullable user's follow count will be hidden | |
boolean or string or integer Nullable Whether manual approval of follow requests is required. | |
boolean or string or integer Nullable html tags are stripped from all statuses requested from the API | |
note | string The account bio. |
pleroma_background_image | string <binary> Nullable Sets the background image of the user. |
pleroma_settings_store | object Nullable Opaque user settings to be saved on the backend. |
boolean or string or integer Nullable User's birthday will be visible | |
boolean or string or integer Nullable user's role (e.g admin, moderator) will be exposed to anyone in the API | |
boolean or string or integer Nullable Skip filtering out broken threads |
{- "actor_type": "Person",
- "allow_following_move": false,
- "birthday": "2001-02-12",
- "bot": false,
- "default_scope": "private",
- "discoverable": false,
- "display_name": "cofe",
- "fields_attributes": [
- {
- "name": "foo",
- "value": "bar"
}
], - "hide_favorites": false,
- "hide_followers": true,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "no_rich_text": false,
- "note": "foobar",
- "pleroma_settings_store": {
- "pleroma-fe": {
- "key": "val"
}
}, - "show_birthday": false,
- "show_role": false,
- "skip_thread_containment": false
}
{- "acct": "string",
- "bot": true,
- "created_at": "2019-08-24T14:15:22Z",
- "display_name": "string",
- "emojis": [
- {
- "shortcode": "fatyoshi",
- "visible_in_picker": true
}
], - "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 0,
- "id": "string",
- "is_active": true,
- "is_confirmed": true,
- "local": true,
- "locked": true,
- "mute_expires_at": "2019-08-24T14:15:22Z",
- "nickname": "string",
- "note": "string",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "also_known_as": [
- "string"
], - "ap_id": "string",
- "avatar_description": "string",
- "birthday": "2019-08-24",
- "chat_token": "string",
- "header_description": "string",
- "hide_favorites": true,
- "hide_followers": true,
- "hide_followers_count": true,
- "hide_follows": true,
- "hide_follows_count": true,
- "is_admin": true,
- "is_confirmed": true,
- "is_moderator": true,
- "notification_settings": {
- "block_from_strangers": true,
- "hide_notification_contents": true
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": { },
- "show_birthday": true,
- "skip_thread_containment": true,
- "tags": [
- "string"
], - "unread_conversation_count": 0
}, - "roles": {
- "admin": true,
- "moderator": true
}, - "source": {
- "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "note": "string",
- "pleroma": {
- "actor_type": "Application",
- "discoverable": true,
- "no_rich_text": true,
- "show_role": true
}, - "privacy": "public",
- "sensitive": true
}, - "statuses_count": 0,
- "username": "string"
}
write:accounts
) password | string Password |
{- "status": "success"
}
Creates a user and account records. Returns an account access token for the app that initiated the request. The app should save this token for later, and should wait for the user to confirm their account by clicking a link in their email inbox.
Parameters
required | boolean or string or integer Whether the user agrees to the local rules, terms, and policies. These should be presented to the user in order to allow them to consent before setting this parameter to TRUE. |
bio | string Nullable Default: "" Bio |
string or string Nullable User's birthday | |
captcha_answer_data | string Nullable Provider-specific captcha data |
captcha_solution | string Nullable Provider-specific captcha solution |
captcha_token | string Nullable Provider-specific captcha token |
string <email> Nullable The email address to be used for login. Required when | |
fullname | string Nullable Full name |
language | string Nullable User's preferred language for emails |
locale | string Nullable The language of the confirmation email that will be sent |
password required | string <password> The password to be used for login |
reason | string Nullable Text that will be reviewed by moderators if registrations require manual approval |
token | string Nullable Invite token required when the registrations aren't public |
username required | string The desired username for the account |
{- "agreement": "true",
- "bio": "☕️",
- "email": "cofe@example.com",
- "password": "secret",
- "username": "cofe"
}
{- "access_token": "i9hAVVzGld86Pl5JtLtizKoXVvtTlSCJvwaugCxvZzk",
- "created_at": 1585918714,
- "expires_in": 600,
- "refresh_token": "i9hAVVzGld86Pl5JtLtizKoXVvtTlSCJvwaugCxvZzz",
- "scope": "read write follow push",
- "token_type": "Bearer"
}
write:accounts
) password | string Password |
Parameters
password | string <password> The user's own password for confirmation. |
{- "password": "prettyp0ony1313"
}
{- "status": "success"
}
write:accounts
) Parameters
new_password required | string New password |
new_password_confirmation required | string New password, confirmation |
password required | string Current password |
{- "new_password": "string",
- "new_password_confirmation": "string",
- "password": "string"
}
{- "status": "success"
}
[- {
- "content_type": "application/zip",
- "file_size": 4105,
- "inserted_at": "2020-09-08T16:42:07.000Z",
- "processed": true,
- "tempdir": "/tmp/PZIMw40vmpM"
}
]
[- {
- "content_type": "application/zip",
- "file_size": 4105,
- "inserted_at": "2020-09-08T16:42:07.000Z",
- "processed": true,
- "tempdir": "/tmp/PZIMw40vmpM"
}
]
Accounts the user has muted.
follow
read:mutes
) boolean or string or integer (BooleanLike) Embed relationships into accounts. If this parameter is not set account's | |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
]
View your blocks. See also accounts/:id/{block,unblock}
read:blocks
) boolean or string or integer (BooleanLike) Embed relationships into accounts. If this parameter is not set account's | |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
]
write:follow
) Parameters
required | string or string STRING or FILE containing a whitespace-separated list of accounts to import. |
{- "list": "string"
}
"ok"
write:mutes
) Parameters
required | string or string STRING or FILE containing a whitespace-separated list of accounts to import. |
{- "list": "string"
}
"ok"
write:blocks
) Parameters
required | string or string STRING or FILE containing a whitespace-separated list of accounts to import. |
{- "list": "string"
}
"ok"
Remove a domain block, if it exists in the user's array of blocked domains.
follow
write:blocks
) domain | string Domain name |
Parameters
domain | string |
{- "domain": "facebook.com"
}
{ }
[- "google.com",
- "facebook.com"
]
Block a domain to:
follow
write:blocks
) domain | string Domain name |
Parameters
domain | string |
{- "domain": "facebook.com"
}
{ }
follow
write:follows
) id required | string Example: 123 Conversation ID |
{- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}
[- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
]
{- "id": "abcdefg",
- "pleroma": {
- "mime_type": "image/png"
}, - "type": "image",
}
Behaves exactly the same as POST /api/v1/upload
. Can only accept images - any attempt to upload non-image files will be met with HTTP 415 Unsupported Media Type
.
write:accounts
) Parameters
file | string <binary> |
{- "file": "string"
}
{- "id": "abcdefg",
- "pleroma": {
- "mime_type": "image/png"
}, - "type": "image",
}
read:statuses
) timeline | Array of strings Items Enum: "home" "notifications" Array of markers to fetch. If not provided, an empty object will be returned. |
{- "home": {
- "last_read_id": "103206604258487607",
- "pleroma": {
- "unread_count": 10
}, - "updated_at": "2019-11-26T22:37:25.235Z",
- "version": 468
}, - "notifications": {
- "last_read_id": "35098814",
- "pleroma": {
- "unread_count": 0
}, - "updated_at": "2019-11-26T22:37:25.239Z",
- "version": 361
}
}
follow
write:blocks
) Parameters
object Nullable | |
object Nullable |
{- "home": {
- "last_read_id": "103194548672408537",
- "updated_at": "2019-11-24T19:39:39.337Z",
- "version": 462
}
}
{- "home": {
- "last_read_id": "103206604258487607",
- "pleroma": {
- "unread_count": 10
}, - "updated_at": "2019-11-26T22:37:25.235Z",
- "version": 468
}, - "notifications": {
- "last_read_id": "35098814",
- "pleroma": {
- "unread_count": 0
}, - "updated_at": "2019-11-26T22:37:25.239Z",
- "version": 361
}
}
View information about a notification with a given ID.
read:notifications
) id required | string Example: 123 Notification ID |
{- "account": {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}, - "created_at": "2019-11-23T07:49:02.064Z",
- "group-key": "ungrouped-34975861",
- "id": "34975861",
- "pleroma": {
- "is_muted": false,
- "is_seen": false
}, - "status": {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}, - "type": "mention"
}
Clear a single notification from the server.
write:notifications
) Parameters
id | string |
{- "id": "string"
}
{ }
Clear all notifications from the server.
write:notifications
) { }
Notifications concerning the user. This API returns Link headers containing links to the next/previous page. However, the links can also be constructed dynamically using query params and id
values.
read:notifications
) exclude_types | Array of strings Items Enum: "follow" "favourite" "reblog" "mention" "pleroma:emoji_reaction" "pleroma:chat_mention" "pleroma:report" "move" "follow_request" "poll" "status" "update" "admin.sign_up" "admin.report" Array of types to exclude |
account_id | string Return only notifications received from this account |
exclude_visibilities | Array of strings (VisibilityScope) Items Enum: "public" "unlisted" "local" "private" "direct" "list" Exclude the notifications for activities with the given visibilities |
include_types | Array of strings Items Enum: "follow" "favourite" "reblog" "mention" "pleroma:emoji_reaction" "pleroma:chat_mention" "pleroma:report" "move" "follow_request" "poll" "status" "update" "admin.sign_up" "admin.report" Deprecated, use |
types | Array of strings Items Enum: "follow" "favourite" "reblog" "mention" "pleroma:emoji_reaction" "pleroma:chat_mention" "pleroma:report" "move" "follow_request" "poll" "status" "update" "admin.sign_up" "admin.report" Include the notifications for activities with the given types |
boolean or string or integer (BooleanLike) Include the notifications from muted users | |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "account": {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}, - "created_at": "2019-11-23T07:49:02.064Z",
- "group-key": "ungrouped-34975861",
- "id": "34975861",
- "pleroma": {
- "is_muted": false,
- "is_seen": false
}, - "status": {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}, - "type": "mention"
}
]
Query parameters are mutually exclusive.
write:notifications
) Parameters
id | integer A single notification ID to read |
max_id | integer Read all notifications up to this ID |
{- "id": 0,
- "max_id": 0
}
"string"
Clear a single notification from the server.
write:notifications
) id required | string Example: 123 Notification ID |
{ }
write:notifications
) ids required | Array of strings Array of notification IDs to dismiss |
{ }
write:filters
) id required | string Example: 123 Filter ID |
{ }
read:filters
) id required | string Example: 123 Filter ID |
{- "context": [
- "home",
- "notifications",
- "public",
- "thread"
], - "expires_at": null,
- "id": "5580",
- "irreversible": true,
- "phrase": "@twitter.com",
- "whole_word": false
}
write:filters
) id required | string Example: 123 Filter ID |
Parameters
context required | Array of strings Items Enum: "home" "notifications" "public" "thread" Array of enumerable strings |
expires_in | integer Nullable Number of seconds from now the filter should expire. Otherwise, null for a filter that doesn't expire. |
boolean or string or integer Nullable Should the server irreversibly drop matching entities from home and notifications? | |
phrase required | string The text to be filtered |
boolean or string or integer Nullable Default: true Consider word boundaries? |
{- "context": [
- "home"
], - "phrase": "knights"
}
{- "context": [
- "home",
- "notifications",
- "public",
- "thread"
], - "expires_at": null,
- "id": "5580",
- "irreversible": true,
- "phrase": "@twitter.com",
- "whole_word": false
}
[- {
- "context": [
- "home",
- "notifications",
- "public",
- "thread"
], - "expires_at": null,
- "id": "5580",
- "irreversible": true,
- "phrase": "@twitter.com",
- "whole_word": false
}, - {
- "context": [
- "home"
], - "expires_at": "2019-05-21T13:47:31.333Z",
- "id": "6191",
- "irreversible": false,
- "phrase": ":eurovision2019:",
- "whole_word": true
}
]
write:filters
) Parameters
context required | Array of strings Items Enum: "home" "notifications" "public" "thread" Array of enumerable strings |
expires_in | integer Nullable Number of seconds from now the filter should expire. Otherwise, null for a filter that doesn't expire. |
boolean or string or integer Nullable Default: false Should the server irreversibly drop matching entities from home and notifications? | |
phrase required | string The text to be filtered |
boolean or string or integer Nullable Default: true Consider word boundaries? |
{- "context": [
- "home"
], - "phrase": "knights"
}
{- "context": [
- "home",
- "notifications",
- "public",
- "thread"
], - "expires_at": null,
- "id": "5580",
- "irreversible": true,
- "phrase": "@twitter.com",
- "whole_word": false
}
write:accounts
) boolean or string or integer (BooleanLike) blocks notifications from accounts you do not follow | |
boolean or string or integer (BooleanLike) removes the contents of a message from the push notification |
{- "status": "success"
}
Get synchronized settings for an application
read:accounts
) app required | string Example: pleroma-fe Application name |
{ }
Update synchronized settings for an application
write:accounts
) app required | string Example: pleroma-fe Application name |
Parameters
The settings object to be merged with the current settings. To remove a field, set it to null.
{- "config1": true,
- "config2_to_unset": null
}
{ }
[- {
- "category": "Fun",
- "shortcode": "blank",
- "tags": [
- "Fun"
], - "visible_in_picker": false
}, - {
- "category": "Gif,Fun",
- "shortcode": "firefox",
- "tags": [
- "Gif",
- "Fun"
], - "visible_in_picker": true
}, - {
- "category": "pack:mixed",
- "shortcode": "sadcat",
- "tags": [
- "pack:mixed"
], - "visible_in_picker": true
}
]
{- "avatar_upload_limit": 2000000,
- "background_image": "/static/image.png",
- "background_upload_limit": 4000000,
- "banner_upload_limit": 4000000,
- "description": "Pleroma: An efficient and flexible fediverse server",
- "email": "lain@lain.com",
- "languages": [
- "en"
], - "max_toot_chars": 5000,
- "poll_limits": {
- "max_expiration": 31536000,
- "max_option_chars": 200,
- "max_options": 20,
- "min_expiration": 0
}, - "registrations": false,
- "rules": {
- "title": null,
- "x-validate": null,
- "items": {
- "title": null,
- "x-validate": null,
- "items": null,
- "oneOf": null,
- "anyOf": null,
- "deprecated": null,
- "type": "object",
- "maxLength": null,
- "uniqueItems": null,
- "exclusiveMaximum": null,
- "readOnly": null,
- "allOf": null,
- "minItems": null,
- "xml": null,
- "additionalProperties": null,
- "required": null,
- "not": null,
- "example": null,
- "default": null,
- "multipleOf": null,
- "minimum": null,
- "pattern": null,
- "exclusiveMinimum": null,
- "externalDocs": null,
- "maxItems": null,
- "maxProperties": null,
- "x-struct": null,
- "nullable": null,
- "description": null,
- "minProperties": null,
- "properties": {
- "hint": {
- "title": null,
- "x-validate": null,
- "items": null,
- "oneOf": null,
- "anyOf": null,
- "deprecated": null,
- "type": "string",
- "maxLength": null,
- "uniqueItems": null,
- "exclusiveMaximum": null,
- "readOnly": null,
- "allOf": null,
- "minItems": null,
- "xml": null,
- "additionalProperties": null,
- "required": null,
- "not": null,
- "example": null,
- "default": null,
- "multipleOf": null,
- "minimum": null,
- "pattern": null,
- "exclusiveMinimum": null,
- "externalDocs": null,
- "maxItems": null,
- "maxProperties": null,
- "x-struct": null,
- "nullable": null,
- "description": null,
- "minProperties": null,
- "properties": null,
- "writeOnly": null,
- "minLength": null,
- "format": null,
- "maximum": null,
- "discriminator": null,
- "enum": null
}, - "id": {
- "title": null,
- "x-validate": null,
- "items": null,
- "oneOf": null,
- "anyOf": null,
- "deprecated": null,
- "type": "string",
- "maxLength": null,
- "uniqueItems": null,
- "exclusiveMaximum": null,
- "readOnly": null,
- "allOf": null,
- "minItems": null,
- "xml": null,
- "additionalProperties": null,
- "required": null,
- "not": null,
- "example": null,
- "default": null,
- "multipleOf": null,
- "minimum": null,
- "pattern": null,
- "exclusiveMinimum": null,
- "externalDocs": null,
- "maxItems": null,
- "maxProperties": null,
- "x-struct": null,
- "nullable": null,
- "description": null,
- "minProperties": null,
- "properties": null,
- "writeOnly": null,
- "minLength": null,
- "format": null,
- "maximum": null,
- "discriminator": null,
- "enum": null
}, - "text": {
- "title": null,
- "x-validate": null,
- "items": null,
- "oneOf": null,
- "anyOf": null,
- "deprecated": null,
- "type": "string",
- "maxLength": null,
- "uniqueItems": null,
- "exclusiveMaximum": null,
- "readOnly": null,
- "allOf": null,
- "minItems": null,
- "xml": null,
- "additionalProperties": null,
- "required": null,
- "not": null,
- "example": null,
- "default": null,
- "multipleOf": null,
- "minimum": null,
- "pattern": null,
- "exclusiveMinimum": null,
- "externalDocs": null,
- "maxItems": null,
- "maxProperties": null,
- "x-struct": null,
- "nullable": null,
- "description": null,
- "minProperties": null,
- "properties": null,
- "writeOnly": null,
- "minLength": null,
- "format": null,
- "maximum": null,
- "discriminator": null,
- "enum": null
}
}, - "writeOnly": null,
- "minLength": null,
- "format": null,
- "maximum": null,
- "discriminator": null,
- "enum": null
}, - "oneOf": null,
- "anyOf": null,
- "deprecated": null,
- "type": "array",
- "maxLength": null,
- "uniqueItems": null,
- "exclusiveMaximum": null,
- "readOnly": null,
- "allOf": null,
- "minItems": null,
- "xml": null,
- "additionalProperties": null,
- "required": null,
- "not": null,
- "example": null,
- "default": null,
- "multipleOf": null,
- "minimum": null,
- "pattern": null,
- "exclusiveMinimum": null,
- "externalDocs": null,
- "maxItems": null,
- "maxProperties": null,
- "x-struct": null,
- "nullable": null,
- "description": null,
- "minProperties": null,
- "properties": null,
- "writeOnly": null,
- "minLength": null,
- "format": null,
- "maximum": null,
- "discriminator": null,
- "enum": null
}, - "stats": {
- "domain_count": 2996,
- "status_count": 15802,
- "user_count": 5
}, - "title": "lain.com",
- "upload_limit": 16000000,
- "urls": {
- "streaming_api": "wss://lain.com"
}, - "version": "2.7.2 (compatible; Pleroma 2.0.50-536-g25eec6d7-develop)"
}
{- "configuration": {
- "accounts": {
- "max_featured_tags": 0,
- "max_pinned_statuses": 0
}, - "media_attachments": {
- "image_size_limit": 0,
- "video_size_limit": 0
}, - "polls": {
- "max_characters_per_option": 0,
- "max_expiration": 0,
- "max_options": 0,
- "min_expiration": 0
}, - "statuses": {
- "characters_reserved_per_url": 0,
- "max_characters": 0,
- "max_media_attachments": 0
}, - "urls": {
- "streaming": "string"
}
}, - "description": "string",
- "domain": "string",
- "email": "user@example.com",
- "languages": [
- "string"
], - "registrations": {
- "approval_required": true,
- "enabled": true
}, - "source_url": "string",
- "stats": {
- "domain_count": 0,
- "status_count": 0,
- "user_count": 0
}, - "thumbnail": {
- "url": "string"
}, - "title": "string",
- "urls": { },
- "usage": {
- "users": {
- "active_month": 0
}
}, - "version": "string"
}
read:chats
) id required | string The ID of the Chat |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "account_id": "someflakeid",
- "chat_id": "1",
- "content": "Check this out :firefox:",
- "created_at": "2020-04-21T15:11:46.000Z",
- "emojis": [
- {
- "shortcode": "firefox",
- "visible_in_picker": false
}
], - "id": "13",
- "unread": false
}, - {
- "account_id": "someflakeid",
- "chat_id": "1",
- "content": "Whats' up?",
- "created_at": "2020-04-21T15:06:45.000Z",
- "emojis": [ ],
- "id": "12",
- "unread": false
}
]
write:chats
) id required | string The ID of the Chat |
Parameters
content | string The content of your message. Optional if media_id is present |
media_id | string The id of an upload |
{- "content": "Hey wanna buy feet pics?",
- "media_id": "134234"
}
{- "account_id": "someflakeid",
- "attachment": null,
- "card": null,
- "chat_id": "1",
- "content": "hey you again",
- "created_at": "2020-04-21T15:06:45.000Z",
- "emojis": [
- {
- "shortcode": "firefox",
- "visible_in_picker": false
}
], - "id": "14",
- "unread": false
}
write:chats
) id required | string The ID of the Chat |
message_id required | string The ID of the message |
{- "account_id": "someflakeid",
- "attachment": null,
- "card": null,
- "chat_id": "1",
- "content": "hey you again",
- "created_at": "2020-04-21T15:06:45.000Z",
- "emojis": [
- {
- "shortcode": "firefox",
- "visible_in_picker": false
}
], - "id": "14",
- "unread": false
}
Deprecated due to no support for pagination. Using /api/v2/pleroma/chats instead is recommended.
read:chats
) boolean or string or integer (BooleanLike) Include chats from muted users |
[- {
- "account": {
- "acct": "lain@dontbulling.me",
- "bot": false,
- "created_at": "2020-04-16T13:40:15.000Z",
- "display_name": "lain",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 0,
- "following_count": 0,
- "id": "9u6Qw6TAZANpqokMkK",
- "locked": false,
- "note": "lain",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": { },
- "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "lain",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "lain"
}, - "id": "1",
- "unread": 2
}
]
write:chats
) id required | string The ID of the Chat |
Parameters
last_read_id required | string The content of your message. |
{- "last_read_id": "abcdef12456"
}
{- "account": {
- "acct": "lain@dontbulling.me",
- "bot": false,
- "created_at": "2020-04-16T13:40:15.000Z",
- "display_name": "lain",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 0,
- "following_count": 0,
- "id": "9u6Qw6TAZANpqokMkK",
- "is_locked": false,
- "note": "lain",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": { },
- "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "lain",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "lain"
}, - "id": "1",
- "last_message": {
- "account_id": "someflakeid",
- "attachment": null,
- "card": null,
- "chat_id": "1",
- "content": "hey you again",
- "created_at": "2020-04-21T15:06:45.000Z",
- "emojis": [
- {
- "shortcode": "firefox",
- "visible_in_picker": false
}
], - "id": "14",
- "unread": false
}, - "unread": 2,
- "updated_at": "2020-04-21T15:06:45.000Z"
}
read:chats
) boolean or string or integer (BooleanLike) Include chats from muted users | |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "account": {
- "acct": "lain@dontbulling.me",
- "bot": false,
- "created_at": "2020-04-16T13:40:15.000Z",
- "display_name": "lain",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 0,
- "following_count": 0,
- "id": "9u6Qw6TAZANpqokMkK",
- "locked": false,
- "note": "lain",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": { },
- "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "lain",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "lain"
}, - "id": "1",
- "unread": 2
}
]
write:chats
) id required | string The ID of the Chat |
message_id required | string The ID of the message |
{- "account_id": "someflakeid",
- "attachment": null,
- "card": null,
- "chat_id": "1",
- "content": "hey you again",
- "created_at": "2020-04-21T15:06:45.000Z",
- "emojis": [
- {
- "shortcode": "firefox",
- "visible_in_picker": false
}
], - "id": "14",
- "unread": false
}
write:chats
) id required | string Example: someflakeid The account id of the recipient of this chat |
{- "account": {
- "acct": "lain@dontbulling.me",
- "bot": false,
- "created_at": "2020-04-16T13:40:15.000Z",
- "display_name": "lain",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 0,
- "following_count": 0,
- "id": "9u6Qw6TAZANpqokMkK",
- "is_locked": false,
- "note": "lain",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": { },
- "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "lain",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "lain"
}, - "id": "1",
- "last_message": {
- "account_id": "someflakeid",
- "attachment": null,
- "card": null,
- "chat_id": "1",
- "content": "hey you again",
- "created_at": "2020-04-21T15:06:45.000Z",
- "emojis": [
- {
- "shortcode": "firefox",
- "visible_in_picker": false
}
], - "id": "14",
- "unread": false
}, - "unread": 2,
- "updated_at": "2020-04-21T15:06:45.000Z"
}
read
) id required | string Example: 1234 The id of the chat |
{- "account": {
- "acct": "lain@dontbulling.me",
- "bot": false,
- "created_at": "2020-04-16T13:40:15.000Z",
- "display_name": "lain",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 0,
- "following_count": 0,
- "id": "9u6Qw6TAZANpqokMkK",
- "is_locked": false,
- "note": "lain",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": { },
- "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "lain",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "lain"
}, - "id": "1",
- "last_message": {
- "account_id": "someflakeid",
- "attachment": null,
- "card": null,
- "chat_id": "1",
- "content": "hey you again",
- "created_at": "2020-04-21T15:06:45.000Z",
- "emojis": [
- {
- "shortcode": "firefox",
- "visible_in_picker": false
}
], - "id": "14",
- "unread": false
}, - "unread": 2,
- "updated_at": "2020-04-21T15:06:45.000Z"
}
write:conversations
) id required | string Example: 123 Conversation ID |
{ }
[- {
- "accounts": [
- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
], - "id": "418450",
- "last_status": {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}, - "unread": true
}
]
read:statuses
) recipients | Array of strings (FlakeID) Only return conversations with the given recipients (a list of user ids) |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "accounts": [
- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
], - "id": "418450",
- "last_status": {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}, - "unread": true
}
]
write:conversations
) id required | string Example: 123 Conversation ID |
{- "accounts": [
- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
], - "id": "418450",
- "last_status": {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}, - "unread": true
}
read:statuses
) id required | string Example: 123 Conversation ID |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
]
read:statuses
) id required | string Example: 123 Conversation ID |
{- "accounts": [
- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
], - "id": "418450",
- "last_status": {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}, - "unread": true
}
Change set of recipients for the conversation.
write:conversations
) id required | string Example: 123 Conversation ID |
recipients required | Array of strings (FlakeID) A list of ids of users that should receive posts to this conversation. This will replace the current list of recipients, so submit the full list. The owner of owner of the conversation will always be part of the set of recipients, though. |
{- "accounts": [
- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
], - "id": "418450",
- "last_status": {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}, - "unread": true
}
write:statuses
) id required | string (FlakeID) Status ID |
emoji required | string A single character unicode emoji |
{- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
read:statuses
) id required | string (FlakeID) Status ID |
emoji | string Filter by a single unicode emoji |
with_muted | boolean Include reactions from muted acccounts. |
[- {
- "accounts": [
- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
], - "count": 1,
- "me": false,
- "name": "😱"
}
]
write:statuses
) id required | string (FlakeID) Status ID |
emoji required | string A single character unicode emoji |
{- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
read:statuses
) id required | string (FlakeID) Status ID |
emoji | string Filter by a single unicode emoji |
with_muted | boolean Include reactions from muted acccounts. |
[- {
- "accounts": [
- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
], - "count": 1,
- "me": false,
- "name": "😱"
}
]
write:lists
) id required | string Example: 123 List ID |
account_ids | Array of strings Array of account IDs |
Parameters
account_ids | Array of strings (FlakeID) Array of account IDs |
{- "account_ids": [
- "string"
]
}
{ }
read:lists
) id required | string Example: 123 List ID |
[- {
- "acct": "string",
- "bot": true,
- "created_at": "2019-08-24T14:15:22Z",
- "display_name": "string",
- "emojis": [
- {
- "shortcode": "fatyoshi",
- "visible_in_picker": true
}
], - "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 0,
- "id": "string",
- "is_active": true,
- "is_confirmed": true,
- "local": true,
- "locked": true,
- "mute_expires_at": "2019-08-24T14:15:22Z",
- "nickname": "string",
- "note": "string",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "also_known_as": [
- "string"
], - "ap_id": "string",
- "avatar_description": "string",
- "birthday": "2019-08-24",
- "chat_token": "string",
- "header_description": "string",
- "hide_favorites": true,
- "hide_followers": true,
- "hide_followers_count": true,
- "hide_follows": true,
- "hide_follows_count": true,
- "is_admin": true,
- "is_confirmed": true,
- "is_moderator": true,
- "notification_settings": {
- "block_from_strangers": true,
- "hide_notification_contents": true
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": { },
- "show_birthday": true,
- "skip_thread_containment": true,
- "tags": [
- "string"
], - "unread_conversation_count": 0
}, - "roles": {
- "admin": true,
- "moderator": true
}, - "source": {
- "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "note": "string",
- "pleroma": {
- "actor_type": "Application",
- "discoverable": true,
- "no_rich_text": true,
- "show_role": true
}, - "privacy": "public",
- "sensitive": true
}, - "statuses_count": 0,
- "username": "string"
}
]
Add accounts to the given list.
write:lists
) id required | string Example: 123 List ID |
Parameters
account_ids | Array of strings (FlakeID) Array of account IDs |
{- "account_ids": [
- "string"
]
}
{ }
Fetch all lists that the user owns
read:lists
) [- {
- "id": "123",
- "title": "my list"
}, - {
- "id": "1337",
- "title": "another list"
}
]
Fetch the list with the given ID. Used for verifying the title of a list.
write:lists
) Parameters
title required | string List title |
{- "title": "string"
}
{- "id": "12249",
- "title": "Friends"
}
write:lists
) id required | string Example: 123 List ID |
{ }
Fetch the list with the given ID. Used for verifying the title of a list.
read:lists
) id required | string Example: 123 List ID |
{- "id": "12249",
- "title": "Friends"
}
Change the title of a list
write:lists
) id required | string Example: 123 List ID |
Parameters
title required | string List title |
{- "title": "string"
}
{- "id": "12249",
- "title": "Friends"
}
read:statuses
) id required | string (FlakeID) Example: 123 Poll ID |
{- "emojis": [ ],
- "expired": true,
- "expires_at": "2019-12-05T04:05:08.302Z",
- "id": "34830",
- "multiple": false,
- "options": [
- {
- "title": "accept",
- "votes_count": 6
}, - {
- "title": "deny",
- "votes_count": 4
}
], - "own_votes": [
- 1
], - "pleroma": {
- "non_anonymous": false
}, - "voted": true,
- "voters_count": 10,
- "votes_count": 10
}
write:statuses
) id required | string (FlakeID) Example: 123 Poll ID |
Parameters
choices required | Array of integers Array of own votes containing index for each option (starting from 0) |
{- "choices": [
- 0,
- 1,
- 2
]
}
{- "emojis": [ ],
- "expired": true,
- "expires_at": "2019-12-05T04:05:08.302Z",
- "id": "34830",
- "multiple": false,
- "options": [
- {
- "title": "accept",
- "votes_count": 6
}, - {
- "title": "deny",
- "votes_count": 4
}
], - "own_votes": [
- 1
], - "pleroma": {
- "non_anonymous": false
}, - "voted": true,
- "voters_count": 10,
- "votes_count": 10
}
Statuses the user has bookmarked
read:bookmarks
) folder_id | string (FlakeID) If provided, only display bookmarks from given folder |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
]
Statuses the user has favourited. Please note that you have to use the link headers to paginate this. You can not build the query parameters yourself.
read:favourites
) max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
]
View statuses with a “direct” scope addressed to the account. Using this endpoint is discouraged, please use conversations or chats.
read:statuses
) boolean or string or integer (BooleanLike) Include activities by muted users | |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
]
Receive statuses in real-time via WebSocket.
You can specify the access token on the query string or through the sec-websocket-protocol
header. Using
the query string to authenticate is considered unsafe and should not be used unless you have to (e.g. to maintain
your client's compatibility with Mastodon).
You may specify a stream on the query string. If you do so and you are connecting to a stream that requires logged-in users, you must specify the access token at the time of the connection (i.e. via query string or header).
Otherwise, you have the option to authenticate after you have established the connection through client-sent events.
The "Request body" section below describes what events clients can send through WebSocket, and the "Responses" section describes what events server will send through WebSocket.
read:statuses
read:notifications
) instance | string (Domain name) Example: instance=example.org Domain name of the instance. Required when |
list | string (List id) Example: list=some-id The id of the list. Required when |
stream | string Enum: "public" "public:local" "public:media" "public:local:media" "public:remote" "public:remote:media" "user" "user:pleroma_chat" "user:notification" "direct" "list" "hashtag" The name of the stream. |
tag | string (Hashtag name) Example: tag=mew The name of the hashtag. Required when |
access_token | string Example: access_token=some token An OAuth access token with corresponding permissions. |
connection required | string connection header |
upgrade required | string upgrade header |
sec-websocket-key required | string sec-websocket-key header |
sec-websocket-version required | string sec-websocket-version header |
sec-websocket-protocol | string Example: some token An OAuth access token with corresponding permissions. |
Client-sent events
instance | string (Domain name) Domain name of the instance. Required when |
list | string (List id) The id of the list. Required when |
stream required | string Enum: "public" "public:local" "public:media" "public:local:media" "public:remote" "public:remote:media" "user" "user:pleroma_chat" "user:notification" "direct" "list" "hashtag" The name of the stream. |
tag | string (Hashtag name) The name of the hashtag. Required when |
type required | string Value: "subscribe" Type of the event. |
{- "list": "1",
- "stream": "list",
- "type": "subscribe"
}
{- "event": "update",
- "payload": "{\"account\":{\"acct\":\"nick6\",\"avatar\":\"http://localhost:4001/images/avi.png\",\"avatar_static\":\"http://localhost:4001/images/avi.png\",\"bot\":false,\"created_at\":\"2020-04-07T19:48:51.000Z\",\"display_name\":\"Test テスト User 6\",\"emojis\":[],\"fields\":[],\"followers_count\":1,\"following_count\":0,\"header\":\"http://localhost:4001/images/banner.png\",\"header_static\":\"http://localhost:4001/images/banner.png\",\"id\":\"9toJCsKN7SmSf3aj5c\",\"is_locked\":false,\"note\":\"Tester Number 6\",\"pleroma\":{\"background_image\":null,\"hide_favorites\":true,\"hide_followers\":false,\"hide_followers_count\":false,\"hide_follows\":false,\"hide_follows_count\":false,\"is_admin\":false,\"is_confirmed\":true,\"is_moderator\":false,\"relationship\":{\"blocked_by\":false,\"blocking\":false,\"domain_blocking\":false,\"endorsed\":false,\"followed_by\":false,\"following\":true,\"id\":\"9toJCsKN7SmSf3aj5c\",\"muting\":false,\"muting_notifications\":false,\"note\":\"\",\"notifying\":false,\"requested\":false,\"showing_reblogs\":true,\"subscribing\":false},\"skip_thread_containment\":false,\"tags\":[]},\"source\":{\"fields\":[],\"note\":\"Tester Number 6\",\"pleroma\":{\"actor_type\":\"Person\",\"discoverable\":false},\"sensitive\":false},\"statuses_count\":1,\"url\":\"http://localhost:4001/users/nick6\",\"username\":\"nick6\"},\"application\":null,\"bookmarked\":false,\"card\":null,\"content\":\"foobar\",\"created_at\":\"2020-04-07T19:48:51.000Z\",\"emojis\":[],\"favourited\":false,\"favourites_count\":0,\"id\":\"9toJCu5YZW7O7gfvH6\",\"in_reply_to_account_id\":null,\"in_reply_to_id\":null,\"language\":null,\"media_attachments\":[],\"mentions\":[],\"muted\":false,\"pinned\":false,\"pleroma\":{\"content\":{\"text/plain\":\"foobar\"},\"context\":\"http://localhost:4001/objects/8b4c0c80-6a37-4d2a-b1b9-05a19e3875aa\",\"conversation_id\":345972,\"direct_conversation_id\":null,\"emoji_reactions\":[],\"expires_at\":null,\"in_reply_to_account_acct\":null,\"local\":true,\"quotes_count\":0,\"spoiler_text\":{\"text/plain\":\"\"},\"thread_muted\":false},\"poll\":null,\"reblog\":null,\"reblogged\":false,\"reblogs_count\":0,\"replies_count\":0,\"sensitive\":false,\"spoiler_text\":\"\",\"tags\":[],\"uri\":\"http://localhost:4001/objects/0f5dad44-0e9e-4610-b377-a2631e499190\",\"url\":\"http://localhost:4001/notice/9toJCu5YZW7O7gfvH6\",\"visibility\":\"private\"}",
- "stream": [
- "hashtag",
- "mew"
]
}
View public statuses containing the given hashtag
read:statuses
) tag required | string Content of a #hashtag, not including # symbol. |
any | Array of strings Statuses that also includes any of these tags |
all | Array of strings Statuses that also includes all of these tags |
none | Array of strings Statuses that do not include these tags |
boolean or string or integer Default: false Show only local statuses? | |
boolean or string or integer Default: false Show only statuses with media attached? | |
boolean or string or integer Default: false Show only remote statuses? | |
boolean or string or integer (BooleanLike) Include activities by muted users | |
exclude_visibilities | Array of strings (VisibilityScope) Items Enum: "public" "unlisted" "local" "private" "direct" "list" Exclude the statuses with the given visibilities |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
]
View statuses from followed users
read:statuses
) boolean or string or integer Default: false Show only local statuses? | |
boolean or string or integer Default: false Show only remote statuses? | |
boolean or string or integer Default: false Show only statuses with media attached? | |
boolean or string or integer (BooleanLike) Include activities by muted users | |
exclude_visibilities | Array of strings (VisibilityScope) Items Enum: "public" "unlisted" "local" "private" "direct" "list" Exclude the statuses with the given visibilities |
reply_visibility | string Enum: "following" "self" Filter replies. Possible values: without parameter (default) shows all replies, |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
]
read:statuses
) boolean or string or integer Default: false Show only local statuses? | |
instance | string Show only statuses from the given domain |
boolean or string or integer Default: false Show only statuses with media attached? | |
boolean or string or integer Default: false Show only remote statuses? | |
boolean or string or integer (BooleanLike) Include activities by muted users | |
exclude_visibilities | Array of strings (VisibilityScope) Items Enum: "public" "unlisted" "local" "private" "direct" "list" Exclude the statuses with the given visibilities |
reply_visibility | string Enum: "following" "self" Filter replies. Possible values: without parameter (default) shows all replies, |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
]
View statuses in the given list timeline
read:lists
) list_id required | string Local ID of the list in the database |
boolean or string or integer (BooleanLike) Include activities by muted users | |
boolean or string or integer Default: false Show only local statuses? | |
boolean or string or integer Default: false Show only remote statuses? | |
boolean or string or integer Default: false Show only statuses with media attached? | |
exclude_visibilities | Array of strings (VisibilityScope) Items Enum: "public" "unlisted" "local" "private" "direct" "list" Exclude the statuses with the given visibilities |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
]
View history of a status
read:statuses
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
[- {
- "account": {
- "acct": "string",
- "bot": true,
- "created_at": "2019-08-24T14:15:22Z",
- "display_name": "string",
- "emojis": [
- {
- "shortcode": "fatyoshi",
- "visible_in_picker": true
}
], - "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 0,
- "id": "string",
- "is_active": true,
- "is_confirmed": true,
- "local": true,
- "locked": true,
- "mute_expires_at": "2019-08-24T14:15:22Z",
- "nickname": "string",
- "note": "string",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "also_known_as": [
- "string"
], - "ap_id": "string",
- "avatar_description": "string",
- "birthday": "2019-08-24",
- "chat_token": "string",
- "header_description": "string",
- "hide_favorites": true,
- "hide_followers": true,
- "hide_followers_count": true,
- "hide_follows": true,
- "hide_follows_count": true,
- "is_admin": true,
- "is_confirmed": true,
- "is_moderator": true,
- "notification_settings": {
- "block_from_strangers": true,
- "hide_notification_contents": true
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": { },
- "show_birthday": true,
- "skip_thread_containment": true,
- "tags": [
- "string"
], - "unread_conversation_count": 0
}, - "roles": {
- "admin": true,
- "moderator": true
}, - "source": {
- "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "note": "string",
- "pleroma": {
- "actor_type": "Application",
- "discoverable": true,
- "no_rich_text": true,
- "show_role": true
}, - "privacy": "public",
- "sensitive": true
}, - "statuses_count": 0,
- "username": "string"
}, - "content": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "emojis": [
- {
- "shortcode": "fatyoshi",
- "visible_in_picker": true
}
], - "media_attachments": [
- {
- "description": null,
- "id": "1638338801",
- "pleroma": {
- "mime_type": "image/png"
}, - "preview_url": "someurl",
- "remote_url": "someurl",
- "text_url": "someurl",
- "type": "image",
- "url": "someurl"
}
], - "poll": {
- "emojis": [ ],
- "expired": true,
- "expires_at": "2019-12-05T04:05:08.302Z",
- "id": "34830",
- "multiple": false,
- "options": [
- {
- "title": "accept",
- "votes_count": 6
}, - {
- "title": "deny",
- "votes_count": 4
}
], - "own_votes": [
- 1
], - "pleroma": {
- "non_anonymous": false
}, - "voted": true,
- "voters_count": 10,
- "votes_count": 10
}, - "sensitive": true,
- "spoiler_text": "string"
}
]
View who reblogged a given status
read:accounts
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
[- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
]
read:statuses
) id | Array of strings (FlakeID) Array of status IDs |
ids | Array of strings (FlakeID) Deprecated, use |
boolean or string or integer (BooleanLike) Include reactions from muted acccounts. |
[- {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
]
View who favourited a given status
read:accounts
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
[- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
]
View information about a status
read:statuses
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
boolean or string or integer (BooleanLike) Include reactions from muted acccounts. |
{- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
View statuses above and below this status in the thread
read:statuses
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
{- "ancestors": [
- {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
], - "descendants": [
- {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
]
}
View quotes for a given status
read:statuses
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
]
View source of a status
read:statuses
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
{- "content_type": "string",
- "id": "string",
- "spoiler_text": "string",
- "text": "string"
}
write:statuses
) id required | string (FlakeID) Example: 123 Poll ID |
{ }
read:statuses
) id required | string (FlakeID) Example: 123 Poll ID |
{- "id": "3221",
- "media_attachments": [
- {
- "description": null,
- "id": "1638338801",
- "pleroma": {
- "mime_type": "image/png"
}, - "preview_url": "someurl",
- "remote_url": "someurl",
- "text_url": "someurl",
- "type": "image",
- "url": "someurl"
}
], - "params": {
- "expires_in": null,
- "idempotency": null,
- "in_reply_to_id": null,
- "media_ids": null,
- "poll": null,
- "scheduled_at": null,
- "sensitive": null,
- "spoiler_text": null,
- "text": "test content",
- "visibility": null
}, - "scheduled_at": "2019-12-05T12:33:01.000Z"
}
write:statuses
) id required | string (FlakeID) Example: 123 Poll ID |
Parameters
scheduled_at | string <date-time> ISO 8601 Datetime at which the status will be published. Must be at least 5 minutes into the future. |
{- "scheduled_at": "2019-08-24T14:15:22Z"
}
{- "id": "3221",
- "media_attachments": [
- {
- "description": null,
- "id": "1638338801",
- "pleroma": {
- "mime_type": "image/png"
}, - "preview_url": "someurl",
- "remote_url": "someurl",
- "text_url": "someurl",
- "type": "image",
- "url": "someurl"
}
], - "params": {
- "expires_in": null,
- "idempotency": null,
- "in_reply_to_id": null,
- "media_ids": null,
- "poll": null,
- "scheduled_at": null,
- "sensitive": null,
- "spoiler_text": null,
- "text": "test content",
- "visibility": null
}, - "scheduled_at": "2019-12-05T12:33:01.000Z"
}
read:statuses
) max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "id": "3221",
- "media_attachments": [
- {
- "description": null,
- "id": "1638338801",
- "pleroma": {
- "mime_type": "image/png"
}, - "preview_url": "someurl",
- "remote_url": "someurl",
- "text_url": "someurl",
- "type": "image",
- "url": "someurl"
}
], - "params": {
- "expires_in": null,
- "idempotency": null,
- "in_reply_to_id": null,
- "media_ids": null,
- "poll": null,
- "scheduled_at": null,
- "sensitive": null,
- "spoiler_text": null,
- "text": "test content",
- "visibility": null
}, - "scheduled_at": "2019-12-05T12:33:01.000Z"
}
]
read:search
) account_id | string (FlakeID) If provided, statuses returned will be authored only by this account |
type | string Enum: "accounts" "hashtags" "statuses" Search type |
q required | string What to search for |
boolean or string or integer Default: false Attempt WebFinger lookup | |
boolean or string or integer Default: false Only include accounts that the user is following | |
boolean or string or integer (BooleanLike) Embed relationships into accounts. If this parameter is not set account's | |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
{- "accounts": [
- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
], - "statuses": [
- {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
]
}
q required | string What to search for |
limit | integer Default: 40 Maximum number of results |
boolean or string or integer Default: false Attempt WebFinger lookup. Use this when | |
boolean or string or integer Default: false Only include accounts that the user is following |
[- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
]
read:search
) account_id | string (FlakeID) If provided, statuses returned will be authored only by this account |
type | string Enum: "accounts" "hashtags" "statuses" Search type |
q required | string The search query |
boolean or string or integer Default: false Attempt WebFinger lookup | |
boolean or string or integer Default: false Only include accounts that the user is following | |
offset | integer Offset |
boolean or string or integer (BooleanLike) Embed relationships into accounts. If this parameter is not set account's | |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
{- "accounts": [
- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
], - "hashtags": [
- "cofe"
], - "statuses": [
- {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
]
}
Start receiving notifications again for the thread that this status is part of
write:mutes
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
{- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
Undo a reshare of a status
write:statuses
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
{- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
Unfeature a status from the top of your profile
write:accounts
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
{- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
Remove a status from your private bookmarks
write:bookmarks
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
{- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
Post a new status
write:statuses
) Parameters
content_type | string Nullable The MIME type of the status, it is transformed into HTML by the backend. You can get the list of the supported MIME types with the nodeinfo endpoint. |
expires_in | integer Nullable The number of seconds the posted activity should expire in. When a posted activity expires it will be deleted from the server, and a delete request for it will be federated. This needs to be longer than an hour. |
in_reply_to_conversation_id | string Nullable Will reply to a given conversation, addressing only the people who are part of the recipient set of that conversation. Sets the visibility to |
in_reply_to_id | string Nullable ID of the status being replied to, if status is a reply |
language | string Nullable ISO 639 language code for this status. |
media_ids | Array of strings Nullable Array of Attachment ids to be attached as media. |
object Nullable | |
boolean or string or integer Nullable If set to | |
quote_id | string Nullable ID of the status being quoted, if any |
scheduled_at | string <date-time> Nullable ISO 8601 Datetime at which to schedule a status. Providing this parameter will cause ScheduledStatus to be returned instead of Status. Must be at least 5 minutes in the future. |
boolean or string or integer Nullable Mark status and attached media as sensitive? | |
spoiler_text | string Nullable Text to be shown as a warning or subject before the actual content. Statuses are generally collapsed behind this field. |
status | string Nullable Text content of the status. If |
to | Array of strings Nullable A list of nicknames (like |
VisibilityScope (string) or string Nullable Visibility of the posted status. Besides standard MastoAPI values ( |
{- "poll": {
- "expires_in": 420,
- "options": [
- "Cofe",
- "Adventure"
]
}, - "sensitive": "false",
- "status": "What time is it?"
}
{- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
Do not receive notifications for the thread that this status is part of.
write:mutes
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
expires_in | integer Default: 0 Expire the mute in |
Parameters
expires_in | integer Nullable Default: 0 Expire the mute in |
{- "expires_in": 0
}
{- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
Delete one of your own statuses
write:statuses
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
{- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
Change the content of a status
write:statuses
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
Parameters
content_type | string Nullable The MIME type of the status, it is transformed into HTML by the backend. You can get the list of the supported MIME types with the nodeinfo endpoint. |
media_ids | Array of strings Nullable Array of Attachment ids to be attached as media. |
object Nullable | |
boolean or string or integer Nullable Mark status and attached media as sensitive? | |
spoiler_text | string Nullable Text to be shown as a warning or subject before the actual content. Statuses are generally collapsed behind this field. |
status | string Nullable Text content of the status. If |
to | Array of strings Nullable A list of nicknames (like |
{- "poll": {
- "expires_in": 420,
- "options": [
- "Cofe",
- "Adventure"
]
}, - "sensitive": "false",
- "status": "What time is it?"
}
{- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
Remove a status from your favourites list
write:favourites
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
{- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
Privately bookmark a status
write:bookmarks
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
Parameters
folder_id | string Nullable ID of bookmarks folder, if any |
{- "folder_id": "string"
}
{- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
Feature one of your own public statuses at the top of your profile
write:accounts
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
{- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
Share a status
write:statuses
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
Parameters
visibility | string Enum: "public" "unlisted" "local" "private" "direct" "list" Status visibility |
{- "visibility": "public"
}
{- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
Add a status to your favourites list
write:favourites
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Status ID |
{- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
Creates an attachment to be used with a new status.
write:media
) Parameters
description | string A plain-text description of the media, for accessibility purposes. |
file required | string <binary> The file to be attached, using multipart form data. |
focus | string Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0. |
{- "description": "string",
- "file": "string",
- "focus": "string"
}
{- "description": null,
- "id": "1638338801",
- "pleroma": {
- "mime_type": "image/png"
}, - "preview_url": "someurl",
- "remote_url": "someurl",
- "text_url": "someurl",
- "type": "image",
- "url": "someurl"
}
Creates an attachment to be used with a new status.
write:media
) Parameters
description | string A plain-text description of the media, for accessibility purposes. |
file required | string <binary> The file to be attached, using multipart form data. |
focus | string Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0. |
{- "description": "string",
- "file": "string",
- "focus": "string"
}
{- "description": null,
- "id": "1638338801",
- "pleroma": {
- "mime_type": "image/png"
}, - "preview_url": "someurl",
- "remote_url": "someurl",
- "text_url": "someurl",
- "type": "image",
- "url": "someurl"
}
read:media
) id required | string The ID of the Attachment entity |
{- "description": null,
- "id": "1638338801",
- "pleroma": {
- "mime_type": "image/png"
}, - "preview_url": "someurl",
- "remote_url": "someurl",
- "text_url": "someurl",
- "type": "image",
- "url": "someurl"
}
Creates an attachment to be used with a new status.
write:media
) id required | string The ID of the Attachment entity |
Parameters
description | string A plain-text description of the media, for accessibility purposes. |
file | string <binary> The file to be attached, using multipart form data. |
focus | string Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0. |
{- "description": "string",
- "file": "string",
- "focus": "string"
}
{- "description": null,
- "id": "1638338801",
- "pleroma": {
- "mime_type": "image/png"
}, - "preview_url": "someurl",
- "remote_url": "someurl",
- "text_url": "someurl",
- "type": "image",
- "url": "someurl"
}
[- {
- "emoji": null,
- "id": "9toJCu5YZW7O7gfvH6",
- "name": "Read later"
}
]
write:bookmarks
) Parameters
emoji | string Nullable Folder emoji |
name | string Folder name |
{- "emoji": "string",
- "name": "string"
}
{- "emoji": null,
- "id": "9toJCu5YZW7O7gfvH6",
- "name": "Read later"
}
write:bookmarks
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Bookmark Folder ID |
{- "emoji": null,
- "id": "9toJCu5YZW7O7gfvH6",
- "name": "Read later"
}
write:bookmarks
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Bookmark Folder ID |
Parameters
emoji | string Nullable Folder emoji |
name | string Nullable Folder name |
{- "emoji": "string",
- "name": "string"
}
{- "emoji": null,
- "id": "9toJCu5YZW7O7gfvH6",
- "name": "Read later"
}
name required | string Example: name=cofe Pack Name |
page | integer Default: 1 Page |
page_size | integer Default: 30 Number of emoji to return |
{- "files": {
- "emacs": "emacs.png",
- "guix": "guix.png"
}, - "pack": {
- "can-download": true,
- "description": "Test description",
- "download-sha256": "57482F30674FD3DE821FF48C81C00DA4D4AF1F300209253684ABA7075E5FC238",
- "license": "Test license",
- "share-files": true
}
}
page | integer Default: 1 Page |
page_size | integer Default: 50 Number of emoji packs to return |
{- "count": 1,
- "packs": {
- "emojos": {
- "files": {
- "emacs": "emacs.png",
- "guix": "guix.png"
}, - "pack": {
- "can-download": true,
- "description": "Test description",
- "download-sha256": "57482F30674FD3DE821FF48C81C00DA4D4AF1F300209253684ABA7075E5FC238",
- "license": "Test license",
- "share-files": true
}
}
}
}
read:reports
) id required | string (FlakeID) Example: 9umDrYheeY451cQnEe Report ID |
{- "account": {
- "acct": "string",
- "bot": true,
- "created_at": "2019-08-24T14:15:22Z",
- "display_name": "string",
- "emojis": [
- {
- "shortcode": "fatyoshi",
- "visible_in_picker": true
}
], - "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 0,
- "id": "string",
- "is_active": true,
- "is_confirmed": true,
- "local": true,
- "locked": true,
- "mute_expires_at": "2019-08-24T14:15:22Z",
- "nickname": "string",
- "note": "string",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "also_known_as": [
- "string"
], - "ap_id": "string",
- "avatar_description": "string",
- "birthday": "2019-08-24",
- "chat_token": "string",
- "header_description": "string",
- "hide_favorites": true,
- "hide_followers": true,
- "hide_followers_count": true,
- "hide_follows": true,
- "hide_follows_count": true,
- "is_admin": true,
- "is_confirmed": true,
- "is_moderator": true,
- "notification_settings": {
- "block_from_strangers": true,
- "hide_notification_contents": true
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": { },
- "show_birthday": true,
- "skip_thread_containment": true,
- "tags": [
- "string"
], - "unread_conversation_count": 0
}, - "roles": {
- "admin": true,
- "moderator": true
}, - "source": {
- "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "note": "string",
- "pleroma": {
- "actor_type": "Application",
- "discoverable": true,
- "no_rich_text": true,
- "show_role": true
}, - "privacy": "public",
- "sensitive": true
}, - "statuses_count": 0,
- "username": "string"
}, - "actor": {
- "acct": "string",
- "bot": true,
- "created_at": "2019-08-24T14:15:22Z",
- "display_name": "string",
- "emojis": [
- {
- "shortcode": "fatyoshi",
- "visible_in_picker": true
}
], - "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 0,
- "id": "string",
- "is_active": true,
- "is_confirmed": true,
- "local": true,
- "locked": true,
- "mute_expires_at": "2019-08-24T14:15:22Z",
- "nickname": "string",
- "note": "string",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "also_known_as": [
- "string"
], - "ap_id": "string",
- "avatar_description": "string",
- "birthday": "2019-08-24",
- "chat_token": "string",
- "header_description": "string",
- "hide_favorites": true,
- "hide_followers": true,
- "hide_followers_count": true,
- "hide_follows": true,
- "hide_follows_count": true,
- "is_admin": true,
- "is_confirmed": true,
- "is_moderator": true,
- "notification_settings": {
- "block_from_strangers": true,
- "hide_notification_contents": true
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": { },
- "show_birthday": true,
- "skip_thread_containment": true,
- "tags": [
- "string"
], - "unread_conversation_count": 0
}, - "roles": {
- "admin": true,
- "moderator": true
}, - "source": {
- "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "note": "string",
- "pleroma": {
- "actor_type": "Application",
- "discoverable": true,
- "no_rich_text": true,
- "show_role": true
}, - "privacy": "public",
- "sensitive": true
}, - "statuses_count": 0,
- "username": "string"
}, - "content": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "state": "open",
- "statuses": [
- {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
]
}
read:reports
) state | string Enum: "open" "closed" "resolved" Filter by report state |
limit | integer The number of records to retrieve |
page | integer Default: 1 Page number |
page_size | integer Default: 50 Number number of log entries per page |
{- "reports": [
- {
- "account": {
- "acct": "string",
- "bot": true,
- "created_at": "2019-08-24T14:15:22Z",
- "display_name": "string",
- "emojis": [
- {
- "shortcode": "fatyoshi",
- "visible_in_picker": true
}
], - "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 0,
- "id": "string",
- "is_active": true,
- "is_confirmed": true,
- "local": true,
- "locked": true,
- "mute_expires_at": "2019-08-24T14:15:22Z",
- "nickname": "string",
- "note": "string",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "also_known_as": [
- "string"
], - "ap_id": "string",
- "avatar_description": "string",
- "birthday": "2019-08-24",
- "chat_token": "string",
- "header_description": "string",
- "hide_favorites": true,
- "hide_followers": true,
- "hide_followers_count": true,
- "hide_follows": true,
- "hide_follows_count": true,
- "is_admin": true,
- "is_confirmed": true,
- "is_moderator": true,
- "notification_settings": {
- "block_from_strangers": true,
- "hide_notification_contents": true
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": { },
- "show_birthday": true,
- "skip_thread_containment": true,
- "tags": [
- "string"
], - "unread_conversation_count": 0
}, - "roles": {
- "admin": true,
- "moderator": true
}, - "source": {
- "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "note": "string",
- "pleroma": {
- "actor_type": "Application",
- "discoverable": true,
- "no_rich_text": true,
- "show_role": true
}, - "privacy": "public",
- "sensitive": true
}, - "statuses_count": 0,
- "username": "string"
}, - "actor": {
- "acct": "string",
- "bot": true,
- "created_at": "2019-08-24T14:15:22Z",
- "display_name": "string",
- "emojis": [
- {
- "shortcode": "fatyoshi",
- "visible_in_picker": true
}
], - "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 0,
- "id": "string",
- "is_active": true,
- "is_confirmed": true,
- "local": true,
- "locked": true,
- "mute_expires_at": "2019-08-24T14:15:22Z",
- "nickname": "string",
- "note": "string",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "also_known_as": [
- "string"
], - "ap_id": "string",
- "avatar_description": "string",
- "birthday": "2019-08-24",
- "chat_token": "string",
- "header_description": "string",
- "hide_favorites": true,
- "hide_followers": true,
- "hide_followers_count": true,
- "hide_follows": true,
- "hide_follows_count": true,
- "is_admin": true,
- "is_confirmed": true,
- "is_moderator": true,
- "notification_settings": {
- "block_from_strangers": true,
- "hide_notification_contents": true
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": { },
- "show_birthday": true,
- "skip_thread_containment": true,
- "tags": [
- "string"
], - "unread_conversation_count": 0
}, - "roles": {
- "admin": true,
- "moderator": true
}, - "source": {
- "fields": [
- {
- "name": "Website",
- "value": "<a href=\"https://pleroma.com\" rel=\"me nofollow noopener noreferrer\" target=\"_blank\"><span class=\"invisible\">https://</span><span class=\"\">pleroma.com</span><span class=\"invisible\"></span></a>",
- "verified_at": "2019-08-29T04:14:55.571+00:00"
}
], - "note": "string",
- "pleroma": {
- "actor_type": "Application",
- "discoverable": true,
- "no_rich_text": true,
- "show_role": true
}, - "privacy": "public",
- "sensitive": true
}, - "statuses_count": 0,
- "username": "string"
}, - "content": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "state": "open",
- "statuses": [
- {
- "account": {
- "acct": "nick6",
- "bot": false,
- "created_at": "2020-04-07T19:48:51.000Z",
- "display_name": "Test テスト User 6",
- "emojis": [ ],
- "fields": [ ],
- "followers_count": 1,
- "following_count": 0,
- "id": "9toJCsKN7SmSf3aj5c",
- "is_locked": false,
- "note": "Tester Number 6",
- "pleroma": {
- "background_image": null,
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": true,
- "is_moderator": false,
- "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": true,
- "id": "9toJCsKN7SmSf3aj5c",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "skip_thread_containment": false,
- "tags": [ ]
}, - "source": {
- "fields": [ ],
- "note": "Tester Number 6",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false
}, - "sensitive": false
}, - "statuses_count": 1,
- "username": "nick6"
}, - "application": null,
- "bookmarked": false,
- "card": null,
- "content": "foobar",
- "created_at": "2020-04-07T19:48:51.000Z",
- "emojis": [ ],
- "favourited": false,
- "favourites_count": 0,
- "id": "9toJCu5YZW7O7gfvH6",
- "in_reply_to_account_id": null,
- "in_reply_to_id": null,
- "language": null,
- "media_attachments": [ ],
- "mentions": [ ],
- "muted": false,
- "pinned": false,
- "pleroma": {
- "content": {
- "text/plain": "foobar"
}, - "conversation_id": 345972,
- "direct_conversation_id": null,
- "emoji_reactions": [ ],
- "expires_at": null,
- "in_reply_to_account_acct": null,
- "local": true,
- "quotes_count": 0,
- "spoiler_text": {
- "text/plain": ""
}, - "thread_muted": false
}, - "poll": null,
- "reblog": null,
- "reblogged": false,
- "reblogs_count": 0,
- "replies_count": 0,
- "sensitive": false,
- "spoiler_text": "",
- "tags": [ ],
- "visibility": "private"
}
]
}
], - "total": 0
}
Report problematic users to your moderators
follow
write:reports
) Parameters
account_id required | string ID of the account to report |
comment | string Nullable Reason for the report |
boolean or string or integer Nullable Default: false If the account is remote, should the report be forwarded to the remote admin? | |
rule_ids | Array of strings Nullable Array of rules |
status_ids | Array of strings Nullable Array of Statuses to attach to the report, for context |
{- "account_id": "123",
- "comment": "bad status!",
- "forward": "false",
- "rule_ids": [
- "3"
], - "status_ids": [
- "1337"
]
}
{- "action_taken": false,
- "id": "123"
}
write:accounts
) id required | string announcement id |
{ }
[- {
- "all_day": true,
- "content": "string",
- "emojis": [ ],
- "ends_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "mentions": [ ],
- "pleroma": {
- "raw_content": "string"
}, - "published_at": "2019-08-24T14:15:22Z",
- "reactions": [ ],
- "read": true,
- "starts_at": "2019-08-24T14:15:22Z",
- "statuses": [ ],
- "tags": [ ],
- "updated_at": "2019-08-24T14:15:22Z"
}
]
Parameters
ap_id required | string Profile or status ActivityPub ID |
profile required | string Remote profile webfinger |
{- "ap_id": "string",
- "profile": "string"
}
{ }
{ }
order | string Order by recent activity or account creation |
boolean or string or integer (BooleanLike) Include local users only | |
max_id | string Return items older than this ID |
min_id | string Return the oldest items newer than this ID |
since_id | string Return the newest items newer than this ID |
offset | integer Default: 0 Return items past this number of items |
limit | integer Default: 20 Maximum number of items to return. Will be ignored if it's more than 40 |
[- {
- "acct": "foobar",
- "avatar_description": "",
- "bot": false,
- "created_at": "2020-03-24T13:05:58.000Z",
- "display_name": "foobar",
- "emojis": [ ],
- "fields": [ ],
- "follow_requests_count": 0,
- "followers_count": 0,
- "following_count": 1,
- "header_description": "",
- "id": "9tKi3esbG7OQgZ2920",
- "locked": false,
- "note": "cofe",
- "pleroma": {
- "accepts_chat_messages": true,
- "allow_following_move": true,
- "background_image": null,
- "birthday": "2001-02-12",
- "chat_token": "SFMyNTY.g3QAAAACZAAEZGF0YW0AAAASOXRLaTNlc2JHN09RZ1oyOTIwZAAGc2lnbmVkbgYARNplS3EB.Mb_Iaqew2bN1I1o79B_iP7encmVCpTKC4OtHZRxdjKc",
- "hide_favorites": true,
- "hide_followers": false,
- "hide_followers_count": false,
- "hide_follows": false,
- "hide_follows_count": false,
- "is_admin": false,
- "is_confirmed": false,
- "is_moderator": false,
- "notification_settings": {
- "block_from_strangers": false,
- "hide_notification_contents": false
}, - "relationship": {
- "blocked_by": false,
- "blocking": false,
- "domain_blocking": false,
- "endorsed": false,
- "followed_by": false,
- "following": false,
- "id": "9tKi3esbG7OQgZ2920",
- "muting": false,
- "muting_notifications": false,
- "note": "",
- "notifying": false,
- "requested": false,
- "showing_reblogs": true,
- "subscribing": false
}, - "settings_store": {
- "pleroma-fe": { }
}, - "skip_thread_containment": false,
- "tags": [ ],
- "unread_conversation_count": 0
}, - "source": {
- "fields": [ ],
- "note": "foobar",
- "pleroma": {
- "actor_type": "Person",
- "discoverable": false,
- "no_rich_text": false,
- "show_role": true
}, - "privacy": "public",
- "sensitive": false
}, - "statuses_count": 0,
- "username": "foobar"
}
]