git.squeep.com Git - akkoma/blob - 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 sortable strings
   8
   9 ## Attachment cap
  10
  11 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.
  12
  13 ## Timelines
  14
  15 Adding the parameter `with_muted=true` to the timeline queries will also return activities by muted (not by blocked!) users.
  16 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`.
  17
  18 ## Statuses
  19
  20 - `visibility`: has an additional possible value `list`
  21
  22 Has these additional fields under the `pleroma` object:
  23
  24 - `local`: true if the post was made on the local instance
  25 - `conversation_id`: the ID of the AP context the status is associated with (if any)
  26 - `direct_conversation_id`: the ID of the Mastodon direct message conversation the status is associated with (if any)
  27 - `in_reply_to_account_acct`: the `acct` property of User entity for replied user (if any)
  28 - `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`
  29 - `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`
  30 - `expires_at`: a datetime (iso8601) that states when the post will expire (be deleted automatically), or empty if the post won't expire
  31 - `thread_muted`: true if the thread the post belongs to is muted
  32
  33 ## Attachments
  34
  35 Has these additional fields under the `pleroma` object:
  36
  37 - `mime_type`: mime type of the attachment.
  38
  39 ## Accounts
  40
  41 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.
  42
  43 - `/api/v1/accounts/:id`
  44 - `/api/v1/accounts/:id/statuses`
  45
  46 Has these additional fields under the `pleroma` object:
  47
  48 - `tags`: Lists an array of tags for the user
  49 - `relationship{}`: Includes fields as documented for Mastodon API https://docs.joinmastodon.org/entities/relationship/
  50 - `is_moderator`: boolean, nullable,  true if user is a moderator
  51 - `is_admin`: boolean, nullable, true if user is an admin
  52 - `confirmation_pending`: boolean, true if a new user account is waiting on email confirmation to be activated
  53 - `hide_followers`: boolean, true when the user has follower hiding enabled
  54 - `hide_follows`: boolean, true when the user has follow hiding enabled
  55 - `hide_followers_count`: boolean, true when the user has follower stat hiding enabled
  56 - `hide_follows_count`: boolean, true when the user has follow stat hiding enabled
  57 - `settings_store`: A generic map of settings for frontends. Opaque to the backend. Only returned in `verify_credentials` and `update_credentials`
  58 - `chat_token`: The token needed for Pleroma chat. Only returned in `verify_credentials`
  59 - `deactivated`: boolean, true when the user is deactivated
  60 - `allow_following_move`: boolean, true when the user allows automatically follow moved following accounts
  61 - `unread_conversation_count`: The count of unread conversations. Only returned to the account owner.
  62
  63 ### Source
  64
  65 Has these additional fields under the `pleroma` object:
  66
  67 - `show_role`: boolean, nullable, true when the user wants his role (e.g admin, moderator) to be shown
  68 - `no_rich_text` - boolean, nullable, true when html tags are stripped from all statuses requested from the API
  69 - `discoverable`: boolean, true when the user allows discovery of the account in search results and other services.
  70 - `actor_type`: string, the type of this account.
  71
  72 ## Conversations
  73
  74 Has an additional field under the `pleroma` object:
  75
  76 - `recipients`: The list of the recipients of this Conversation. These will be addressed when replying to this conversation.
  77
  78 ## GET `/api/v1/conversations`
  79
  80 Accepts additional parameters:
  81
  82 - `recipients`: Only return conversations with the given recipients (a list of user ids). Usage example: `GET /api/v1/conversations?recipients[]=1&recipients[]=2`
  83
  84 ## Account Search
  85
  86 Behavior has changed:
  87
  88 - `/api/v1/accounts/search`: Does not require authentication
  89
  90
  91 ## Notifications
  92
  93 Has these additional fields under the `pleroma` object:
  94
  95 - `is_seen`: true if the notification was read by the user
  96
  97 ### Move Notification
  98
  99 The `type` value is `move`. Has an additional field:
 100
 101 - `target`: new account
 102
 103 ## GET `/api/v1/notifications`
 104
 105 Accepts additional parameters:
 106
 107 - `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`.
 108 - `with_move`: boolean, when set to `true` will include Move notifications. `false` by default.
 109
 110 ## POST `/api/v1/statuses`
 111
 112 Additional parameters can be added to the JSON body/Form data:
 113
 114 - `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.
 115 - `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.
 116 - `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.
 117 - `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`.
 118 - `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.
 119 - `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`.
 120
 121 ## GET `/api/v1/statuses`
 122
 123 An endpoint to get multiple statuses by IDs.
 124
 125 Required parameters:
 126
 127 - `ids`: array of activity ids
 128
 129 Usage example: `GET /api/v1/statuses/?ids[]=1&ids[]=2`.
 130
 131 Returns: array of Status.
 132
 133 The maximum number of statuses is limited to 100 per request.
 134
 135 ## PATCH `/api/v1/update_credentials`
 136
 137 Additional parameters can be added to the JSON body/Form data:
 138
 139 - `no_rich_text` - if true, html tags are stripped from all statuses requested from the API
 140 - `hide_followers` - if true, user's followers will be hidden
 141 - `hide_follows` - if true, user's follows will be hidden
 142 - `hide_followers_count` - if true, user's follower count will be hidden
 143 - `hide_follows_count` - if true, user's follow count will be hidden
 144 - `hide_favorites` - if true, user's favorites timeline will be hidden
 145 - `show_role` - if true, user's role (e.g admin, moderator) will be exposed to anyone in the API
 146 - `default_scope` - the scope returned under `privacy` key in Source subentity
 147 - `pleroma_settings_store` - Opaque user settings to be saved on the backend.
 148 - `skip_thread_containment` - if true, skip filtering out broken threads
 149 - `allow_following_move` - if true, allows automatically follow moved following accounts
 150 - `pleroma_background_image` - sets the background image of the user.
 151 - `discoverable` - if true, discovery of this account in search results and other services is allowed.
 152 - `actor_type` - the type of this account.
 153
 154 ### Pleroma Settings Store
 155 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.
 156
 157 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.
 158
 159 This information is returned in the `verify_credentials` endpoint.
 160
 161 ## Authentication
 162
 163 *Pleroma supports refreshing tokens.
 164
 165 `POST /oauth/token`
 166 Post here request with grant_type=refresh_token to obtain new access token. Returns an access token.
 167
 168 ## Account Registration
 169 `POST /api/v1/accounts`
 170
 171 Has theses additionnal parameters (which are the same as in Pleroma-API):
 172     * `fullname`: optional
 173     * `bio`: optional
 174     * `captcha_solution`: optional, contains provider-specific captcha solution,
 175     * `captcha_token`: optional, contains provider-specific captcha token
 176     * `token`: invite token required when the registerations aren't public.