2019-12-09 22:36:52 -05:00
# Mastodon API
* [Home ](help )
* [Using the APIs ](help/api )
## Overview
Friendica provides the following endpoints defined in [the official Mastodon API reference ](https://docs.joinmastodon.org/api/ ).
Authentication is the same as described in [Using the APIs ](help/api#Authentication ).
2021-05-13 07:26:56 -04:00
## Clients
2021-06-10 02:26:34 -04:00
### Supported apps
2021-06-14 12:30:31 -04:00
For supported apps please have a look at the [FAQ ](help/FAQ#clients )
2021-06-11 00:26:24 -04:00
2021-06-10 02:26:34 -04:00
### Unsupported apps
2021-05-13 07:26:56 -04:00
2021-06-10 02:26:34 -04:00
#### Android
2021-06-14 12:30:31 -04:00
2021-05-13 07:26:56 -04:00
- [Fedilab ](https://framagit.org/tom79/fedilab ) Automatically uses the legacy API, see issue: https://framagit.org/tom79/fedilab/-/issues/520
2021-05-14 17:51:32 -04:00
- [Mammut ](https://github.com/jamiesanson/Mammut ) There are problems with the token request, see issue https://github.com/jamiesanson/Mammut/issues/19
2021-06-10 02:26:34 -04:00
#### iOS
2021-06-14 12:30:31 -04:00
2021-06-09 01:16:27 -04:00
- [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)")
- [Toot! ](https://apps.apple.com/app/toot/id1229021451 )
2021-06-10 02:26:34 -04:00
2019-12-09 22:36:52 -05:00
## Entities
2019-12-21 08:24:24 -05:00
These endpoints use the [Mastodon API entities ](https://docs.joinmastodon.org/entities/ ).
2019-12-09 22:36:52 -05:00
## Implemented endpoints
2021-05-09 05:35:51 -04:00
- [`GET /api/v1/accounts/:id` ](https://docs.joinmastodon.org/methods/accounts/#retrieve-information )
2021-05-15 11:02:15 -04:00
- [`POST /api/v1/accounts/:id/block` ](https://docs.joinmastodon.org/methods/accounts/ )
- [`POST /api/v1/accounts/:id/follow` ](https://docs.joinmastodon.org/methods/accounts/ )
2021-05-14 19:20:38 -04:00
- [`GET /api/v1/accounts/:id/followers` ](https://docs.joinmastodon.org/methods/accounts/ )
- [`GET /api/v1/accounts/:id/following` ](https://docs.joinmastodon.org/methods/accounts/ )
- [`GET /api/v1/accounts/:id/lists` ](https://docs.joinmastodon.org/methods/accounts/ )
2021-05-15 11:02:15 -04:00
- [`POST /api/v1/accounts/:id/mute` ](https://docs.joinmastodon.org/methods/accounts/ )
- [`POST /api/v1/accounts/:id/note` ](https://docs.joinmastodon.org/methods/accounts/ )
- [`GET /api/v1/accounts/:id/statuses` ](https://docs.joinmastodon.org/methods/accounts/ )
2021-05-14 19:20:38 -04:00
- [`POST /api/v1/accounts/:id/unfollow` ](https://docs.joinmastodon.org/methods/accounts/ )
- [`POST /api/v1/accounts/:id/unblock` ](https://docs.joinmastodon.org/methods/accounts/ )
- [`POST /api/v1/accounts/:id/unmute` ](https://docs.joinmastodon.org/methods/accounts/ )
2021-05-15 06:55:41 -04:00
- [`GET /api/v1/accounts/relationships` ](https://docs.joinmastodon.org/methods/accounts/ )
2021-05-09 05:35:51 -04:00
- [`GET /api/v1/accounts/search` ](https://docs.joinmastodon.org/methods/accounts )
2022-11-26 04:00:35 -05:00
- [`PATCH /api/v1/accounts/update_credentials` ](https://docs.joinmastodon.org/methods/accounts/#update_credentials )
2021-05-09 05:35:51 -04:00
- [`GET /api/v1/accounts/verify_credentials` ](https://docs.joinmastodon.org/methods/accounts )
2021-05-14 19:20:38 -04:00
- [`POST /api/v1/apps` ](https://docs.joinmastodon.org/methods/apps/ )
2021-05-19 05:35:08 -04:00
- [`GET /api/v1/apps/verify_credentials` ](https://docs.joinmastodon.org/methods/apps/ )
2021-05-08 15:21:52 -04:00
- [`GET /api/v1/blocks` ](https://docs.joinmastodon.org/methods/accounts/blocks/ )
- [`GET /api/v1/bookmarks` ](https://docs.joinmastodon.org/methods/accounts/bookmarks/ )
2021-05-19 17:56:50 -04:00
- [`GET /api/v1/conversations` ](https://docs.joinmastodon.org/methods/timelines/conversations/ )
- [`DELETE /api/v1/conversations/:id` ](https://docs.joinmastodon.org/methods/timelines/conversations/ )
- [`POST /api/v1/conversations/:id/read` ](https://docs.joinmastodon.org/methods/timelines/conversations/ )
2020-01-27 21:33:51 -05:00
- [`GET /api/v1/custom_emojis` ](https://docs.joinmastodon.org/methods/instance/custom_emojis/ )
- Doesn't return unicode emojis since they aren't using an image URL
2020-10-31 19:42:42 -04:00
- [`GET /api/v1/directory` ](https://docs.joinmastodon.org/methods/instance/directory/ )
2021-05-08 15:21:52 -04:00
- [`GET /api/v1/favourites` ](https://docs.joinmastodon.org/methods/accounts/favourites/ )
2019-12-21 09:51:11 -05:00
- [`GET /api/v1/follow_requests` ](https://docs.joinmastodon.org/methods/accounts/follow_requests#pending-follows )
- Returned IDs are specific to follow requests
- [`POST /api/v1/follow_requests/:id/authorize` ](https://docs.joinmastodon.org/methods/accounts/follow_requests#accept-follow )
- `:id` is a follow request ID, not a regular account id
- [`POST /api/v1/follow_requests/:id/reject` ](https://docs.joinmastodon.org/methods/accounts/follow_requests#reject-follow )
- `:id` is a follow request ID, not a regular account id
- `POST /api/v1/follow_requests/:id/ignore`
2019-12-11 03:50:09 -05:00
- Friendica-specific, hides the follow request from the list and prevents the remote contact from retrying.
2019-12-21 09:51:11 -05:00
- `:id` is a follow request ID, not a regular account id
2019-12-21 08:24:24 -05:00
- Returns a [Relationship ](https://docs.joinmastodon.org/entities/relationship ) object.
2019-12-09 22:36:52 -05:00
2022-11-28 01:46:18 -05:00
- [`GET /api/v1/followed_tags' ](https://docs.joinmastodon.org/methods/followed_tags/ )
2019-12-21 09:51:11 -05:00
- [`GET /api/v1/instance` ](https://docs.joinmastodon.org/methods/instance#fetch-instance )
2022-03-04 00:50:33 -05:00
- `GET /api/v1/instance/rules` Undocumented, returns Terms of Service
2019-12-21 09:51:11 -05:00
- [`GET /api/v1/instance/peers` ](https://docs.joinmastodon.org/methods/instance#list-of-connected-domains )
2021-05-09 05:35:51 -04:00
- [`GET /api/v1/lists` ](https://docs.joinmastodon.org/methods/timelines/lists/ )
2021-05-14 19:20:38 -04:00
- [`POST /api/v1/lists` ](https://docs.joinmastodon.org/methods/timelines/lists/ )
2021-05-09 05:35:51 -04:00
- [`GET /api/v1/lists/:id` ](https://docs.joinmastodon.org/methods/timelines/lists/ )
2021-05-14 19:20:38 -04:00
- [`PUT /api/v1/lists/:id` ](https://docs.joinmastodon.org/methods/timelines/lists/ )
- [`DELETE /api/v1/lists/:id` ](https://docs.joinmastodon.org/methods/timelines/lists/ )
2021-05-09 05:35:51 -04:00
- [`GET /api/v1/lists/:id/accounts` ](https://docs.joinmastodon.org/methods/timelines/lists/ )
2021-05-14 19:20:38 -04:00
- [`POST /api/v1/lists/:id/accounts` ](https://docs.joinmastodon.org/methods/timelines/lists/ )
- [`DELETE /api/v1/lists/:id/accounts` ](https://docs.joinmastodon.org/methods/timelines/lists/ )
2022-06-06 17:38:59 -04:00
- [`POST /api/v1/markers` ](https://docs.joinmastodon.org/methods/timelines/markers/ )
- [`GET /api/v1/markers` ](https://docs.joinmastodon.org/methods/timelines/markers/ )
2021-05-16 05:56:02 -04:00
- [`POST /api/v1/media` ](https://docs.joinmastodon.org/methods/statuses/media/ )
2021-05-09 08:59:23 -04:00
- [`GET /api/v1/media/:id` ](https://docs.joinmastodon.org/methods/statuses/media/ )
2021-05-16 05:56:02 -04:00
- [`PUT /api/v1/media/:id` ](https://docs.joinmastodon.org/methods/statuses/media/ )
2021-05-08 15:21:52 -04:00
- [`GET /api/v1/mutes` ](https://docs.joinmastodon.org/methods/accounts/mutes/ )
2021-05-09 07:50:05 -04:00
- [`GET /api/v1/notifications` ](https://docs.joinmastodon.org/methods/notifications/ )
- [`GET /api/v1/notifications/:id` ](https://docs.joinmastodon.org/methods/notifications/ )
2021-05-15 06:08:47 -04:00
- [`POST /api/v1/notifications/clear` ](https://docs.joinmastodon.org/methods/notifications/ )
- [`POST /api/v1/notifications/:id/dismiss` ](https://docs.joinmastodon.org/methods/notifications/ )
2022-04-22 15:24:22 -04:00
- [`GET /api/v1/polls/:id` ](https://docs.joinmastodon.org/methods/statuses/polls/ )
2021-05-09 05:35:51 -04:00
- [`GET /api/v1/preferences` ](https://docs.joinmastodon.org/methods/accounts/preferences/ )
2021-08-14 20:30:41 -04:00
- [`DELETE /api/v1/push/subscription` ](https://docs.joinmastodon.org/methods/notifications/push/ )
- [`GET /api/v1/push/subscription` ](https://docs.joinmastodon.org/methods/notifications/push/ )
- [`PUSH /api/v1/push/subscription` ](https://docs.joinmastodon.org/methods/notifications/push/ )
2021-08-15 03:28:26 -04:00
- [`PUT /api/v1/push/subscription` ](https://docs.joinmastodon.org/methods/notifications/push/ )
2021-07-30 18:43:11 -04:00
- [`GET /api/v1/scheduled_statuses` ](https://docs.joinmastodon.org/methods/statuses/scheduled_statuses/ )
2021-08-14 20:30:41 -04:00
- [`DELETE /api/v1/scheduled_statuses/:id` ](https://docs.joinmastodon.org/methods/statuses/scheduled_statuses/ )
- [`GET /api/v1/scheduled_statuses/:id` ](https://docs.joinmastodon.org/methods/statuses/scheduled_statuses/ )
2021-07-20 16:48:37 -04:00
- [`GET /api/v1/search` ](https://docs.joinmastodon.org/methods/search/ )
2022-11-25 14:35:40 -05:00
- [`POST /api/v1/statuses` ](https://docs.joinmastodon.org/methods/statuses/#create )
2022-03-04 00:50:33 -05:00
- Additionally to the static values `public` , `unlisted` and `private` , the `visibility` parameter can contain a numeric value with a group id.
2022-11-25 14:35:40 -05:00
- [`GET /api/v1/statuses/:id` ](https://docs.joinmastodon.org/methods/statuses/#get )
- [`DELETE /api/v1/statuses/:id` ](https://docs.joinmastodon.org/methods/statuses/#delete )
- [`GET /api/v1/statuses/:id/context` ](https://docs.joinmastodon.org/methods/statuses/#context )
- [`GET /api/v1/statuses/:id/reblogged_by` ](https://docs.joinmastodon.org/methods/statuses/#reblogged_by )
- [`GET /api/v1/statuses/:id/favourited_by` ](https://docs.joinmastodon.org/methods/statuses/#favourited_by )
- [`POST /api/v1/statuses/:id/favourite` ](https://docs.joinmastodon.org/methods/statuses/#favourite )
- [`POST /api/v1/statuses/:id/unfavourite` ](https://docs.joinmastodon.org/methods/statuses/#unfavourite )
- [`POST /api/v1/statuses/:id/reblog` ](https://docs.joinmastodon.org/methods/statuses/#boost )
- [`POST /api/v1/statuses/:id/unreblog` ](https://docs.joinmastodon.org/methods/statuses/#unreblog )
- [`POST /api/v1/statuses/:id/bookmark` ](https://docs.joinmastodon.org/methods/statuses/#bookmark )
- [`POST /api/v1/statuses/:id/unbookmark` ](https://docs.joinmastodon.org/methods/statuses/#unbookmark )
- [`POST /api/v1/statuses/:id/mute` ](https://docs.joinmastodon.org/methods/statuses/#mute )
- [`POST /api/v1/statuses/:id/unmute` ](https://docs.joinmastodon.org/methods/statuses/#unmute )
- [`POST /api/v1/statuses/:id/pin` ](https://docs.joinmastodon.org/methods/statuses/#pin )
- [`POST /api/v1/statuses/:id/unpin` ](https://docs.joinmastodon.org/methods/statuses/#unpin )
- [`POST /api/v1/statuses/:id` ](https://docs.joinmastodon.org/methods/statuses/#edit )
- [`GET /api/v1/statuses/:id/source` ](https://docs.joinmastodon.org/methods/statuses/#source )
- [`GET /api/v1/statuses/:id/card` ](https://docs.joinmastodon.org/methods/statuses/#card )
2021-05-08 07:03:50 -04:00
- [`GET /api/v1/suggestions` ](https://docs.joinmastodon.org/methods/accounts/suggestions/ )
2022-11-28 04:30:41 -05:00
- [`GET /api/v1/tags/:id` ](https://docs.joinmastodon.org/methods/tags/#get )
- [`GET /api/v1/tags/:id/follow` ](https://docs.joinmastodon.org/methods/tags/#follow )
- [`GET /api/v1/tags/:id/unfollow` ](https://docs.joinmastodon.org/methods/tags/#unfollow )
2021-05-20 00:39:45 -04:00
- [`GET /api/v1/timelines/direct` ](https://docs.joinmastodon.org/methods/timelines/ )
2021-05-08 04:39:00 -04:00
- [`GET /api/v1/timelines/home` ](https://docs.joinmastodon.org/methods/timelines/ )
- [`GET /api/v1/timelines/list/:id` ](https://docs.joinmastodon.org/methods/timelines/ )
2020-10-31 19:42:42 -04:00
- [`GET /api/v1/timelines/public` ](https://docs.joinmastodon.org/methods/timelines/ )
2021-05-08 04:39:00 -04:00
- [`GET /api/v1/timelines/tag/:hashtag` ](https://docs.joinmastodon.org/methods/timelines/ )
2020-10-31 19:42:42 -04:00
- [`GET /api/v1/trends` ](https://docs.joinmastodon.org/methods/instance/trends/ )
2022-11-28 04:30:41 -05:00
- [`GET /api/v1/trends/statuses` ](https://docs.joinmastodon.org/methods/trends/#statuses )
2022-11-28 02:08:01 -05:00
- [`GET /api/v1/trends/tags` ](https://docs.joinmastodon.org/methods/trends/#tags )
2021-05-17 18:22:51 -04:00
- [`GET /api/v2/search` ](https://docs.joinmastodon.org/methods/search/ )
2019-12-09 22:36:52 -05:00
2021-05-14 19:20:38 -04:00
## Currently unimplemented endpoints
2021-05-21 13:49:25 -04:00
These emdpoints are planned to be implemented somewhere in the future.
2021-05-14 19:20:38 -04:00
2022-04-27 02:50:25 -04:00
- [`POST /api/v1/accounts/:id/remove_from_followers` ](https://github.com/mastodon/mastodon/pull/16864 )
- [`GET /api/v1/accounts/familiar_followers` ](https://github.com/mastodon/mastodon/pull/17700 )
- [`GET /api/v1/accounts/lookup` ](https://github.com/mastodon/mastodon/pull/15740 )
- [`GET /api/v1/trends/links` ](https://github.com/mastodon/mastodon/pull/16917 )
- [`POST /api/v1/polls/:id/votes` ](https://docs.joinmastodon.org/methods/statuses/polls/ )
- [`GET /api/v1/featured_tags` ](https://docs.joinmastodon.org/methods/accounts/featured_tags/ )
- [`POST /api/v1/featured_tags` ](https://docs.joinmastodon.org/methods/accounts/featured_tags/ )
- [`DELETE /api/v1/featured_tags/:id` ](https://docs.joinmastodon.org/methods/accounts/featured_tags/ )
2021-05-14 19:20:38 -04:00
2021-05-21 13:49:25 -04:00
## Dummy endpoints
2021-05-21 16:45:01 -04:00
These endpoints are returning empty data to avoid error messages when using third party clients.
They refer to features that don't exist in Friendica yet.
2021-05-21 13:49:25 -04:00
- [`GET /api/v1/accounts/:id/identity_proofs` ](https://docs.joinmastodon.org/methods/accounts/ )
- [`GET /api/v1/announcements` ](https://docs.joinmastodon.org/methods/announcements/ )
- [`GET /api/v1/endorsements` ](https://docs.joinmastodon.org/methods/accounts/endorsements/ )
- [`GET /api/v1/filters` ](https://docs.joinmastodon.org/methods/accounts/filters/ )
2021-05-14 19:20:38 -04:00
## Non supportable endpoints
2021-05-21 13:49:25 -04:00
These endpoints won't be implemented at the moment.
2021-05-28 08:37:00 -04:00
They refer to features or data that don't exist in Friendica yet.
2019-12-21 09:51:11 -05:00
2022-03-04 00:50:33 -05:00
- `POST /api/meta` Misskey API endpoint.
2021-05-14 19:20:38 -04:00
- [`POST /api/v1/accounts` ](https://docs.joinmastodon.org/methods/accounts/ )
2021-06-03 00:47:02 -04:00
- [`GET /api/v1/accounts/:id/featured_tags` ](https://docs.joinmastodon.org/methods/accounts/ )
2021-05-14 19:20:38 -04:00
- [`POST /api/v1/accounts/:id/pin` ](https://docs.joinmastodon.org/methods/accounts/ )
- [`POST /api/v1/accounts/:id/unpin` ](https://docs.joinmastodon.org/methods/accounts/ )
- [`GET /api/v1/admin/accounts` ](https://docs.joinmastodon.org/methods/admin/ )
- [`GET /api/v1/admin/accounts/:id` ](https://docs.joinmastodon.org/methods/admin/ )
- [`POST /api/v1/admin/accounts/:id/{action}` ](https://docs.joinmastodon.org/methods/admin/ )
- [`GET /api/v1/admin/reports` ](https://docs.joinmastodon.org/methods/admin/ )
- [`GET /api/v1/admin/reports/:id` ](https://docs.joinmastodon.org/methods/admin/ )
- [`POST /api/v1/admin/reports/:id/{action}` ](https://docs.joinmastodon.org/methods/admin/ )
- [`POST /api/v1/announcements/:id/dismiss` ](https://docs.joinmastodon.org/methods/announcements/ )
- [`PUT /api/v1/announcements/:id/reactions/{name}` ](https://docs.joinmastodon.org/methods/announcements/ )
- [`DELETE /api/v1/announcements/:id/reactions/{name}` ](https://docs.joinmastodon.org/methods/announcements/ )
- [`GET /api/v1/domain_blocks` ](https://docs.joinmastodon.org/methods/accounts/domain_blocks/ )
- [`POST /api/v1/domain_blocks` ](https://docs.joinmastodon.org/methods/accounts/domain_blocks/ )
- [`DELETE /api/v1/domain_blocks` ](https://docs.joinmastodon.org/methods/accounts/domain_blocks/ )
2022-04-21 15:58:56 -04:00
- [`DELETE /api/v1/emails/confirmations` ](https://github.com/mastodon/mastodon/pull/15816 )
2021-05-14 19:20:38 -04:00
- [`GET /api/v1/featured_tags/suggestions` ](https://docs.joinmastodon.org/methods/accounts/featured_tags/ )
- [`GET /api/v1/filters/:id` ](https://docs.joinmastodon.org/methods/accounts/filters/ )
- [`POST /api/v1/filters/:id` ](https://docs.joinmastodon.org/methods/accounts/filters/ )
- [`PUT /api/v1/filters/:id` ](https://docs.joinmastodon.org/methods/accounts/filters/ )
- [`DELETE /api/v1/filters/:id` ](https://docs.joinmastodon.org/methods/accounts/filters/ )
2021-05-28 08:37:00 -04:00
- [`GET /api/v1/instance/activity` ](https://docs.joinmastodon.org/methods/instance#weekly-activity )
2021-05-14 19:20:38 -04:00
- [`POST /api/v1/markers` ](https://docs.joinmastodon.org/methods/timelines/markers/ )
- [`POST /api/v1/reports` ](https://docs.joinmastodon.org/methods/accounts/reports/ )
- [`PUT /api/v1/scheduled_statuses/:id` ](https://docs.joinmastodon.org/methods/statuses/scheduled_statuses/ )
2022-04-27 02:50:25 -04:00
- [`GET /api/v1/statuses/{id:\d+}/history` ](https://github.com/mastodon/mastodon/pull/16697 )
2021-06-03 00:47:02 -04:00
- [`GET /api/v1/streaming` ](https://docs.joinmastodon.org/methods/timelines/streaming/ )
2021-05-14 19:20:38 -04:00
- [`DELETE /api/v1/suggestions/:id` ](https://docs.joinmastodon.org/methods/accounts/suggestions/ )