logo

pleroma

My custom branche(s) on git.pleroma.social/pleroma/pleroma

Differences-in-MastodonAPI-Responses.md (1828B)


      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 
     17 ## Statuses
     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 conversation the status is associated with (if any)
     23 
     24 ## Attachments
     25 
     26 Has these additional fields under the `pleroma` object:
     27 
     28 - `mime_type`: mime type of the attachment.
     29 
     30 ## Accounts
     31 
     32 - `/api/v1/accounts/:id`: The `id` parameter can also be the `nickname` of the user. This only works in this endpoint, not the deeper nested ones for following etc.
     33 
     34 Has these additional fields under the `pleroma` object:
     35 
     36 - `tags`: Lists an array of tags for the user
     37 - `relationship{}`: Includes fields as documented for Mastodon API https://docs.joinmastodon.org/api/entities/#relationship
     38 - `is_moderator`: boolean, true if user is a moderator
     39 - `is_admin`: boolean, true if user is an admin
     40 - `confirmation_pending`: boolean, true if a new user account is waiting on email confirmation to be activated
     41 
     42 ## Notifications
     43 
     44 Has these additional fields under the `pleroma` object:
     45 
     46 - `is_seen`: true if the notification was read by the user