Merge branch 'issue/1878' into 'develop'
[akkoma] / docs / API / differences_in_mastoapi_responses.md
1 # Differences in Mastodon API responses from vanilla Mastodon
2
3 A Pleroma instance can be identified by "<Mastodon version> (compatible; Pleroma <version>)" present in `version` field in response from `/api/v1/instance`
4
5 ## Flake IDs
6
7 Pleroma uses 128-bit ids as opposed to Mastodon's 64 bits. However just like Mastodon's ids they are lexically sortable strings
8
9 ## Timelines
10
11 Adding the parameter `with_muted=true` to the timeline queries will also return activities by muted (not by blocked!) users.
12 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`.
13 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.
14
15 ## Statuses
16
17 - `visibility`: has an additional possible value `list`
18
19 Has these additional fields under the `pleroma` object:
20
21 - `local`: true if the post was made on the local instance
22 - `conversation_id`: the ID of the AP context the status is associated with (if any)
23 - `direct_conversation_id`: the ID of the Mastodon direct message conversation the status is associated with (if any)
24 - `in_reply_to_account_acct`: the `acct` property of User entity for replied user (if any)
25 - `content`: a map consisting of alternate representations of the `content` property with the key being it's mimetype. Currently the only alternate representation supported is `text/plain`
26 - `spoiler_text`: a map consisting of alternate representations of the `spoiler_text` property with the key being it's mimetype. Currently the only alternate representation supported is `text/plain`
27 - `expires_at`: a datetime (iso8601) that states when the post will expire (be deleted automatically), or empty if the post won't expire
28 - `thread_muted`: true if the thread the post belongs to is muted
29 - `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.
30 - `parent_visible`: If the parent of this post is visible to the user or not.
31
32 ## Media Attachments
33
34 Has these additional fields under the `pleroma` object:
35
36 - `mime_type`: mime type of the attachment.
37
38 ### Attachment cap
39
40 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.
41
42 ### Limitations
43
44 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.
45
46 ## Accounts
47
48 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.
49
50 - `/api/v1/accounts/:id`
51 - `/api/v1/accounts/:id/statuses`
52
53 Has these additional fields under the `pleroma` object:
54
55 - `ap_id`: nullable URL string, ActivityPub id of the user
56 - `background_image`: nullable URL string, background image of the user
57 - `tags`: Lists an array of tags for the user
58 - `relationship` (object): Includes fields as documented for Mastodon API https://docs.joinmastodon.org/entities/relationship/
59 - `is_moderator`: boolean, nullable, true if user is a moderator
60 - `is_admin`: boolean, nullable, true if user is an admin
61 - `confirmation_pending`: boolean, true if a new user account is waiting on email confirmation to be activated
62 - `hide_favorites`: boolean, true when the user has hiding favorites enabled
63 - `hide_followers`: boolean, true when the user has follower hiding enabled
64 - `hide_follows`: boolean, true when the user has follow hiding enabled
65 - `hide_followers_count`: boolean, true when the user has follower stat hiding enabled
66 - `hide_follows_count`: boolean, true when the user has follow stat hiding enabled
67 - `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`
68 - `chat_token`: The token needed for Pleroma chat. Only returned in `/api/v1/accounts/verify_credentials`
69 - `deactivated`: boolean, true when the user is deactivated
70 - `allow_following_move`: boolean, true when the user allows automatically follow moved following accounts
71 - `unread_conversation_count`: The count of unread conversations. Only returned to the account owner.
72 - `unread_notifications_count`: The count of unread notifications. Only returned to the account owner.
73 - `notification_settings`: object, can be absent. See `/api/pleroma/notification_settings` for the parameters/keys returned.
74 - `accepts_chat_messages`: boolean, but can be null if we don't have that information about a user
75 - `favicon`: nullable URL string, Favicon image of the user's instance
76
77 ### Source
78
79 Has these additional fields under the `pleroma` object:
80
81 - `show_role`: boolean, nullable, true when the user wants his role (e.g admin, moderator) to be shown
82 - `no_rich_text` - boolean, nullable, true when html tags are stripped from all statuses requested from the API
83 - `discoverable`: boolean, true when the user allows discovery of the account in search results and other services.
84 - `actor_type`: string, the type of this account.
85
86 ## Conversations
87
88 Has an additional field under the `pleroma` object:
89
90 - `recipients`: The list of the recipients of this Conversation. These will be addressed when replying to this conversation.
91
92 ## GET `/api/v1/conversations`
93
94 Accepts additional parameters:
95
96 - `recipients`: Only return conversations with the given recipients (a list of user ids). Usage example: `GET /api/v1/conversations?recipients[]=1&recipients[]=2`
97
98 ## Account Search
99
100 Behavior has changed:
101
102 - `/api/v1/accounts/search`: Does not require authentication
103
104 ## Search (global)
105
106 Unlisted posts are available in search results, they are considered to be public posts that shouldn't be shown in local/federated timeline.
107
108 ## Notifications
109
110 Has these additional fields under the `pleroma` object:
111
112 - `is_seen`: true if the notification was read by the user
113
114 ### Move Notification
115
116 The `type` value is `move`. Has an additional field:
117
118 - `target`: new account
119
120 ### EmojiReact Notification
121
122 The `type` value is `pleroma:emoji_reaction`. Has these fields:
123
124 - `emoji`: The used emoji
125 - `account`: The account of the user who reacted
126 - `status`: The status that was reacted on
127
128 ## GET `/api/v1/notifications`
129
130 Accepts additional parameters:
131
132 - `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`.
133 - `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`). Usage example: `GET /api/v1/notifications?include_types[]=mention&include_types[]=reblog`.
134
135 ## DELETE `/api/v1/notifications/destroy_multiple`
136
137 An endpoint to delete multiple statuses by IDs.
138
139 Required parameters:
140
141 - `ids`: array of activity ids
142
143 Usage example: `DELETE /api/v1/notifications/destroy_multiple/?ids[]=1&ids[]=2`.
144
145 Returns on success: 200 OK `{}`
146
147 ## POST `/api/v1/statuses`
148
149 Additional parameters can be added to the JSON body/Form data:
150
151 - `preview`: boolean, if set to `true` the post won't be actually posted, but the status entitiy would still be rendered back. This could be useful for previewing rich text/custom emoji, for example.
152 - `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.
153 - `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 for post visibility are not affected by this and will still apply.
154 - `visibility`: string, besides standard MastoAPI values (`direct`, `private`, `unlisted` or `public`) it can be used to address a List by setting it to `list:LIST_ID`.
155 - `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.
156 - `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`.
157
158 ## GET `/api/v1/statuses`
159
160 An endpoint to get multiple statuses by IDs.
161
162 Required parameters:
163
164 - `ids`: array of activity ids
165
166 Usage example: `GET /api/v1/statuses/?ids[]=1&ids[]=2`.
167
168 Returns: array of Status.
169
170 The maximum number of statuses is limited to 100 per request.
171
172 ## PATCH `/api/v1/accounts/update_credentials`
173
174 Additional parameters can be added to the JSON body/Form data:
175
176 - `no_rich_text` - if true, html tags are stripped from all statuses requested from the API
177 - `hide_followers` - if true, user's followers will be hidden
178 - `hide_follows` - if true, user's follows will be hidden
179 - `hide_followers_count` - if true, user's follower count will be hidden
180 - `hide_follows_count` - if true, user's follow count will be hidden
181 - `hide_favorites` - if true, user's favorites timeline will be hidden
182 - `show_role` - if true, user's role (e.g admin, moderator) will be exposed to anyone in the API
183 - `default_scope` - the scope returned under `privacy` key in Source subentity
184 - `pleroma_settings_store` - Opaque user settings to be saved on the backend.
185 - `skip_thread_containment` - if true, skip filtering out broken threads
186 - `allow_following_move` - if true, allows automatically follow moved following accounts
187 - `pleroma_background_image` - sets the background image of the user. Can be set to "" (an empty string) to reset.
188 - `discoverable` - if true, discovery of this account in search results and other services is allowed.
189 - `actor_type` - the type of this account.
190 - `accepts_chat_messages` - if false, this account will reject all chat messages.
191
192 All images (avatar, banner and background) can be reset to the default by sending an empty string ("") instead of a file.
193
194 ### Pleroma Settings Store
195
196 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.
197
198 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.
199
200 This information is returned in the `/api/v1/accounts/verify_credentials` endpoint.
201
202 ## Authentication
203
204 *Pleroma supports refreshing tokens.*
205
206 `POST /oauth/token`
207
208 Post here request with `grant_type=refresh_token` to obtain new access token. Returns an access token.
209
210 ## Account Registration
211
212 `POST /api/v1/accounts`
213
214 Has theses additional parameters (which are the same as in Pleroma-API):
215
216 - `fullname`: optional
217 - `bio`: optional
218 - `captcha_solution`: optional, contains provider-specific captcha solution,
219 - `captcha_token`: optional, contains provider-specific captcha token
220 - `captcha_answer_data`: optional, contains provider-specific captcha data
221 - `token`: invite token required when the registrations aren't public.
222
223 ## Instance
224
225 `GET /api/v1/instance` has additional fields
226
227 - `max_toot_chars`: The maximum characters per post
228 - `chat_limit`: The maximum characters per chat message
229 - `description_limit`: The maximum characters per image description
230 - `poll_limits`: The limits of polls
231 - `upload_limit`: The maximum upload file size
232 - `avatar_upload_limit`: The same for avatars
233 - `background_upload_limit`: The same for backgrounds
234 - `banner_upload_limit`: The same for banners
235 - `background_image`: A background image that frontends can use
236 - `pleroma.metadata.features`: A list of supported features
237 - `pleroma.metadata.federation`: The federation restrictions of this instance
238 - `pleroma.metadata.fields_limits`: A list of values detailing the length and count limitation for various instance-configurable fields.
239 - `pleroma.metadata.post_formats`: A list of the allowed post format types
240 - `vapid_public_key`: The public key needed for push messages
241
242 ## Markers
243
244 Has these additional fields under the `pleroma` object:
245
246 - `unread_count`: contains number unread notifications
247
248 ## Streaming
249
250 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.
251
252 ## Not implemented
253
254 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.
255
256 ### Suggestions
257
258 *Added in Mastodon 2.4.3*
259
260 - `GET /api/v1/suggestions`: Returns an empty array, `[]`
261
262 ### Trends
263
264 *Added in Mastodon 3.0.0*
265
266 - `GET /api/v1/trends`: Returns an empty array, `[]`
267
268 ### Identity proofs
269
270 *Added in Mastodon 2.8.0*
271
272 - `GET /api/v1/identity_proofs`: Returns an empty array, `[]`
273
274 ### Endorsements
275
276 *Added in Mastodon 2.5.0*
277
278 - `GET /api/v1/endorsements`: Returns an empty array, `[]`
279
280 ### Profile directory
281
282 *Added in Mastodon 3.0.0*
283
284 - `GET /api/v1/directory`: Returns HTTP 404
285
286 ### Featured tags
287
288 *Added in Mastodon 3.0.0*
289
290 - `GET /api/v1/featured_tags`: Returns HTTP 404