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