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 ## `/api/pleroma/move_account`
348 * Authentication: required
350 * `password`: user's password
351 * `target_account`: the nickname of the target account (e.g. `foo@example.org`)
352 * Response: JSON. Returns `{"status": "success"}` if the change was successful, `{"error": "[error message]"}` otherwise
353 * Note: This endpoint emits a `Move` activity to all followers of the current account. Some remote servers will automatically unfollow the current account and follow the target account upon seeing this, but this depends on the remote server implementation and cannot be guaranteed. For local followers , they will automatically unfollow and follow if and only if they have set the `allow_following_move` preference ("Allow auto-follow when following account moves").
355 ## `/api/pleroma/aliases`
356 ### Get aliases of the current account
358 * Authentication: required
359 * Response: JSON. Returns `{"aliases": [alias, ...]}`, where `alias` is the nickname of an alias, e.g. `foo@example.org`.
361 ### Add alias to the current account
363 * Authentication: required
365 * `alias`: the nickname of the alias to add, e.g. `foo@example.org`.
366 * Response: JSON. Returns `{"status": "success"}` if the change was successful, `{"error": "[error message]"}` otherwise
368 ### Delete alias from the current account
370 * Authentication: required
372 * `alias`: the nickname of the alias to delete, e.g. `foo@example.org`.
373 * Response: JSON. Returns `{"status": "success"}` if the change was successful, `{"error": "[error message]"}` otherwise
375 # Pleroma Conversations
377 Pleroma Conversations have the same general structure that Mastodon Conversations have. The behavior differs in the following ways when using these endpoints:
379 1. Pleroma Conversations never add or remove recipients, unless explicitly changed by the user.
380 2. Pleroma Conversations statuses can be requested by Conversation id.
381 3. Pleroma Conversations can be replied to.
383 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.
385 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.
387 âš Conversation IDs can be found in direct messages with the `pleroma.direct_conversation_id` key, do not confuse it with `pleroma.conversation_id`.
389 ## `GET /api/v1/pleroma/conversations/:id/statuses`
390 ### Timeline for a given conversation
392 * Authentication: required
393 * Params: Like other timelines
394 * Response: JSON, statuses (200 - healthy, 503 unhealthy).
396 ## `GET /api/v1/pleroma/conversations/:id`
397 ### The conversation with the given ID.
399 * Authentication: required
401 * Response: JSON, statuses (200 - healthy, 503 unhealthy).
403 ## `PATCH /api/v1/pleroma/conversations/:id`
404 ### Update a conversation. Used to change the set of recipients.
406 * Authentication: required
408 * `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.
409 * Response: JSON, statuses (200 - healthy, 503 unhealthy)
411 ## `POST /api/v1/pleroma/conversations/read`
412 ### Marks all user's conversations as read.
414 * Authentication: required
416 * Response: JSON, returns a list of Mastodon Conversation entities that were marked as read (200 - healthy, 503 unhealthy).
418 ## `GET /api/v1/pleroma/emoji/pack?name=:name`
420 ### Get pack.json for the pack
423 * Authentication: not required
425 * `page`: page number for files (default 1)
426 * `page_size`: page size for files (default 30)
427 * Response: JSON, pack json with `files`, `files_count` and `pack` keys with 200 status or 404 if the pack does not exist.
432 "files_count": 0, // emoji count in pack
437 ## `POST /api/v1/pleroma/emoji/pack?name=:name`
439 ### Creates an empty pack
442 * Authentication: required (admin)
445 * Response: JSON, "ok" and 200 status or 409 if the pack with that name already exists
447 ## `PATCH /api/v1/pleroma/emoji/pack?name=:name`
449 ### Updates (replaces) pack metadata
452 * Authentication: required (admin)
455 * `metadata`: metadata to replace the old one
456 * `license`: Pack license
457 * `homepage`: Pack home page url
458 * `description`: Pack description
459 * `fallback-src`: Fallback url to download pack from
460 * `fallback-src-sha256`: SHA256 encoded for fallback pack archive
461 * `share-files`: is pack allowed for sharing (boolean)
462 * Response: JSON, updated "metadata" section of the pack and 200 status or 400 if there was a
463 problem with the new metadata (the error is specified in the "error" part of the response JSON)
465 ## `DELETE /api/v1/pleroma/emoji/pack?name=:name`
467 ### Delete a custom emoji pack
470 * Authentication: required (admin)
473 * Response: JSON, "ok" and 200 status or 500 if there was an error deleting the pack
475 ## `GET /api/v1/pleroma/emoji/packs/import`
477 ### Imports packs from filesystem
480 * Authentication: required (admin)
482 * Response: JSON, returns a list of imported packs.
484 ## `GET /api/v1/pleroma/emoji/packs/remote`
486 ### Make request to another instance for packs list
489 * Authentication: required (admin)
491 * `url`: url of the instance to get packs from
492 * `page`: page number for packs (default 1)
493 * `page_size`: page size for packs (default 50)
494 * Response: JSON with the pack list, hashmap with pack name and pack contents
496 ## `POST /api/v1/pleroma/emoji/packs/download`
498 ### Download pack from another instance
501 * Authentication: required (admin)
503 * `url`: url of the instance to download from
504 * `name`: pack to download from that instance
505 * `as`: (*optional*) name how to save pack
506 * Response: JSON, "ok" with 200 status if the pack was downloaded, or 500 if there were
507 errors downloading the pack
509 ## `POST /api/v1/pleroma/emoji/packs/files?name=:name`
511 ### Add new file to the pack
514 * Authentication: required (admin)
517 * `file`: file needs to be uploaded with the multipart request or link to remote file.
518 * `shortcode`: (*optional*) shortcode for new emoji, must be unique for all emoji. If not sended, shortcode will be taken from original filename.
519 * `filename`: (*optional*) new emoji file name. If not specified will be taken from original filename.
520 * Response: JSON, list of files for updated pack (hashmap -> shortcode => filename) with status 200, either error status with error message.
522 ## `PATCH /api/v1/pleroma/emoji/packs/files?name=:name`
524 ### Update emoji file from pack
527 * Authentication: required (admin)
530 * `shortcode`: emoji file shortcode
531 * `new_shortcode`: new emoji file shortcode
532 * `new_filename`: new filename for emoji file
533 * `force`: (*optional*) with true value to overwrite existing emoji with new shortcode
534 * Response: JSON, list with updated files for updated pack (hashmap -> shortcode => filename) with status 200, either error status with error message.
536 ## `DELETE /api/v1/pleroma/emoji/packs/files?name=:name`
538 ### Delete emoji file from pack
541 * Authentication: required (admin)
544 * `shortcode`: emoji file shortcode
545 * Response: JSON, list with updated files for updated pack (hashmap -> shortcode => filename) with status 200, either error status with error message.
547 ## `GET /api/v1/pleroma/emoji/packs`
549 ### Lists local custom emoji packs
552 * Authentication: not required
554 * `page`: page number for packs (default 1)
555 * `page_size`: page size for packs (default 50)
556 * Response: `packs` key with JSON hashmap of pack name to pack contents and `count` key for count of packs.
561 "pack_name": {...}, // pack contents
564 "count": 0 // packs count
568 ## `GET /api/v1/pleroma/emoji/packs/archive?name=:name`
570 ### Requests a local pack archive from the instance
573 * Authentication: not required
576 * Response: the archive of the pack with a 200 status code, 403 if the pack is not set as shared,
577 404 if the pack does not exist
579 ## `GET /api/v1/pleroma/accounts/:id/scrobbles`
580 ### Requests a list of current and recent Listen activities for an account
582 * Authentication: not required
584 * Response: An array of media metadata entities.
591 "title": "Some Title",
592 "artist": "Some Artist",
593 "album": "Some Album",
595 "created_at": "2019-09-28T12:40:45.000Z"
600 ## `POST /api/v1/pleroma/scrobble`
601 ### Creates a new Listen activity for an account
603 * Authentication: required
605 * `title`: the title of the media playing
606 * `album`: the album of the media playing [optional]
607 * `artist`: the artist of the media playing [optional]
608 * `length`: the length of the media playing [optional]
609 * Response: the newly created media metadata entity representing the Listen activity
613 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.
615 ## `PUT /api/v1/pleroma/statuses/:id/reactions/:emoji`
616 ### React to a post with a unicode emoji
618 * Authentication: required
619 * Params: `emoji`: A unicode RGI emoji or a regional indicator
620 * Response: JSON, the status.
622 ## `DELETE /api/v1/pleroma/statuses/:id/reactions/:emoji`
623 ### Remove a reaction to a post with a unicode emoji
625 * Authentication: required
626 * Params: `emoji`: A unicode RGI emoji or a regional indicator
627 * Response: JSON, the status.
629 ## `GET /api/v1/pleroma/statuses/:id/reactions`
630 ### Get an object of emoji to account mappings with accounts that reacted to the post
632 * Authentication: optional
634 * 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.
638 {"name": "😀", "count": 2, "me": true, "accounts": [{"id" => "xyz.."...}, {"id" => "zyx..."}]},
639 {"name": "☕", "count": 1, "me": false, "accounts": [{"id" => "abc..."}]}
643 ## `GET /api/v1/pleroma/statuses/:id/reactions/:emoji`
644 ### Get an object of emoji to account mappings with accounts that reacted to the post for a specific emoji
646 * Authentication: optional
648 * Response: JSON, a list of emoji/account list tuples
652 {"name": "😀", "count": 2, "me": true, "accounts": [{"id" => "xyz.."...}, {"id" => "zyx..."}]}
656 ## `POST /api/v1/pleroma/backups`
657 ### Create a user backup archive
660 * Authentication: required
667 "content_type": "application/zip",
669 "inserted_at": "2020-09-10T16:18:03.000Z",
671 "url": "https://example.com/media/backups/archive-foobar-20200910T161803-QUhx6VYDRQ2wfV0SdA2Pfj_2CLM_ATUlw-D5l5TJf4Q.zip"
675 ## `GET /api/v1/pleroma/backups`
676 ### Lists user backups
679 * Authentication: not required
686 "content_type": "application/zip",
688 "inserted_at": "2020-09-10T16:18:03.000Z",
690 "url": "https://example.com/media/backups/archive-foobar-20200910T161803-QUhx6VYDRQ2wfV0SdA2Pfj_2CLM_ATUlw-D5l5TJf4Q.zip"
694 ## `GET /api/oauth_tokens`
695 ### Retrieve a list of active sessions for the user
697 * Authentication: required
705 "app_name": "Pleroma FE",
707 "valid_until": "2121-11-24T15:51:08.234234"
710 "app_name": "Patron",
712 "valid_until": "2121-10-26T18:09:59.857150"
715 "app_name": "Soapbox FE",
717 "valid_until": "2121-12-25T16:52:39.692877"
722 ## `DELETE /api/oauth_tokens/:id`
723 ### Revoke a user session by its ID
725 * Authentication: required
727 * Response: HTTP 200 on success, 500 on error
729 ## `/api/v1/pleroma/settings/:app`
730 ### Gets settings for some application
732 * Authentication: `read:accounts`
734 * Response: JSON. The settings for that application, or empty object if there is none.
738 "some key": "some value"
742 ### Updates settings for some application
744 * Authentication: `write:accounts`
745 * Request body: JSON object. The object will be merged recursively with old settings. If some field is set to null, it is removed.
749 "some key": "some value",
750 "key to remove": null,
752 "some key": "some value",
753 "key to remove": null
757 * Response: JSON. Updated (merged) settings for that application.
761 "some key": "some value",
763 "some key": "some value",