doc/API-Mastodon.md

   1 # Mastodon API
   2
   3 * [Home](help)
   4   * [Using the APIs](help/api)
   5
   6 ## Overview
   7
   8 Friendica provides the following endpoints defined in [the official Mastodon API reference](https://docs.joinmastodon.org/api/).
   9
  10 Authentication is the same as described in [Using the APIs](help/api#Authentication).
  11
  12 ## Clients
  13
  14 ### Supported apps
  15
  16 For supported apps please have a look at the [FAQ](help/FAQ#clients)
  17
  18 ### Unsupported apps
  19
  20 #### Android
  21
  22 - [Fedilab](https://framagit.org/tom79/fedilab) Automatically uses the legacy API, see issue: https://framagit.org/tom79/fedilab/-/issues/520
  23 - [Mammut](https://github.com/jamiesanson/Mammut) There are problems with the token request, see issue https://github.com/jamiesanson/Mammut/issues/19
  24
  25 #### iOS
  26
  27 - [Mast](https://github.com/Beesitech/Mast) Doesn't accept the entered instance name. Claims that it is invalid (Message is: "Not a valid instance (may be closed or dead)")
  28 - [Toot!](https://apps.apple.com/app/toot/id1229021451)
  29
  30 ## Entities
  31
  32 These endpoints use the [Mastodon API entities](https://docs.joinmastodon.org/entities/). With some additional extensions listed below.
  33
  34 ### Notification Entities
  35 Extensions to the [Mastodon Notification Entities](https://docs.joinmastodon.org/entities/Notification/)
  36 * `dismissed`: whether the object has been dismissed or not
  37
  38 ### Status Entities
  39 Extensions to the [Mastodon Status Entities](https://docs.joinmastodon.org/entities/Status/)
  40 * `in_reply_to_status`: A fully populated Mastodon Status entity for the replied to status or null it is a post rather than a response
  41 * `friendica`: Friendica specific properties of a status including:
  42   * `title`: The Friendica title for a post, or empty if the status is a comment
  43   * `dislikes_count`: The number of dislikes that a status has accumulated according to the server.
  44
  45 Example:
  46 ```json
  47 {
  48   "id": "358",
  49   "created_at": "2023-02-23T02:45:46.000Z",
  50   "in_reply_to_id": "356",
  51   "in_reply_to_status": {
  52         "id": "356",
  53         "created_at": "2023-02-23T02:45:35.000Z",
  54         "in_reply_to_id": null,
  55         "in_reply_to_status": null,
  56         "in_reply_to_account_id": null,
  57         ...
  58         "content": "A post from testuser1",
  59         ...
  60         "account": {
  61           "id": "6",
  62           "username": "testuser1",
  63           "acct": "testuser1",
  64           "display_name": "testuser1",
  65           ...
  66         },
  67         ...
  68         "friendica": {
  69           "title": "",
  70           "dislikes_count": 0
  71         }
  72   },
  73   "in_reply_to_account_id": "6",
  74   ...
  75   "replies_count": 0,
  76   "reblogs_count": 0,
  77   "favourites_count": 0,
  78   ...
  79   "content": "A reply from testuser2",
  80   ...
  81   "account": {
  82         "id": "8",
  83         "username": "testuser2",
  84         "acct": "testuser2",
  85         "display_name": "testuser2",
  86         ...
  87   },
  88   ...
  89   "friendica": {
  90         "title": "",
  91         "dislikes_count": 0
  92   }
  93 }
  94 ```
  95
  96 ## Implemented endpoints
  97
  98 - [`GET /api/v1/accounts/:id`](https://docs.joinmastodon.org/methods/accounts/#retrieve-information)
  99 - [`POST /api/v1/accounts/:id/block`](https://docs.joinmastodon.org/methods/accounts/)
 100 - [`POST /api/v1/accounts/:id/follow`](https://docs.joinmastodon.org/methods/accounts/)
 101 - [`GET /api/v1/accounts/:id/followers`](https://docs.joinmastodon.org/methods/accounts/)
 102 - [`GET /api/v1/accounts/:id/following`](https://docs.joinmastodon.org/methods/accounts/)
 103 - [`GET /api/v1/accounts/:id/lists`](https://docs.joinmastodon.org/methods/accounts/)
 104 - [`POST /api/v1/accounts/:id/mute`](https://docs.joinmastodon.org/methods/accounts/)
 105 - [`POST /api/v1/accounts/:id/note`](https://docs.joinmastodon.org/methods/accounts/)
 106 - [`GET /api/v1/accounts/:id/statuses`](https://docs.joinmastodon.org/methods/accounts/)
 107 - [`POST /api/v1/accounts/:id/unfollow`](https://docs.joinmastodon.org/methods/accounts/)
 108 - [`POST /api/v1/accounts/:id/unblock`](https://docs.joinmastodon.org/methods/accounts/)
 109 - [`POST /api/v1/accounts/:id/unmute`](https://docs.joinmastodon.org/methods/accounts/)
 110 - [`GET /api/v1/accounts/relationships`](https://docs.joinmastodon.org/methods/accounts/)
 111 - [`GET /api/v1/accounts/search`](https://docs.joinmastodon.org/methods/accounts)
 112 - [`PATCH /api/v1/accounts/update_credentials`](https://docs.joinmastodon.org/methods/accounts/#update_credentials)
 113 - [`GET /api/v1/accounts/verify_credentials`](https://docs.joinmastodon.org/methods/accounts)
 114 - [`POST /api/v1/apps`](https://docs.joinmastodon.org/methods/apps/)
 115 - [`GET /api/v1/apps/verify_credentials`](https://docs.joinmastodon.org/methods/apps/)
 116 - [`GET /api/v1/blocks`](https://docs.joinmastodon.org/methods/accounts/blocks/)
 117 - [`GET /api/v1/bookmarks`](https://docs.joinmastodon.org/methods/accounts/bookmarks/)
 118 - [`GET /api/v1/conversations`](https://docs.joinmastodon.org/methods/timelines/conversations/)
 119 - [`DELETE /api/v1/conversations/:id`](https://docs.joinmastodon.org/methods/timelines/conversations/)
 120 - [`POST /api/v1/conversations/:id/read`](https://docs.joinmastodon.org/methods/timelines/conversations/)
 121 - [`GET /api/v1/custom_emojis`](https://docs.joinmastodon.org/methods/instance/custom_emojis/)
 122     - Doesn't return unicode emojis since they aren't using an image URL
 123
 124
 125 - [`GET /api/v1/directory`](https://docs.joinmastodon.org/methods/instance/directory/)
 126 - [`GET /api/v1/favourites`](https://docs.joinmastodon.org/methods/accounts/favourites/)
 127 - [`GET /api/v1/follow_requests`](https://docs.joinmastodon.org/methods/accounts/follow_requests#pending-follows)
 128     - Returned IDs are specific to follow requests
 129 - [`POST /api/v1/follow_requests/:id/authorize`](https://docs.joinmastodon.org/methods/accounts/follow_requests#accept-follow)
 130     - `:id` is a follow request ID, not a regular account id
 131 - [`POST /api/v1/follow_requests/:id/reject`](https://docs.joinmastodon.org/methods/accounts/follow_requests#reject-follow)
 132     - `:id` is a follow request ID, not a regular account id
 133 - `POST /api/v1/follow_requests/:id/ignore`
 134     - Friendica-specific, hides the follow request from the list and prevents the remote contact from retrying.
 135     - `:id` is a follow request ID, not a regular account id
 136     - Returns a [Relationship](https://docs.joinmastodon.org/entities/relationship) object.
 137
 138 - [`GET /api/v1/followed_tags`](https://docs.joinmastodon.org/methods/followed_tags/)
 139 - [`GET /api/v1/instance`](https://docs.joinmastodon.org/methods/instance/#v1)
 140 - `GET /api/v1/instance/rules` Undocumented, returns Terms of Service
 141 - [`GET /api/v1/instance/peers`](https://docs.joinmastodon.org/methods/instance#list-of-connected-domains)
 142 - [`GET /api/v1/lists`](https://docs.joinmastodon.org/methods/timelines/lists/)
 143 - [`POST /api/v1/lists`](https://docs.joinmastodon.org/methods/timelines/lists/)
 144 - [`GET /api/v1/lists/:id`](https://docs.joinmastodon.org/methods/timelines/lists/)
 145 - [`PUT /api/v1/lists/:id`](https://docs.joinmastodon.org/methods/timelines/lists/)
 146 - [`DELETE /api/v1/lists/:id`](https://docs.joinmastodon.org/methods/timelines/lists/)
 147 - [`GET /api/v1/lists/:id/accounts`](https://docs.joinmastodon.org/methods/timelines/lists/)
 148 - [`POST /api/v1/lists/:id/accounts`](https://docs.joinmastodon.org/methods/timelines/lists/)
 149 - [`DELETE /api/v1/lists/:id/accounts`](https://docs.joinmastodon.org/methods/timelines/lists/)
 150 - [`POST /api/v1/markers`](https://docs.joinmastodon.org/methods/timelines/markers/)
 151 - [`GET /api/v1/markers`](https://docs.joinmastodon.org/methods/timelines/markers/)
 152 - [`POST /api/v1/media`](https://docs.joinmastodon.org/methods/statuses/media/)
 153 - [`GET /api/v1/media/:id`](https://docs.joinmastodon.org/methods/statuses/media/)
 154 - [`PUT /api/v1/media/:id`](https://docs.joinmastodon.org/methods/statuses/media/)
 155 - [`GET /api/v1/mutes`](https://docs.joinmastodon.org/methods/accounts/mutes/)
 156 - [`GET /api/v1/notifications`](https://docs.joinmastodon.org/methods/notifications/)
 157         - Additional field `include_all` to return read and unread statuses, defaults to `false`
 158     - Additional field `summary` returns a count of all of the statuses that match the type filter
 159     - Additional field `with_muted` Pleroma extension to return notifications from muted users, defaults to `false`
 160     - Does not support the `type` field, which is the mirror image of the supported `exclude_types` field
 161 - [`GET /api/v1/notifications/:id`](https://docs.joinmastodon.org/methods/notifications/)
 162 - [`POST /api/v1/notifications/clear`](https://docs.joinmastodon.org/methods/notifications/)
 163 - [`POST /api/v1/notifications/:id/dismiss`](https://docs.joinmastodon.org/methods/notifications/)
 164 - [`GET /api/v1/polls/:id`](https://docs.joinmastodon.org/methods/statuses/polls/)
 165 - [`GET /api/v1/preferences`](https://docs.joinmastodon.org/methods/accounts/preferences/)
 166 - [`DELETE /api/v1/push/subscription`](https://docs.joinmastodon.org/methods/notifications/push/)
 167 - [`GET /api/v1/push/subscription`](https://docs.joinmastodon.org/methods/notifications/push/)
 168 - [`PUSH /api/v1/push/subscription`](https://docs.joinmastodon.org/methods/notifications/push/)
 169 - [`PUT /api/v1/push/subscription`](https://docs.joinmastodon.org/methods/notifications/push/)
 170 - [`POST /api/v1/reports`](https://docs.joinmastodon.org/methods/accounts/reports/)
 171 - [`GET /api/v1/scheduled_statuses`](https://docs.joinmastodon.org/methods/statuses/scheduled_statuses/)
 172 - [`DELETE /api/v1/scheduled_statuses/:id`](https://docs.joinmastodon.org/methods/statuses/scheduled_statuses/)
 173 - [`GET /api/v1/scheduled_statuses/:id`](https://docs.joinmastodon.org/methods/statuses/scheduled_statuses/)
 174 - [`GET /api/v1/search`](https://docs.joinmastodon.org/methods/search/)
 175 - [`POST /api/v1/statuses`](https://docs.joinmastodon.org/methods/statuses/#create)
 176     - Additionally to the static values `public`, `unlisted` and `private`, the `visibility` parameter can contain a numeric value with a group id.
 177     - Additional field `quote_id` for the post that is being quote reshared
 178     - Additional fields `friendica` for Friendica specific parameters:
 179        - `title`: Explicitly sets the title for a post status, ignored if used on a comment status. For post statuses the legacy behavior is to use any "spoiler text" as the title if it is provided. If both the title and spoiler text are provided for a post status then they will each be used for their respective roles. If no title is provided then the legacy behavior will persist. If you want to create a post with no title but spoiler text then explicitly set the title but set it to an empty string `""`.
 180 - [`GET /api/v1/statuses/:id`](https://docs.joinmastodon.org/methods/statuses/#get)
 181 - [`DELETE /api/v1/statuses/:id`](https://docs.joinmastodon.org/methods/statuses/#delete)
 182 - [`GET /api/v1/statuses/:id/context`](https://docs.joinmastodon.org/methods/statuses/#context)
 183     - Additional support for paging using `min_id`, `max_id`, `since_id` parameters
 184     - Additional support for previous/next Link Headers to support paging
 185     - Additional flag `show_all` to allow including posts from blocked and ignored/muted users, defaults to `false`
 186 - [`GET /api/v1/statuses/:id/reblogged_by`](https://docs.joinmastodon.org/methods/statuses/#reblogged_by)
 187 - [`GET /api/v1/statuses/:id/favourited_by`](https://docs.joinmastodon.org/methods/statuses/#favourited_by)
 188 - [`POST /api/v1/statuses/:id/favourite`](https://docs.joinmastodon.org/methods/statuses/#favourite)
 189 - [`POST /api/v1/statuses/:id/unfavourite`](https://docs.joinmastodon.org/methods/statuses/#unfavourite)
 190 - [`POST /api/v1/statuses/:id/reblog`](https://docs.joinmastodon.org/methods/statuses/#boost)
 191 - [`POST /api/v1/statuses/:id/unreblog`](https://docs.joinmastodon.org/methods/statuses/#unreblog)
 192 - [`POST /api/v1/statuses/:id/bookmark`](https://docs.joinmastodon.org/methods/statuses/#bookmark)
 193 - [`POST /api/v1/statuses/:id/unbookmark`](https://docs.joinmastodon.org/methods/statuses/#unbookmark)
 194 - [`POST /api/v1/statuses/:id/mute`](https://docs.joinmastodon.org/methods/statuses/#mute)
 195 - [`POST /api/v1/statuses/:id/unmute`](https://docs.joinmastodon.org/methods/statuses/#unmute)
 196 - [`POST /api/v1/statuses/:id/pin`](https://docs.joinmastodon.org/methods/statuses/#pin)
 197 - [`POST /api/v1/statuses/:id/unpin`](https://docs.joinmastodon.org/methods/statuses/#unpin)
 198 - [`POST /api/v1/statuses/:id`](https://docs.joinmastodon.org/methods/statuses/#edit)
 199 - [`GET /api/v1/statuses/:id/source`](https://docs.joinmastodon.org/methods/statuses/#source)
 200 - [`GET /api/v1/statuses/:id/card`](https://docs.joinmastodon.org/methods/statuses/#card)
 201 - [`GET /api/v1/suggestions`](https://docs.joinmastodon.org/methods/accounts/suggestions/)
 202 - [`GET /api/v1/tags/:id`](https://docs.joinmastodon.org/methods/tags/#get)
 203 - [`GET /api/v1/tags/:id/follow`](https://docs.joinmastodon.org/methods/tags/#follow)
 204 - [`GET /api/v1/tags/:id/unfollow`](https://docs.joinmastodon.org/methods/tags/#unfollow)
 205 - [`GET /api/v1/timelines/direct`](https://docs.joinmastodon.org/methods/timelines/)
 206 - [`GET /api/v1/timelines/home`](https://docs.joinmastodon.org/methods/timelines/)
 207 - [`GET /api/v1/timelines/list/:id`](https://docs.joinmastodon.org/methods/timelines/)
 208 - [`GET /api/v1/timelines/public`](https://docs.joinmastodon.org/methods/timelines/)
 209 - [`GET /api/v1/timelines/tag/:hashtag`](https://docs.joinmastodon.org/methods/timelines/)
 210 - [`GET /api/v1/trends`](https://docs.joinmastodon.org/methods/instance/trends/)
 211 - [`GET /api/v1/trends/links`](https://github.com/mastodon/mastodon/pull/16917)
 212 - [`GET /api/v1/trends/statuses`](https://docs.joinmastodon.org/methods/trends/#statuses)
 213 - [`GET /api/v1/trends/tags`](https://docs.joinmastodon.org/methods/trends/#tags)
 214         - Additional field `friendica_local` to return local trending tags instead of global tags, defaults to `false`
 215 - [`GET /api/v2/instance`](https://docs.joinmastodon.org/methods/instance/#v2)
 216 - [`GET /api/v2/search`](https://docs.joinmastodon.org/methods/search/)
 217
 218
 219 ## Currently unimplemented endpoints
 220
 221 These emdpoints are planned to be implemented somewhere in the future.
 222
 223 - [`POST /api/v1/accounts/:id/remove_from_followers`](https://github.com/mastodon/mastodon/pull/16864)
 224 - [`GET /api/v1/accounts/familiar_followers`](https://github.com/mastodon/mastodon/pull/17700)
 225 - [`GET /api/v1/accounts/lookup`](https://github.com/mastodon/mastodon/pull/15740)
 226 - [`POST /api/v1/polls/:id/votes`](https://docs.joinmastodon.org/methods/statuses/polls/)
 227 - [`GET /api/v1/featured_tags`](https://docs.joinmastodon.org/methods/accounts/featured_tags/)
 228 - [`POST /api/v1/featured_tags`](https://docs.joinmastodon.org/methods/accounts/featured_tags/)
 229 - [`DELETE /api/v1/featured_tags/:id`](https://docs.joinmastodon.org/methods/accounts/featured_tags/)
 230
 231 ## Dummy endpoints
 232
 233 These endpoints are returning empty data to avoid error messages when using third party clients.
 234 They refer to features that don't exist in Friendica yet.
 235
 236 - [`GET /api/v1/accounts/:id/identity_proofs`](https://docs.joinmastodon.org/methods/accounts/)
 237 - [`GET /api/v1/announcements`](https://docs.joinmastodon.org/methods/announcements/)
 238 - [`GET /api/v1/endorsements`](https://docs.joinmastodon.org/methods/accounts/endorsements/)
 239 - [`GET /api/v1/filters`](https://docs.joinmastodon.org/methods/accounts/filters/)
 240
 241 ## Non supportable endpoints
 242
 243 These endpoints won't be implemented at the moment.
 244 They refer to features or data that don't exist in Friendica yet.
 245
 246 - `POST /api/meta` Misskey API endpoint.
 247 - [`POST /api/v1/accounts`](https://docs.joinmastodon.org/methods/accounts/)
 248 - [`GET /api/v1/accounts/:id/featured_tags`](https://docs.joinmastodon.org/methods/accounts/)
 249 - [`POST /api/v1/accounts/:id/pin`](https://docs.joinmastodon.org/methods/accounts/)
 250 - [`POST /api/v1/accounts/:id/unpin`](https://docs.joinmastodon.org/methods/accounts/)
 251 - [`GET /api/v1/admin/accounts`](https://docs.joinmastodon.org/methods/admin/)
 252 - [`GET /api/v1/admin/accounts/:id`](https://docs.joinmastodon.org/methods/admin/)
 253 - [`POST /api/v1/admin/accounts/:id/{action}`](https://docs.joinmastodon.org/methods/admin/)
 254 - [`GET /api/v1/admin/reports`](https://docs.joinmastodon.org/methods/admin/)
 255 - [`GET /api/v1/admin/reports/:id`](https://docs.joinmastodon.org/methods/admin/)
 256 - [`POST /api/v1/admin/reports/:id/{action}`](https://docs.joinmastodon.org/methods/admin/)
 257 - [`POST /api/v1/announcements/:id/dismiss`](https://docs.joinmastodon.org/methods/announcements/)
 258 - [`PUT /api/v1/announcements/:id/reactions/{name}`](https://docs.joinmastodon.org/methods/announcements/)
 259 - [`DELETE /api/v1/announcements/:id/reactions/{name}`](https://docs.joinmastodon.org/methods/announcements/)
 260 - [`GET /api/v1/domain_blocks`](https://docs.joinmastodon.org/methods/accounts/domain_blocks/)
 261 - [`POST /api/v1/domain_blocks`](https://docs.joinmastodon.org/methods/accounts/domain_blocks/)
 262 - [`DELETE /api/v1/domain_blocks`](https://docs.joinmastodon.org/methods/accounts/domain_blocks/)
 263 - [`DELETE /api/v1/emails/confirmations`](https://github.com/mastodon/mastodon/pull/15816)
 264 - [`GET /api/v1/featured_tags/suggestions`](https://docs.joinmastodon.org/methods/accounts/featured_tags/)
 265 - [`GET /api/v1/filters/:id`](https://docs.joinmastodon.org/methods/accounts/filters/)
 266 - [`POST /api/v1/filters/:id`](https://docs.joinmastodon.org/methods/accounts/filters/)
 267 - [`PUT /api/v1/filters/:id`](https://docs.joinmastodon.org/methods/accounts/filters/)
 268 - [`DELETE /api/v1/filters/:id`](https://docs.joinmastodon.org/methods/accounts/filters/)
 269 - [`GET /api/v1/instance/activity`](https://docs.joinmastodon.org/methods/instance#weekly-activity)
 270 - [`POST /api/v1/markers`](https://docs.joinmastodon.org/methods/timelines/markers/)
 271 - [`PUT /api/v1/scheduled_statuses/:id`](https://docs.joinmastodon.org/methods/statuses/scheduled_statuses/)
 272 - [`GET /api/v1/statuses/{id:\d+}/history`](https://github.com/mastodon/mastodon/pull/16697)
 273 - [`GET /api/v1/streaming`](https://docs.joinmastodon.org/methods/timelines/streaming/)
 274 - [`DELETE /api/v1/suggestions/:id`](https://docs.joinmastodon.org/methods/accounts/suggestions/)