1 # Differences in Mastodon API responses from vanilla Mastodon
3 A Akkoma instance can be identified by "<Mastodon version> (compatible; Pleroma <version>)" present in `version` field in response from `/api/v1/instance`
7 Akkoma 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 - `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.
41 - `pinned_at`: a datetime (iso8601) when status was pinned, `null` otherwise.
43 The `GET /api/v1/statuses/:id/source` endpoint additionally has the following attributes:
45 - `content_type`: The content type of the status source.
49 Has these additional fields in `params`:
51 - `expires_in`: the number of seconds the posted activity should expire in.
55 Has these additional fields under the `pleroma` object:
57 - `mime_type`: mime type of the attachment.
61 Some apps operate under the assumption that no more than 4 attachments can be returned or uploaded. Akkoma however does not enforce any limits on attachment count neither when returning the status object nor when posting.
65 Akkoma 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.
69 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.
71 - `/api/v1/accounts/:id`
72 - `/api/v1/accounts/:id/statuses`
74 `/api/v1/accounts/:id/statuses` endpoint accepts these parameters:
76 - `pinned`: include only pinned statuses
78 - `only_media`: include only statuses with media attached
79 - `with_muted`: include statuses/reactions from muted accounts
80 - `exclude_reblogs`: exclude reblogs
81 - `exclude_replies`: exclude replies
82 - `exclude_visibilities`: exclude visibilities
84 Endpoints which accept `with_relationships` parameter:
86 - `/api/v1/accounts/:id`
87 - `/api/v1/accounts/:id/followers`
88 - `/api/v1/accounts/:id/following`
91 Has these additional fields under the `pleroma` object:
93 - `ap_id`: nullable URL string, ActivityPub id of the user
94 - `background_image`: nullable URL string, background image of the user
95 - `tags`: Lists an array of tags for the user
96 - `relationship` (object): Includes fields as documented for Mastodon API https://docs.joinmastodon.org/entities/relationship/
97 - `is_moderator`: boolean, nullable, true if user is a moderator
98 - `is_admin`: boolean, nullable, true if user is an admin
99 - `confirmation_pending`: boolean, true if a new user account is waiting on email confirmation to be activated
100 - `hide_favorites`: boolean, true when the user has hiding favorites enabled
101 - `hide_followers`: boolean, true when the user has follower hiding enabled
102 - `hide_follows`: boolean, true when the user has follow hiding enabled
103 - `hide_followers_count`: boolean, true when the user has follower stat hiding enabled
104 - `hide_follows_count`: boolean, true when the user has follow stat hiding enabled
105 - `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`
106 - `deactivated`: boolean, true when the user is deactivated
107 - `allow_following_move`: boolean, true when the user allows automatically follow moved following accounts
108 - `unread_conversation_count`: The count of unread conversations. Only returned to the account owner.
109 - `unread_notifications_count`: The count of unread notifications. Only returned to the account owner.
110 - `notification_settings`: object, can be absent. See `/api/v1/pleroma/notification_settings` for the parameters/keys returned.
111 - `favicon`: nullable URL string, Favicon image of the user's instance
115 Has these additional fields under the `pleroma` object:
117 - `show_role`: boolean, nullable, true when the user wants his role (e.g admin, moderator) to be shown
118 - `no_rich_text` - boolean, nullable, true when html tags are stripped from all statuses requested from the API
119 - `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)
120 - `actor_type`: string, the type of this account.
124 Has an additional field under the `pleroma` object:
126 - `recipients`: The list of the recipients of this Conversation. These will be addressed when replying to this conversation.
128 ## GET `/api/v1/conversations`
130 Accepts additional parameters:
132 - `recipients`: Only return conversations with the given recipients (a list of user ids). Usage example: `GET /api/v1/conversations?recipients[]=1&recipients[]=2`
136 Behavior has changed:
138 - `/api/v1/accounts/search`: Does not require authentication
142 Unlisted posts are available in search results, they are considered to be public posts that shouldn't be shown in local/federated timeline.
146 Has these additional fields under the `pleroma` object:
148 - `is_seen`: true if the notification was read by the user
150 ### Move Notification
152 The `type` value is `move`. Has an additional field:
154 - `target`: new account
156 ### EmojiReact Notification
158 The `type` value is `pleroma:emoji_reaction`. Has these fields:
160 - `emoji`: The used emoji
161 - `account`: The account of the user who reacted
162 - `status`: The status that was reacted on
164 ### Report Notification (not default)
166 This notification has to be requested explicitly.
168 The `type` value is `pleroma:report`
170 - `account`: The account who reported
171 - `report`: The report
173 ## GET `/api/v1/notifications`
175 Accepts additional parameters:
177 - `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`.
178 - `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:report`). Usage example: `GET /api/v1/notifications?include_types[]=mention&include_types[]=reblog`.
180 ## DELETE `/api/v1/notifications/destroy_multiple`
182 An endpoint to delete multiple statuses by IDs.
186 - `ids`: array of activity ids
188 Usage example: `DELETE /api/v1/notifications/destroy_multiple/?ids[]=1&ids[]=2`.
190 Returns on success: 200 OK `{}`
192 ## POST `/api/v1/statuses`
194 Additional parameters can be added to the JSON body/Form data:
196 - `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.
197 - `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.
198 - `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.
199 - `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`.
200 - `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.
201 - `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`.
203 ## GET `/api/v1/statuses`
205 An endpoint to get multiple statuses by IDs.
209 - `ids`: array of activity ids
211 Usage example: `GET /api/v1/statuses/?ids[]=1&ids[]=2`.
213 Returns: array of Status.
215 The maximum number of statuses is limited to 100 per request.
217 ## PATCH `/api/v1/accounts/update_credentials`
219 Additional parameters can be added to the JSON body/Form data:
221 - `no_rich_text` - if true, html tags are stripped from all statuses requested from the API
222 - `hide_followers` - if true, user's followers will be hidden
223 - `hide_follows` - if true, user's follows will be hidden
224 - `hide_followers_count` - if true, user's follower count will be hidden
225 - `hide_follows_count` - if true, user's follow count will be hidden
226 - `hide_favorites` - if true, user's favorites timeline will be hidden
227 - `show_role` - if true, user's role (e.g admin, moderator) will be exposed to anyone in the API
228 - `default_scope` - the scope returned under `privacy` key in Source subentity
229 - `pleroma_settings_store` - Opaque user settings to be saved on the backend.
230 - `skip_thread_containment` - if true, skip filtering out broken threads
231 - `allow_following_move` - if true, allows automatically follow moved following accounts
232 - `also_known_as` - array of ActivityPub IDs, needed for following move
233 - `pleroma_background_image` - sets the background image of the user. Can be set to "" (an empty string) to reset.
234 - `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).
235 - `actor_type` - the type of this account.
236 - `language` - user's preferred language for receiving emails (digest, confirmation, etc.)
238 All images (avatar, banner and background) can be reset to the default by sending an empty string ("") instead of a file.
240 ### Akkoma Settings Store
242 Akkoma 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.
244 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.
246 This information is returned in the `/api/v1/accounts/verify_credentials` endpoint.
250 *Akkoma supports refreshing tokens.*
252 ### POST `/oauth/token`
254 You can obtain access tokens for a user in a few additional ways.
256 #### Refreshing a token
258 To obtain a new access token from a refresh token, pass `grant_type=refresh_token` with the following extra parameters:
260 - `refresh_token`: The refresh token.
262 #### Getting a token with a password
264 To obtain a token from a user's password, pass `grant_type=password` with the following extra parameters:
266 - `username`: Username to authenticate.
267 - `password`: The user's password.
271 Additional fields are returned in the response:
273 - `id`: The primary key of this token in Akkoma's database.
274 - `me` (user tokens only): The ActivityPub ID of the user who owns the token.
276 ## Account Registration
278 `POST /api/v1/accounts`
280 Has these additional parameters (which are the same as in Akkoma-API):
282 - `fullname`: optional
284 - `captcha_solution`: optional, contains provider-specific captcha solution,
285 - `captcha_token`: optional, contains provider-specific captcha token
286 - `captcha_answer_data`: optional, contains provider-specific captcha data
287 - `token`: invite token required when the registrations aren't public.
288 - `language`: optional, user's preferred language for receiving emails (digest, confirmation, etc.), default to the language set in the `userLanguage` cookies or `Accept-Language` header.
292 `GET /api/v1/instance` has additional fields
294 - `max_toot_chars`: The maximum characters per post
295 - `description_limit`: The maximum characters per image description
296 - `poll_limits`: The limits of polls
297 - `upload_limit`: The maximum upload file size
298 - `avatar_upload_limit`: The same for avatars
299 - `background_upload_limit`: The same for backgrounds
300 - `banner_upload_limit`: The same for banners
301 - `background_image`: A background image that frontends can use
302 - `pleroma.metadata.features`: A list of supported features
303 - `pleroma.metadata.federation`: The federation restrictions of this instance
304 - `pleroma.metadata.fields_limits`: A list of values detailing the length and count limitation for various instance-configurable fields.
305 - `pleroma.metadata.post_formats`: A list of the allowed post format types
306 - `vapid_public_key`: The public key needed for push messages
310 `POST /api/v1/push/subscription`
311 `PUT /api/v1/push/subscription`
313 Permits these additional alert types:
315 - pleroma:emoji_reaction
319 Has these additional fields under the `pleroma` object:
321 - `unread_count`: contains number unread notifications
327 For viewing remote server timelines, there are `public:remote` and `public:remote:media` streams. Each of these accept a parameter like `?instance=lain.com`.
329 ### Follow relationships updates
331 Akkoma streams follow relationships updates as `pleroma:follow_relationships_update` events to the `user` stream.
333 The message payload consist of:
335 - `state`: a relationship state, one of `follow_pending`, `follow_accept` or `follow_reject`.
337 - `follower` and `following` maps with following fields:
339 - `follower_count`: follower count
340 - `following_count`: following count
342 ## User muting and thread muting
344 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.
348 Akkoma 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.
352 *Added in Mastodon 2.4.3*
354 - `GET /api/v1/suggestions`: Returns an empty array, `[]`
358 *Added in Mastodon 3.0.0*
360 - `GET /api/v1/trends`: Returns an empty array, `[]`
364 *Added in Mastodon 2.8.0*
366 - `GET /api/v1/identity_proofs`: Returns an empty array, `[]`
370 *Added in Mastodon 2.5.0*
372 - `GET /api/v1/endorsements`: Returns an empty array, `[]`
376 *Added in Mastodon 3.0.0*
378 - `GET /api/v1/featured_tags`: Returns HTTP 404