1 # Differences in Mastodon API responses from vanilla Mastodon
3 A Pleroma instance can be identified by "<Mastodon version> (compatible; Pleroma <version>)" present in `version` field in response from `/api/v1/instance`
7 Pleroma uses 128-bit ids as opposed to Mastodon's 64 bits. However, just like Mastodon's ids, they are lexically sortable strings
11 Adding the parameter `with_muted=true` to the timeline queries will also return activities by muted (not by blocked!) users.
13 Adding the parameter `exclude_visibilities` to the timeline queries will exclude the statuses with the given visibilities. The parameter accepts an array of visibility types (`public`, `unlisted`, `private`, `direct`), e.g., `exclude_visibilities[]=direct&exclude_visibilities[]=private`.
15 Adding the parameter `reply_visibility` to the public and home timelines queries will filter replies. Possible values: without parameter (default) shows all replies, `following` - replies directed to you or users you follow, `self` - replies directed to you.
17 Adding the parameter `instance=lain.com` to the public timeline will show only statuses originating from `lain.com` (or any remote instance).
19 Adding the parameter `only_media=true` to the home timeline will show only statuses with media attachments.
21 Adding the parameter `only_remote=true` to the home timeline will show only remote statuses.
25 - `visibility`: has additional possible values `list` and `local` (for local-only statuses)
27 Has these additional fields under the `pleroma` object:
29 - `local`: true if the post was made on the local instance
30 - `conversation_id`: the ID of the AP context the status is associated with (if any)
31 - `direct_conversation_id`: the ID of the Mastodon direct message conversation the status is associated with (if any)
32 - `in_reply_to_account_acct`: the `acct` property of User entity for replied user (if any)
33 - `content`: a map consisting of alternate representations of the `content` property with the key being its mimetype. Currently, the only alternate representation supported is `text/plain`
34 - `spoiler_text`: a map consisting of alternate representations of the `spoiler_text` property with the key being its mimetype. Currently, the only alternate representation supported is `text/plain`
35 - `expires_at`: a datetime (iso8601) that states when the post will expire (be deleted automatically), or empty if the post won't expire
36 - `thread_muted`: true if the thread the post belongs to is muted
37 - `emoji_reactions`: A list with emoji / reaction maps. The format is `{name: "☕", count: 1, me: true}`. Contains no information about the reacting users, for that use the `/statuses/:id/reactions` endpoint.
38 - `parent_visible`: If the parent of this post is visible to the user or not.
42 Has these additional fields under the `pleroma` object:
44 - `mime_type`: mime type of the attachment.
48 Some apps operate under the assumption that no more than 4 attachments can be returned or uploaded. Pleroma however does not enforce any limits on attachment count neither when returning the status object nor when posting.
52 Pleroma does not process remote images and therefore cannot include fields such as `meta` and `blurhash`. It does not support focal points or aspect ratios. The frontend is expected to handle it.
56 The `id` parameter can also be the `nickname` of the user. This only works in these endpoints, not the deeper nested ones for following etc.
58 - `/api/v1/accounts/:id`
59 - `/api/v1/accounts/:id/statuses`
61 Has these additional fields under the `pleroma` object:
63 - `ap_id`: nullable URL string, ActivityPub id of the user
64 - `background_image`: nullable URL string, background image of the user
65 - `tags`: Lists an array of tags for the user
66 - `relationship` (object): Includes fields as documented for Mastodon API https://docs.joinmastodon.org/entities/relationship/
67 - `is_moderator`: boolean, nullable, true if user is a moderator
68 - `is_admin`: boolean, nullable, true if user is an admin
69 - `confirmation_pending`: boolean, true if a new user account is waiting on email confirmation to be activated
70 - `hide_favorites`: boolean, true when the user has hiding favorites enabled
71 - `hide_followers`: boolean, true when the user has follower hiding enabled
72 - `hide_follows`: boolean, true when the user has follow hiding enabled
73 - `hide_followers_count`: boolean, true when the user has follower stat hiding enabled
74 - `hide_follows_count`: boolean, true when the user has follow stat hiding enabled
75 - `settings_store`: A generic map of settings for frontends. Opaque to the backend. Only returned in `/api/v1/accounts/verify_credentials` and `/api/v1/accounts/update_credentials`
76 - `chat_token`: The token needed for Pleroma chat. Only returned in `/api/v1/accounts/verify_credentials`
77 - `deactivated`: boolean, true when the user is deactivated
78 - `allow_following_move`: boolean, true when the user allows automatically follow moved following accounts
79 - `unread_conversation_count`: The count of unread conversations. Only returned to the account owner.
80 - `unread_notifications_count`: The count of unread notifications. Only returned to the account owner.
81 - `notification_settings`: object, can be absent. See `/api/pleroma/notification_settings` for the parameters/keys returned.
82 - `accepts_chat_messages`: boolean, but can be null if we don't have that information about a user
83 - `favicon`: nullable URL string, Favicon image of the user's instance
87 Has these additional fields under the `pleroma` object:
89 - `show_role`: boolean, nullable, true when the user wants his role (e.g admin, moderator) to be shown
90 - `no_rich_text` - boolean, nullable, true when html tags are stripped from all statuses requested from the API
91 - `discoverable`: boolean, true when the user allows external services (search bots) etc. to index / list the account (regardless of this setting, user will still appear in regular search results)
92 - `actor_type`: string, the type of this account.
96 Has an additional field under the `pleroma` object:
98 - `recipients`: The list of the recipients of this Conversation. These will be addressed when replying to this conversation.
100 ## GET `/api/v1/conversations`
102 Accepts additional parameters:
104 - `recipients`: Only return conversations with the given recipients (a list of user ids). Usage example: `GET /api/v1/conversations?recipients[]=1&recipients[]=2`
108 Behavior has changed:
110 - `/api/v1/accounts/search`: Does not require authentication
114 Unlisted posts are available in search results, they are considered to be public posts that shouldn't be shown in local/federated timeline.
118 Has these additional fields under the `pleroma` object:
120 - `is_seen`: true if the notification was read by the user
122 ### Move Notification
124 The `type` value is `move`. Has an additional field:
126 - `target`: new account
128 ### EmojiReact Notification
130 The `type` value is `pleroma:emoji_reaction`. Has these fields:
132 - `emoji`: The used emoji
133 - `account`: The account of the user who reacted
134 - `status`: The status that was reacted on
136 ### ChatMention Notification (not default)
138 This notification has to be requested explicitly.
140 The `type` value is `pleroma:chat_mention`
142 - `account`: The account who sent the message
143 - `chat_message`: The chat message
145 ### Report Notification (not default)
147 This notification has to be requested explicitly.
149 The `type` value is `pleroma:report`
151 - `account`: The account who reported
152 - `report`: The report
154 ## GET `/api/v1/notifications`
156 Accepts additional parameters:
158 - `exclude_visibilities`: will exclude the notifications for activities with the given visibilities. The parameter accepts an array of visibility types (`public`, `unlisted`, `private`, `direct`). Usage example: `GET /api/v1/notifications?exclude_visibilities[]=direct&exclude_visibilities[]=private`.
159 - `include_types`: will include the notifications for activities with the given types. The parameter accepts an array of types (`mention`, `follow`, `reblog`, `favourite`, `move`, `pleroma:emoji_reaction`, `pleroma:chat_mention`, `pleroma:report`). Usage example: `GET /api/v1/notifications?include_types[]=mention&include_types[]=reblog`.
161 ## DELETE `/api/v1/notifications/destroy_multiple`
163 An endpoint to delete multiple statuses by IDs.
167 - `ids`: array of activity ids
169 Usage example: `DELETE /api/v1/notifications/destroy_multiple/?ids[]=1&ids[]=2`.
171 Returns on success: 200 OK `{}`
173 ## POST `/api/v1/statuses`
175 Additional parameters can be added to the JSON body/Form data:
177 - `preview`: boolean, if set to `true` the post won't be actually posted, but the status entity would still be rendered back. This could be useful for previewing rich text/custom emoji, for example.
178 - `content_type`: string, contain 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.
179 - `to`: A list of nicknames (like `lain@soykaf.club` or `lain` on the local server) that will be used to determine who is going to be addressed by this post. Using this will disable the implicit addressing by mentioned names in the `status` body, only the people in the `to` list will be addressed. The normal rules for post visibility are not affected by this and will still apply.
180 - `visibility`: string, besides standard MastoAPI values (`direct`, `private`, `unlisted`, `local` or `public`) it can be used to address a List by setting it to `list:LIST_ID`.
181 - `expires_in`: 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.
182 - `in_reply_to_conversation_id`: Will reply to a given conversation, addressing only the people who are part of the recipient set of that conversation. Sets the visibility to `direct`.
184 ## GET `/api/v1/statuses`
186 An endpoint to get multiple statuses by IDs.
190 - `ids`: array of activity ids
192 Usage example: `GET /api/v1/statuses/?ids[]=1&ids[]=2`.
194 Returns: array of Status.
196 The maximum number of statuses is limited to 100 per request.
198 ## PATCH `/api/v1/accounts/update_credentials`
200 Additional parameters can be added to the JSON body/Form data:
202 - `no_rich_text` - if true, html tags are stripped from all statuses requested from the API
203 - `hide_followers` - if true, user's followers will be hidden
204 - `hide_follows` - if true, user's follows will be hidden
205 - `hide_followers_count` - if true, user's follower count will be hidden
206 - `hide_follows_count` - if true, user's follow count will be hidden
207 - `hide_favorites` - if true, user's favorites timeline will be hidden
208 - `show_role` - if true, user's role (e.g admin, moderator) will be exposed to anyone in the API
209 - `default_scope` - the scope returned under `privacy` key in Source subentity
210 - `pleroma_settings_store` - Opaque user settings to be saved on the backend.
211 - `skip_thread_containment` - if true, skip filtering out broken threads
212 - `allow_following_move` - if true, allows automatically follow moved following accounts
213 - `also_known_as` - array of ActivityPub IDs, needed for following move
214 - `pleroma_background_image` - sets the background image of the user. Can be set to "" (an empty string) to reset.
215 - `discoverable` - if true, external services (search bots) etc. are allowed to index / list the account (regardless of this setting, user will still appear in regular search results).
216 - `actor_type` - the type of this account.
217 - `accepts_chat_messages` - if false, this account will reject all chat messages.
219 All images (avatar, banner and background) can be reset to the default by sending an empty string ("") instead of a file.
221 ### Pleroma Settings Store
223 Pleroma has mechanism that allows frontends to save blobs of json for each user on the backend. This can be used to save frontend-specific settings for a user that the backend does not need to know about.
225 The parameter should have a form of `{frontend_name: {...}}`, with `frontend_name` identifying your type of client, e.g. `pleroma_fe`. It will overwrite everything under this property, but will not overwrite other frontend's settings.
227 This information is returned in the `/api/v1/accounts/verify_credentials` endpoint.
231 *Pleroma supports refreshing tokens.*
235 Post here request with `grant_type=refresh_token` to obtain new access token. Returns an access token.
237 ## Account Registration
239 `POST /api/v1/accounts`
241 Has these additional parameters (which are the same as in Pleroma-API):
243 - `fullname`: optional
245 - `captcha_solution`: optional, contains provider-specific captcha solution,
246 - `captcha_token`: optional, contains provider-specific captcha token
247 - `captcha_answer_data`: optional, contains provider-specific captcha data
248 - `token`: invite token required when the registrations aren't public.
252 `GET /api/v1/instance` has additional fields
254 - `max_toot_chars`: The maximum characters per post
255 - `chat_limit`: The maximum characters per chat message
256 - `description_limit`: The maximum characters per image description
257 - `poll_limits`: The limits of polls
258 - `upload_limit`: The maximum upload file size
259 - `avatar_upload_limit`: The same for avatars
260 - `background_upload_limit`: The same for backgrounds
261 - `banner_upload_limit`: The same for banners
262 - `background_image`: A background image that frontends can use
263 - `pleroma.metadata.features`: A list of supported features
264 - `pleroma.metadata.federation`: The federation restrictions of this instance
265 - `pleroma.metadata.fields_limits`: A list of values detailing the length and count limitation for various instance-configurable fields.
266 - `pleroma.metadata.post_formats`: A list of the allowed post format types
267 - `vapid_public_key`: The public key needed for push messages
271 `POST /api/v1/push/subscription`
272 `PUT /api/v1/push/subscription`
274 Permits these additional alert types:
276 - pleroma:chat_mention
277 - pleroma:emoji_reaction
281 Has these additional fields under the `pleroma` object:
283 - `unread_count`: contains number unread notifications
289 There is an additional `user:pleroma_chat` stream. Incoming chat messages will make the current chat be sent to this `user` stream. The `event` of an incoming chat message is `pleroma:chat_update`. The payload is the updated chat with the incoming chat message in the `last_message` field.
293 For viewing remote server timelines, there are `public:remote` and `public:remote:media` streams. Each of these accept a parameter like `?instance=lain.com`.
295 ### Follow relationships updates
297 Pleroma streams follow relationships updates as `pleroma:follow_relationships_update` events to the `user` stream.
299 The message payload consist of:
301 - `state`: a relationship state, one of `follow_pending`, `follow_accept` or `follow_reject`.
303 - `follower` and `following` maps with following fields:
305 - `follower_count`: follower count
306 - `following_count`: following count
308 ## User muting and thread muting
310 Both user muting and thread muting can be done for only a certain time by adding an `expires_in` parameter to the API calls and giving the expiration time in seconds.
314 Pleroma is generally compatible with the Mastodon 2.7.2 API, but some newer features and non-essential features are omitted. These features usually return an HTTP 200 status code, but with an empty response. While they may be added in the future, they are considered low priority.
318 *Added in Mastodon 2.4.3*
320 - `GET /api/v1/suggestions`: Returns an empty array, `[]`
324 *Added in Mastodon 3.0.0*
326 - `GET /api/v1/trends`: Returns an empty array, `[]`
330 *Added in Mastodon 2.8.0*
332 - `GET /api/v1/identity_proofs`: Returns an empty array, `[]`
336 *Added in Mastodon 2.5.0*
338 - `GET /api/v1/endorsements`: Returns an empty array, `[]`
340 ### Profile directory
342 *Added in Mastodon 3.0.0*
344 - `GET /api/v1/directory`: Returns HTTP 404
348 *Added in Mastodon 3.0.0*
350 - `GET /api/v1/featured_tags`: Returns HTTP 404