Mastodon API Specification (https://github.com/mastodon/mastodon)

Tools (129)

Extracted live via the executor SDK.

• accounts.getApiV1AccountsId

  GET /api/v1/accounts/{id}

• accounts.getApiV1AccountsIdFeaturedTags

  Tags featured by this account.

• accounts.getApiV1AccountsIdFollowers

  Accounts which follow the given account, if network is not hidden by the account owner.

• accounts.getApiV1AccountsIdFollowing

  Accounts which the given account is following, if network is not hidden by the account owner.

• accounts.getApiV1AccountsIdIdentityProofs

  Array of IdentityProof

• accounts.getApiV1AccountsIdLists

  User lists that you have added this account to.

• accounts.getApiV1AccountsIdStatuses

  Statuses posted to the given account.

• accounts.getApiV1AccountsRelationships

  Sets a private note on a user.

• accounts.getApiV1AccountsSearch

  Search for matching accounts by username or display name.

• accounts.getApiV1AccountsVerifyCredentials

  Test to make sure that the user token works.

• accounts.patchApiV1AccountsUpdateCredentials

  Update the user's display and preferences.

• accounts.postApiV1AccountsIdBlock

  Block the given account. Clients should filter statuses from this account if received (e.g. due to a boost in the Home timeline).

• accounts.postApiV1AccountsIdFollow

  Follow the given account. Can also be used to update whether to show reblogs or enable notifications.

• accounts.postApiV1AccountsIdMute

  Mute the given account. Clients should filter statuses and notifications from this account, if received (e.g. due to a boost in the Home timeline).

• accounts.postApiV1AccountsIdNote

  Sets a private note on a user.

• accounts.postApiV1AccountsIdPin

  Add the given account to the user's featured profiles. (Featured profiles are currently shown on the user's own public profile.)

• accounts.postApiV1AccountsIdUnblock

  Block the given account. Clients should filter statuses from this account if received (e.g. due to a boost in the Home timeline).

• accounts.postApiV1AccountsIdUnfollow

  Unfollow the given account.

• accounts.postApiV1AccountsIdUnmute

  Unmute the given account.

• accounts.postApiV1AccountsIdUnpin

  Remove the given account from the user's featured profiles.

• admin.getApiV1AdminAccounts

  View accounts matching certain criteria for filtering, up to 100 at a time. Pagination may be done with the HTTP Link header in the response.

• admin.getApiV1AdminAccountsId

  View admin-level information about the given account.

• admin.getApiV1AdminReports

  View all reports. Pagination may be done with HTTP Link header in the response.

• admin.getApiV1AdminReportsId

  View information about the report with the given ID.

• admin.postApiV1AdminAccountsIdAction

  Perform an action against an account and log this action in the moderation history.

• admin.postApiV1AdminAccountsIdApprove

  Approve the given local account if it is currently pending approval.

• admin.postApiV1AdminAccountsIdEnable

  Re-enable a local account whose login is currently disabled.

• admin.postApiV1AdminAccountsIdReject

  Reject the given local account if it is currently pending approval.

• admin.postApiV1AdminAccountsIdUnsilence

  Unsilence a currently silenced account.

• admin.postApiV1AdminAccountsIdUnsuspend

  Unsuspend a currently suspended account.

• admin.postApiV1AdminReportsIdAssignToSelf

  Claim the handling of this report to yourself.

• admin.postApiV1AdminReportsIdReopen

  Mark a report as resolved with no further action taken.

• admin.postApiV1AdminReportsIdResolve

  Mark a report as resolved with no further action taken.

• admin.postApiV1AdminReportsIdUnassign

  Unassign a report so that someone else can claim it.

• announcements.deleteApiV1AnnouncementsIdReactionsName

  Undo a react emoji to an announcement.

• announcements.getApiV1Announcements

  See all currently active announcements set by admins.

• announcements.postApiV1AnnouncementsIdDismiss

  Allows a user to mark the announcement as read.

