3 Requests that require it can be authenticated with [an OAuth token](https://tools.ietf.org/html/rfc6749), the `_pleroma_key` cookie, or [HTTP Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization).
5 Request parameters can be passed via [query strings](https://en.wikipedia.org/wiki/Query_string) or as [form data](https://www.w3.org/TR/html401/interact/forms.html). Files must be uploaded as `multipart/form-data`.
7 The `/api/v1/pleroma/*` path is backwards compatible with `/api/pleroma/*` (`/api/pleroma/*` will be deprecated in the future).
9 ## `/api/v1/pleroma/emoji`
10 ### Lists the custom emoji on that server.
12 * Authentication: not required
22 "image_url": "/finmoji/128px/girlpower-128.png"
28 "image_url": "/finmoji/128px/education-128.png"
34 "image_url": "/finmoji/128px/finnishlove-128.png"
38 * Note: Same data as Mastodon API’s `/api/v1/custom_emojis` but in a different format
40 ## `/api/pleroma/follow_import`
41 ### Imports your follows, for example from a Mastodon CSV file.
43 * Authentication: required
45 * `list`: STRING or FILE containing a whitespace-separated list of accounts to follow
46 * Response: HTTP 200 on success, 500 on error
47 * Note: Users that can't be followed are silently skipped.
49 ## `/api/pleroma/blocks_import`
50 ### Imports your blocks.
52 * Authentication: required
54 * `list`: STRING or FILE containing a whitespace-separated list of accounts to block
55 * Response: HTTP 200 on success, 500 on error
57 ## `/api/pleroma/mutes_import`
58 ### Imports your mutes.
60 * Authentication: required
62 * `list`: STRING or FILE containing a whitespace-separated list of accounts to mute
63 * Response: HTTP 200 on success, 500 on error
65 ## `/api/v1/pleroma/captcha`
68 * Authentication: not required
70 * Response: Provider specific JSON, the only guaranteed parameter is `type`
71 * Example response: `{"type": "kocaptcha", "token": "whatever", "url": "https://captcha.kotobank.ch/endpoint", "seconds_valid": 300}`
73 ## `/api/pleroma/delete_account`
76 * Authentication: required
78 * `password`: user's password
79 * Response: JSON. Returns `{"status": "success"}` if the deletion was successful, `{"error": "[error message]"}` otherwise
80 * Example response: `{"error": "Invalid password."}`
82 ## `/api/pleroma/disable_account`
83 ### Disable an account
85 * Authentication: required
87 * `password`: user's password
88 * Response: JSON. Returns `{"status": "success"}` if the account was successfully disabled, `{"error": "[error message]"}` otherwise
89 * Example response: `{"error": "Invalid password."}`
91 ## `/api/pleroma/accounts/mfa`
92 #### Gets current MFA settings
94 * Authentication: required
95 * OAuth scope: `read:security`
96 * Response: JSON. Returns `{"settings": {"enabled": "false", "totp": false }}`
97 * Note: `enabled` is whether multi-factor auth is enabled for the user in general, while `totp` is one type of MFA.
99 ## `/api/pleroma/accounts/mfa/setup/totp`
100 #### Pre-setup the MFA/TOTP method
102 * Authentication: required
103 * OAuth scope: `write:security`
104 * Response: JSON. Returns `{"key": [secret_key], "provisioning_uri": "[qr code uri]" }` when successful, otherwise returns HTTP 422 `{"error": "error_msg"}`
106 ## `/api/pleroma/accounts/mfa/confirm/totp`
107 #### Confirms & enables MFA/TOTP support for user account.
109 * Authentication: required
110 * OAuth scope: `write:security`
112 * `password`: user's password
113 * `code`: token from TOTP App
114 * Response: JSON. Returns `{}` if the enable was successful, HTTP 422 `{"error": "[error message]"}` otherwise
117 ## `/api/pleroma/accounts/mfa/totp`
118 #### Disables MFA/TOTP method for user account.
120 * Authentication: required
121 * OAuth scope: `write:security`
123 * `password`: user's password
124 * Response: JSON. Returns `{}` if the disable was successful, HTTP 422 `{"error": "[error message]"}` otherwise
125 * Example response: `{"error": "Invalid password."}`
127 ## `/api/pleroma/accounts/mfa/backup_codes`
128 #### Generstes backup codes MFA for user account.
130 * Authentication: required
131 * OAuth scope: `write:security`
132 * Response: JSON. Returns `{"codes": codes}`when successful, otherwise HTTP 422 `{"error": "[error message]"}`
134 ## `/api/v1/pleroma/admin/`
135 See [Admin-API](admin_api.md)
137 ## `/api/v1/pleroma/notifications/read`
138 ### Mark notifications as read
140 * Authentication: required
141 * Params (mutually exclusive):
142 * `id`: a single notification id to read
143 * `max_id`: read all notifications up to this id
144 * Response: Notification entity/Array of Notification entities that were read. In case of `max_id`, only the first 80 read notifications will be returned.
146 ## `/api/v1/pleroma/accounts/:id/subscribe`
147 ### Subscribe to receive notifications for all statuses posted by a user
149 * Authentication: required
151 * `id`: account id to subscribe to
152 * Response: JSON, returns a mastodon relationship object on success, otherwise returns `{"error": "error_msg"}`
158 "followed_by": false,
161 "muting_notifications": false,
165 "domain_blocking": false,
166 "showing_reblogs": true,
172 ## `/api/v1/pleroma/accounts/:id/unsubscribe`
173 ### Unsubscribe to stop receiving notifications from user statuses
175 * Authentication: required
177 * `id`: account id to unsubscribe from
178 * Response: JSON, returns a mastodon relationship object on success, otherwise returns `{"error": "error_msg"}`
184 "followed_by": false,
187 "muting_notifications": false,
188 "subscribing": false,
191 "domain_blocking": false,
192 "showing_reblogs": true,
198 ## `/api/v1/pleroma/accounts/:id/favourites`
199 ### Returns favorites timeline of any user
201 * Authentication: not required
203 * `id`: the id of the account for whom to return results
204 * `limit`: optional, the number of records to retrieve
205 * `since_id`: optional, returns results that are more recent than the specified id
206 * `max_id`: optional, returns results that are older than the specified id
207 * Response: JSON, returns a list of Mastodon Status entities on success, otherwise returns `{"error": "error_msg"}`
213 "id": "9hptFmUF3ztxYh3Svg",
214 "url": "https://pleroma.example.org/users/nick2",
218 "application": {"name": "Web", "website": null},
221 "content": "This is :moominmamma: note 0",
222 "created_at": "2019-04-15T15:42:15.000Z",
225 "favourites_count": 1,
226 "id": "9hptFmVJ02khbzYJaS",
227 "in_reply_to_account_id": null,
228 "in_reply_to_id": null,
230 "media_attachments": [],
235 "content": {"text/plain": "This is :moominmamma: note 0"},
236 "conversation_id": 13679,
238 "spoiler_text": {"text/plain": "2hu"}
245 "spoiler_text": "2hu",
246 "tags": [{"name": "2hu", "url": "/tag/2hu"}],
247 "uri": "https://pleroma.example.org/objects/198ed2a1-7912-4482-b559-244a0369e984",
248 "url": "https://pleroma.example.org/notice/9hptFmVJ02khbzYJaS",
249 "visibility": "public"
254 ## `/api/v1/pleroma/accounts/update_*`
255 ### Set and clear account avatar, banner, and background
257 - PATCH `/api/v1/pleroma/accounts/update_avatar`: Set/clear user avatar image
258 - PATCH `/api/v1/pleroma/accounts/update_banner`: Set/clear user banner image
259 - PATCH `/api/v1/pleroma/accounts/update_background`: Set/clear user background image
261 ## `/api/v1/pleroma/accounts/confirmation_resend`
262 ### Resend confirmation email
265 * `email`: email of that needs to be verified
266 * Authentication: not required
267 * Response: 204 No Content
269 ## `/api/v1/pleroma/mascot`
270 ### Gets user mascot image
272 * Authentication: required
274 * Response: JSON. Returns a mastodon media attachment entity.
279 "url": "https://pleroma.example.org/media/abcdefg.png",
282 "mime_type": "image/png"
287 ### Updates user mascot image
289 * Authentication: required
291 * `file`: Multipart image
292 * Response: JSON. Returns a mastodon media attachment entity
293 when successful, otherwise returns HTTP 415 `{"error": "error_msg"}`
298 "url": "https://pleroma.example.org/media/abcdefg.png",
301 "mime_type": "image/png"
305 * Note: Behaves exactly the same as `POST /api/v1/upload`.
306 Can only accept images - any attempt to upload non-image files will be met with `HTTP 415 Unsupported Media Type`.
308 ## `/api/pleroma/notification_settings`
309 ### Updates user notification settings
311 * Authentication: required
313 * `block_from_strangers`: BOOLEAN field, blocks notifications from accounts you do not follow
314 * `hide_notification_contents`: BOOLEAN field. When set to true, it removes the contents of a message from the push notification.
315 * Response: JSON. Returns `{"status": "success"}` if the update was successful, otherwise returns `{"error": "error_msg"}`
317 ## `/api/v1/pleroma/healthcheck`
318 ### Healthcheck endpoint with additional system data.
320 * Authentication: not required
322 * Response: JSON, statuses (200 - healthy, 503 unhealthy).
326 "pool_size": 0, # database connection pool
327 "active": 0, # active processes
328 "idle": 0, # idle processes
329 "memory_used": 0.00, # Memory used
330 "healthy": true, # Instance state
331 "job_queue_stats": {} # Job queue stats
335 ## `/api/pleroma/change_email`
336 ### Change account email
338 * Authentication: required
340 * `password`: user's password
342 * Response: JSON. Returns `{"status": "success"}` if the change was successful, `{"error": "[error message]"}` otherwise
343 * Note: Currently, Mastodon has no API for changing email. If they add it in future it might be incompatible with Pleroma.
345 # Pleroma Conversations
347 Pleroma Conversations have the same general structure that Mastodon Conversations have. The behavior differs in the following ways when using these endpoints:
349 1. Pleroma Conversations never add or remove recipients, unless explicitly changed by the user.
350 2. Pleroma Conversations statuses can be requested by Conversation id.
351 3. Pleroma Conversations can be replied to.
353 Conversations have the additional field `recipients` under the `pleroma` key. This holds a list of all the accounts that will receive a message in this conversation.
355 The status posting endpoint takes an additional parameter, `in_reply_to_conversation_id`, which, when set, will set the visiblity to direct and address only the people who are the recipients of that Conversation.
357 âš Conversation IDs can be found in direct messages with the `pleroma.direct_conversation_id` key, do not confuse it with `pleroma.conversation_id`.
359 ## `GET /api/v1/pleroma/conversations/:id/statuses`
360 ### Timeline for a given conversation
362 * Authentication: required
363 * Params: Like other timelines
364 * Response: JSON, statuses (200 - healthy, 503 unhealthy).
366 ## `GET /api/v1/pleroma/conversations/:id`
367 ### The conversation with the given ID.
369 * Authentication: required
371 * Response: JSON, statuses (200 - healthy, 503 unhealthy).
373 ## `PATCH /api/v1/pleroma/conversations/:id`
374 ### Update a conversation. Used to change the set of recipients.
376 * Authentication: required
378 * `recipients`: A list of ids of users that should receive posts to this conversation. This will replace the current list of recipients, so submit the full list. The owner of owner of the conversation will always be part of the set of recipients, though.
379 * Response: JSON, statuses (200 - healthy, 503 unhealthy)
381 ## `POST /api/v1/pleroma/conversations/read`
382 ### Marks all user's conversations as read.
384 * Authentication: required
386 * Response: JSON, returns a list of Mastodon Conversation entities that were marked as read (200 - healthy, 503 unhealthy).
388 ## `GET /api/v1/pleroma/emoji/pack?name=:name`
390 ### Get pack.json for the pack
393 * Authentication: not required
395 * `page`: page number for files (default 1)
396 * `page_size`: page size for files (default 30)
397 * Response: JSON, pack json with `files`, `files_count` and `pack` keys with 200 status or 404 if the pack does not exist.
402 "files_count": 0, // emoji count in pack
407 ## `POST /api/v1/pleroma/emoji/pack?name=:name`
409 ### Creates an empty pack
412 * Authentication: required (admin)
415 * Response: JSON, "ok" and 200 status or 409 if the pack with that name already exists
417 ## `PATCH /api/v1/pleroma/emoji/pack?name=:name`
419 ### Updates (replaces) pack metadata
422 * Authentication: required (admin)
425 * `metadata`: metadata to replace the old one
426 * `license`: Pack license
427 * `homepage`: Pack home page url
428 * `description`: Pack description
429 * `fallback-src`: Fallback url to download pack from
430 * `fallback-src-sha256`: SHA256 encoded for fallback pack archive
431 * `share-files`: is pack allowed for sharing (boolean)
432 * Response: JSON, updated "metadata" section of the pack and 200 status or 400 if there was a
433 problem with the new metadata (the error is specified in the "error" part of the response JSON)
435 ## `DELETE /api/v1/pleroma/emoji/pack?name=:name`
437 ### Delete a custom emoji pack
440 * Authentication: required (admin)
443 * Response: JSON, "ok" and 200 status or 500 if there was an error deleting the pack
445 ## `GET /api/v1/pleroma/emoji/packs/import`
447 ### Imports packs from filesystem
450 * Authentication: required (admin)
452 * Response: JSON, returns a list of imported packs.
454 ## `GET /api/v1/pleroma/emoji/packs/remote`
456 ### Make request to another instance for packs list
459 * Authentication: required (admin)
461 * `url`: url of the instance to get packs from
462 * `page`: page number for packs (default 1)
463 * `page_size`: page size for packs (default 50)
464 * Response: JSON with the pack list, hashmap with pack name and pack contents
466 ## `POST /api/v1/pleroma/emoji/packs/download`
468 ### Download pack from another instance
471 * Authentication: required (admin)
473 * `url`: url of the instance to download from
474 * `name`: pack to download from that instance
475 * `as`: (*optional*) name how to save pack
476 * Response: JSON, "ok" with 200 status if the pack was downloaded, or 500 if there were
477 errors downloading the pack
479 ## `POST /api/v1/pleroma/emoji/packs/files?name=:name`
481 ### Add new file to the pack
484 * Authentication: required (admin)
487 * `file`: file needs to be uploaded with the multipart request or link to remote file.
488 * `shortcode`: (*optional*) shortcode for new emoji, must be unique for all emoji. If not sended, shortcode will be taken from original filename.
489 * `filename`: (*optional*) new emoji file name. If not specified will be taken from original filename.
490 * Response: JSON, list of files for updated pack (hashmap -> shortcode => filename) with status 200, either error status with error message.
492 ## `PATCH /api/v1/pleroma/emoji/packs/files?name=:name`
494 ### Update emoji file from pack
497 * Authentication: required (admin)
500 * `shortcode`: emoji file shortcode
501 * `new_shortcode`: new emoji file shortcode
502 * `new_filename`: new filename for emoji file
503 * `force`: (*optional*) with true value to overwrite existing emoji with new shortcode
504 * Response: JSON, list with updated files for updated pack (hashmap -> shortcode => filename) with status 200, either error status with error message.
506 ## `DELETE /api/v1/pleroma/emoji/packs/files?name=:name`
508 ### Delete emoji file from pack
511 * Authentication: required (admin)
514 * `shortcode`: emoji file shortcode
515 * Response: JSON, list with updated files for updated pack (hashmap -> shortcode => filename) with status 200, either error status with error message.
517 ## `GET /api/v1/pleroma/emoji/packs`
519 ### Lists local custom emoji packs
522 * Authentication: not required
524 * `page`: page number for packs (default 1)
525 * `page_size`: page size for packs (default 50)
526 * Response: `packs` key with JSON hashmap of pack name to pack contents and `count` key for count of packs.
531 "pack_name": {...}, // pack contents
534 "count": 0 // packs count
538 ## `GET /api/v1/pleroma/emoji/packs/archive?name=:name`
540 ### Requests a local pack archive from the instance
543 * Authentication: not required
546 * Response: the archive of the pack with a 200 status code, 403 if the pack is not set as shared,
547 404 if the pack does not exist
549 ## `GET /api/v1/pleroma/accounts/:id/scrobbles`
550 ### Requests a list of current and recent Listen activities for an account
552 * Authentication: not required
554 * Response: An array of media metadata entities.
561 "title": "Some Title",
562 "artist": "Some Artist",
563 "album": "Some Album",
565 "created_at": "2019-09-28T12:40:45.000Z"
570 ## `POST /api/v1/pleroma/scrobble`
571 ### Creates a new Listen activity for an account
573 * Authentication: required
575 * `title`: the title of the media playing
576 * `album`: the album of the media playing [optional]
577 * `artist`: the artist of the media playing [optional]
578 * `length`: the length of the media playing [optional]
579 * Response: the newly created media metadata entity representing the Listen activity
583 Emoji reactions work a lot like favourites do. They make it possible to react to a post with a single emoji character. To detect the presence of this feature, you can check `pleroma_emoji_reactions` entry in the features list of nodeinfo.
585 ## `PUT /api/v1/pleroma/statuses/:id/reactions/:emoji`
586 ### React to a post with a unicode emoji
588 * Authentication: required
589 * Params: `emoji`: A unicode RGI emoji or a regional indicator
590 * Response: JSON, the status.
592 ## `DELETE /api/v1/pleroma/statuses/:id/reactions/:emoji`
593 ### Remove a reaction to a post with a unicode emoji
595 * Authentication: required
596 * Params: `emoji`: A unicode RGI emoji or a regional indicator
597 * Response: JSON, the status.
599 ## `GET /api/v1/pleroma/statuses/:id/reactions`
600 ### Get an object of emoji to account mappings with accounts that reacted to the post
602 * Authentication: optional
604 * Response: JSON, a list of emoji/account list tuples, sorted by emoji insertion date, in ascending order, e.g, the first emoji in the list is the oldest.
608 {"name": "😀", "count": 2, "me": true, "accounts": [{"id" => "xyz.."...}, {"id" => "zyx..."}]},
609 {"name": "☕", "count": 1, "me": false, "accounts": [{"id" => "abc..."}]}
613 ## `GET /api/v1/pleroma/statuses/:id/reactions/:emoji`
614 ### Get an object of emoji to account mappings with accounts that reacted to the post for a specific emoji
616 * Authentication: optional
618 * Response: JSON, a list of emoji/account list tuples
622 {"name": "😀", "count": 2, "me": true, "accounts": [{"id" => "xyz.."...}, {"id" => "zyx..."}]}
626 ## `POST /api/v1/pleroma/backups`
627 ### Create a user backup archive
630 * Authentication: required
637 "content_type": "application/zip",
639 "inserted_at": "2020-09-10T16:18:03.000Z",
641 "url": "https://example.com/media/backups/archive-foobar-20200910T161803-QUhx6VYDRQ2wfV0SdA2Pfj_2CLM_ATUlw-D5l5TJf4Q.zip"
645 ## `GET /api/v1/pleroma/backups`
646 ### Lists user backups
649 * Authentication: not required
656 "content_type": "application/zip",
658 "inserted_at": "2020-09-10T16:18:03.000Z",
660 "url": "https://example.com/media/backups/archive-foobar-20200910T161803-QUhx6VYDRQ2wfV0SdA2Pfj_2CLM_ATUlw-D5l5TJf4Q.zip"