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 Home, public, hashtag & list timelines accept these parameters:
21 - `only_media`: show only statuses with media attached
22 - `local`: show only local statuses
23 - `only_remote`: show only remote statuses
27 - `visibility`: has additional possible values `list` and `local` (for local-only statuses)
29 Has these additional fields under the `pleroma` object:
31 - `local`: true if the post was made on the local instance
32 - `conversation_id`: the ID of the AP context the status is associated with (if any)
33 - `direct_conversation_id`: the ID of the Mastodon direct message conversation the status is associated with (if any)
34 - `in_reply_to_account_acct`: the `acct` property of User entity for replied user (if any)
35 - `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`
36 - `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`
37 - `expires_at`: a datetime (iso8601) that states when the post will expire (be deleted automatically), or empty if the post won't expire
38 - `thread_muted`: true if the thread the post belongs to is muted
39 - `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.
40 - `parent_visible`: If the parent of this post is visible to the user or not.
44 Has these additional fields under the `pleroma` object:
46 - `mime_type`: mime type of the attachment.
50 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.
54 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.
58 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.
60 - `/api/v1/accounts/:id`
61 - `/api/v1/accounts/:id/statuses`
63 `/api/v1/accounts/:id/statuses` endpoint accepts these parameters:
65 - `pinned`: include only pinned statuses
67 - `only_media`: include only statuses with media attached
68 - `with_muted`: include statuses/reactions from muted accounts
69 - `exclude_reblogs`: exclude reblogs
70 - `exclude_replies`: exclude replies
71 - `exclude_visibilities`: exclude visibilities
73 Has these additional fields under the `pleroma` object:
75 - `ap_id`: nullable URL string, ActivityPub id of the user
76 - `background_image`: nullable URL string, background image of the user
77 - `tags`: Lists an array of tags for the user
78 - `relationship` (object): Includes fields as documented for Mastodon API https://docs.joinmastodon.org/entities/relationship/
79 - `is_moderator`: boolean, nullable, true if user is a moderator
80 - `is_admin`: boolean, nullable, true if user is an admin
81 - `confirmation_pending`: boolean, true if a new user account is waiting on email confirmation to be activated
82 - `hide_favorites`: boolean, true when the user has hiding favorites enabled
83 - `hide_followers`: boolean, true when the user has follower hiding enabled
84 - `hide_follows`: boolean, true when the user has follow hiding enabled
85 - `hide_followers_count`: boolean, true when the user has follower stat hiding enabled
86 - `hide_follows_count`: boolean, true when the user has follow stat hiding enabled
87 - `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`
88 - `chat_token`: The token needed for Pleroma chat. Only returned in `/api/v1/accounts/verify_credentials`
89 - `deactivated`: boolean, true when the user is deactivated
90 - `allow_following_move`: boolean, true when the user allows automatically follow moved following accounts
91 - `unread_conversation_count`: The count of unread conversations. Only returned to the account owner.
92 - `unread_notifications_count`: The count of unread notifications. Only returned to the account owner.
93 - `notification_settings`: object, can be absent. See `/api/pleroma/notification_settings` for the parameters/keys returned.
94 - `accepts_chat_messages`: boolean, but can be null if we don't have that information about a user
95 - `favicon`: nullable URL string, Favicon image of the user's instance
99 Has these additional fields under the `pleroma` object:
101 - `show_role`: boolean, nullable, true when the user wants his role (e.g admin, moderator) to be shown
102 - `no_rich_text` - boolean, nullable, true when html tags are stripped from all statuses requested from the API
103 - `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)
104 - `actor_type`: string, the type of this account.
108 Has an additional field under the `pleroma` object:
110 - `recipients`: The list of the recipients of this Conversation. These will be addressed when replying to this conversation.
112 ## GET `/api/v1/conversations`
114 Accepts additional parameters:
116 - `recipients`: Only return conversations with the given recipients (a list of user ids). Usage example: `GET /api/v1/conversations?recipients[]=1&recipients[]=2`
120 Behavior has changed:
122 - `/api/v1/accounts/search`: Does not require authentication
126 Unlisted posts are available in search results, they are considered to be public posts that shouldn't be shown in local/federated timeline.
130 Has these additional fields under the `pleroma` object:
132 - `is_seen`: true if the notification was read by the user
134 ### Move Notification
136 The `type` value is `move`. Has an additional field:
138 - `target`: new account
140 ### EmojiReact Notification
142 The `type` value is `pleroma:emoji_reaction`. Has these fields:
144 - `emoji`: The used emoji
145 - `account`: The account of the user who reacted
146 - `status`: The status that was reacted on
148 ### ChatMention Notification (not default)
150 This notification has to be requested explicitly.
152 The `type` value is `pleroma:chat_mention`
154 - `account`: The account who sent the message
155 - `chat_message`: The chat message
157 ### Report Notification (not default)
159 This notification has to be requested explicitly.
161 The `type` value is `pleroma:report`
163 - `account`: The account who reported
164 - `report`: The report
166 ## GET `/api/v1/notifications`
168 Accepts additional parameters:
170 - `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`.
171 - `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`.
173 ## DELETE `/api/v1/notifications/destroy_multiple`
175 An endpoint to delete multiple statuses by IDs.
179 - `ids`: array of activity ids
181 Usage example: `DELETE /api/v1/notifications/destroy_multiple/?ids[]=1&ids[]=2`.
183 Returns on success: 200 OK `{}`
185 ## POST `/api/v1/statuses`
187 Additional parameters can be added to the JSON body/Form data:
189 - `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.
190 - `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.
191 - `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.
192 - `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`.
193 - `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.
194 - `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`.
196 ## GET `/api/v1/statuses`
198 An endpoint to get multiple statuses by IDs.
202 - `ids`: array of activity ids
204 Usage example: `GET /api/v1/statuses/?ids[]=1&ids[]=2`.
206 Returns: array of Status.
208 The maximum number of statuses is limited to 100 per request.
210 ## PATCH `/api/v1/accounts/update_credentials`
212 Additional parameters can be added to the JSON body/Form data:
214 - `no_rich_text` - if true, html tags are stripped from all statuses requested from the API
215 - `hide_followers` - if true, user's followers will be hidden
216 - `hide_follows` - if true, user's follows will be hidden
217 - `hide_followers_count` - if true, user's follower count will be hidden
218 - `hide_follows_count` - if true, user's follow count will be hidden
219 - `hide_favorites` - if true, user's favorites timeline will be hidden
220 - `show_role` - if true, user's role (e.g admin, moderator) will be exposed to anyone in the API
221 - `default_scope` - the scope returned under `privacy` key in Source subentity
222 - `pleroma_settings_store` - Opaque user settings to be saved on the backend.
223 - `skip_thread_containment` - if true, skip filtering out broken threads
224 - `allow_following_move` - if true, allows automatically follow moved following accounts
225 - `also_known_as` - array of ActivityPub IDs, needed for following move
226 - `pleroma_background_image` - sets the background image of the user. Can be set to "" (an empty string) to reset.
227 - `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).
228 - `actor_type` - the type of this account.
229 - `accepts_chat_messages` - if false, this account will reject all chat messages.
231 All images (avatar, banner and background) can be reset to the default by sending an empty string ("") instead of a file.
233 ### Pleroma Settings Store
235 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.
237 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.
239 This information is returned in the `/api/v1/accounts/verify_credentials` endpoint.
243 *Pleroma supports refreshing tokens.*
247 Post here request with `grant_type=refresh_token` to obtain new access token. Returns an access token.
249 ## Account Registration
251 `POST /api/v1/accounts`
253 Has these additional parameters (which are the same as in Pleroma-API):
255 - `fullname`: optional
257 - `captcha_solution`: optional, contains provider-specific captcha solution,
258 - `captcha_token`: optional, contains provider-specific captcha token
259 - `captcha_answer_data`: optional, contains provider-specific captcha data
260 - `token`: invite token required when the registrations aren't public.
264 `GET /api/v1/instance` has additional fields
266 - `max_toot_chars`: The maximum characters per post
267 - `chat_limit`: The maximum characters per chat message
268 - `description_limit`: The maximum characters per image description
269 - `poll_limits`: The limits of polls
270 - `upload_limit`: The maximum upload file size
271 - `avatar_upload_limit`: The same for avatars
272 - `background_upload_limit`: The same for backgrounds
273 - `banner_upload_limit`: The same for banners
274 - `background_image`: A background image that frontends can use
275 - `pleroma.metadata.features`: A list of supported features
276 - `pleroma.metadata.federation`: The federation restrictions of this instance
277 - `pleroma.metadata.fields_limits`: A list of values detailing the length and count limitation for various instance-configurable fields.
278 - `pleroma.metadata.post_formats`: A list of the allowed post format types
279 - `vapid_public_key`: The public key needed for push messages
283 `POST /api/v1/push/subscription`
284 `PUT /api/v1/push/subscription`
286 Permits these additional alert types:
288 - pleroma:chat_mention
289 - pleroma:emoji_reaction
293 Has these additional fields under the `pleroma` object:
295 - `unread_count`: contains number unread notifications
301 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.
305 For viewing remote server timelines, there are `public:remote` and `public:remote:media` streams. Each of these accept a parameter like `?instance=lain.com`.
307 ### Follow relationships updates
309 Pleroma streams follow relationships updates as `pleroma:follow_relationships_update` events to the `user` stream.
311 The message payload consist of:
313 - `state`: a relationship state, one of `follow_pending`, `follow_accept` or `follow_reject`.
315 - `follower` and `following` maps with following fields:
317 - `follower_count`: follower count
318 - `following_count`: following count
320 ## User muting and thread muting
322 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.
326 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.
330 *Added in Mastodon 2.4.3*
332 - `GET /api/v1/suggestions`: Returns an empty array, `[]`
336 *Added in Mastodon 3.0.0*
338 - `GET /api/v1/trends`: Returns an empty array, `[]`
342 *Added in Mastodon 2.8.0*
344 - `GET /api/v1/identity_proofs`: Returns an empty array, `[]`
348 *Added in Mastodon 2.5.0*
350 - `GET /api/v1/endorsements`: Returns an empty array, `[]`
352 ### Profile directory
354 *Added in Mastodon 3.0.0*
356 - `GET /api/v1/directory`: Returns HTTP 404
360 *Added in Mastodon 3.0.0*
362 - `GET /api/v1/featured_tags`: Returns HTTP 404