• announcements.putApiV1AnnouncementsIdReactionsName

  Allows a user to mark the announcement as read.

• apps.getApiV1AppsVerifyCredentials

  Confirm that the app's OAuth2 credentials work.

• apps.postApiV1Apps

  Create a new application to obtain OAuth2 credentials.

• blocks.getApiV1Blocks

  Get blocked users.

• bookmarks.getApiV1Bookmarks

  Statuses the user has bookmarked.

• conversations.deleteApiV1ConversationsId

  Remove converstation

• conversations.getApiV1Conversations

  Show conversation.

• conversations.postApiV1ConversationsIdRead

  Remove converstation

• customEmojis.getApiV1CustomEmojis

  Returns custom emojis that are available on the server.

• directory.getApiV1Directory

  List accounts visible in the directory.

• domainBlocks.deleteApiV1DomainBlocks

  Remove a domain block, if it exists in the user's array of blocked domains.

• domainBlocks.getApiV1DomainBlocks

  View domains the user has blocked.

• domainBlocks.postApiV1DomainBlocks

  "Block a domain to:

  • hide all public posts from it
  • hide all notifications from it
  • remove all followers from it
  • prevent following new users from it (but does not remove existing follows)"
• endorsements.getApiV1Endorsements

  Accounts that the user is currently featuring on their profile.

• favourites.getApiV1Favourites

  Statuses the user has favourited.

• featuredTags.deleteApiV1FeaturedTagsId

  Unfeature a tag

• featuredTags.getApiV1FeaturedTags

  View your featured tags.

• featuredTags.getApiV1FeaturedTagsSuggestions

  Shows your 10 most-used tags, with usage history for the past week.

• featuredTags.postApiV1FeaturedTags

  Create a feature a tag.

• filters.deleteApiV1FiltersId

  Delete a filter.

• filters.getApiV1Filters

  GET /api/v1/filters

• filters.getApiV1FiltersId

  Get one filter.

• filters.postApiV1Filters

  POST /api/v1/filters

• filters.putApiV1FiltersId

  Update a filter.

• followRequests.getApiV1FollowRequests

  Pending Follows

• followRequests.postApiV1FollowRequestsIdAuthorize

  Accept Follow

• followRequests.postApiV1FollowRequestsIdReject

  Accept Follow

• instance.getApiV1Instance

  Information about the server.

• instance.getApiV1InstanceActivity

  Instance activity over the last 3 months, binned weekly.

• instance.getApiV1InstancePeers

  Information about the server.

• lists.deleteApiV1Lists

  Delete a list

• lists.deleteApiV1ListsIdAccounts

  Remove accounts from the given list.

• lists.getApiV1Lists

  Fetch all lists that the user owns.

• lists.getApiV1ListsId

  Remove converstation

• lists.getApiV1ListsIdAccounts

  View accounts in List

• lists.postApiV1Lists

  Create a new list.

• lists.postApiV1ListsIdAccounts

  Add accounts to the given list. Note that the user must be following these accounts.

• lists.putApiV1Lists

  Change the title of a list, or which replies to show.

• markers.getApiV1Markers

  Get saved timeline position

• markers.postApiV1Markers

  Get saved timeline position

• media.getApiV1MediaId

  Get an attachement.

• media.postApiV1Media

  Creates an attachment to be used with a new status.

• media.postApiV1MediaId

  Update an Attachment, before it is attached to a status and posted.

• mutes.getApiV1Mutes

  Accounts the user has muted.

• notifications.getApiV1Notifications

  Notifications concerning the user. This API returns Link headers containing links to the next/previous page. However, the links can also be constructed dynamically using query params and id values.

• notifications.getApiV1NotificationsId

  View information about a notification with a given ID.

• notifications.postApiV1NotificationsClear

  Clear all notifications from the server.

• notifications.postApiV1NotificationsIdDismiss

  Clear a single notification from the server.

• oauth.getOauthAuthorize

  Displays an authorization form to the user. If approved, it will create and return an authorization code, then redirect to the desired redirect_uri, or show the authorization code if urn:ietf:wg:oauth:2.0:oob was requested. The authorization code can be used while requesting a token to obtain access to user-level methods.

• oauth.postOauthRevoke

  Revoke an access token to make it no longer valid for use.

• oauth.postOauthToken

  Returns an access token, to be used during API calls that are not public.

• oembed.getApiOembed

  OEmbed as JSON

• polls.getApiV1PollsId

  View a poll.

• polls.postApiV1PollsId

  Vote on a poll.

• preferences.getApiV1Preferences

  Shows your 10 most-used tags, with usage history for the past week.

• proofs.getApiProofs

  View identity proof

• push.deleteApiV1PushSubscription

  Updates the current push subscription. Only the data part can be updated. To change fundamentals, a new subscription must be created instead.

• push.getApiV1PushSubscription

  View the PushSubscription currently associated with this access token.

• push.postApiV1PushSubscription

  Add a Web Push API subscription to receive notifications. Each access token can have one push subscription. If you create a new subscription, the old subscription is deleted.

• push.putApiV1PushSubscription

  Updates the current push subscription. Only the data part can be updated. To change fundamentals, a new subscription must be created instead.

• reports.postApiV1Reports

  File a report.

• scheduledStatuses.deleteApiV1ScheduledStatusesId

  Cancel a scheduled status

• scheduledStatuses.getApiV1ScheduledStatuses

  View scheduled statuses

• scheduledStatuses.getApiV1ScheduledStatusesId

  View a single scheduled status

• scheduledStatuses.putApiV1ScheduledStatusesId

  View a single scheduled status

• search.getApiV2Search

  Search results

• statuses.deleteApiV1StatusesId

  DELETE /api/v1/statuses/{id}

• statuses.getApiV1StatusesId

  GET /api/v1/statuses/{id}

• statuses.getApiV1StatusesIdContext

  GET /api/v1/statuses/{id}/context

• statuses.getApiV1StatusesIdFavouritedBy

  View who favourited a given status.

• statuses.getApiV1StatusesIdRebloggedBy

  View who boosted a given status.

• statuses.postApiV1Statuses

  POST /api/v1/statuses

• statuses.postApiV1StatusesIdBookmark

  Privately bookmark a status.

• statuses.postApiV1StatusesIdFavourite

  Add a status to your favourites list.

• statuses.postApiV1StatusesIdMute

  Do not receive notifications for the thread that this status is part of. Must be a thread in which you are a participant.

• statuses.postApiV1StatusesIdPin

  Feature one of your own public statuses at the top of your profile.

• statuses.postApiV1StatusesIdReblog

  Reshare a status.

• statuses.postApiV1StatusesIdUnbookmark

  Remove a status from your private bookmarks.

• statuses.postApiV1StatusesIdUnfavourite

  Remove a status from your favourites list.

• statuses.postApiV1StatusesIdUnmute

  Status's conversation unmuted, or was already unmuted

• statuses.postApiV1StatusesIdUnpin

  Unfeature a status from the top of your profile.

• statuses.postApiV1StatusesIdUnreblog

  Undo a reshare of a status.

• suggestions.deleteApiV1SuggestionsId

  Delete user suggestion

• suggestions.getApiV1Suggestions

  Accounts the user has had past positive interactions with, but is not yet following.

• timelines.getApiV1TimelinesHome

  View statuses from followed users.

• timelines.getApiV1TimelinesListListId

  View statuses in the given list timeline.

• timelines.getApiV1TimelinesPublic

  Public timeline

• timelines.getApiV1TimelinesTagHashtag

  View public statuses containing the given hashtag.

• todoSecurity.postApiV1Accounts

  Creates a user and account records. Returns an account access token for the app that initiated the request. The app should save this token for later, and should wait for the user to confirm their account by clicking a link in their email inbox.

• trends.getApiV1Trends

  Tags that are being used more frequently within the past week.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools