Connectors
Social & Media
Mastodon
Decentralized social network: post statuses, manage follows, and read timelines
Mastodon API referenceAPI checked August 17, 2026
- Signs in with
- API token
- Runs on
- Cloud or On-Prem Worker
- Operations
- 342
- Ready-made triggers
- 0
Connect Mastodon
- In Neblex open Connect › Connections and click New Connection.
- Search for Mastodon and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| Instance hostRequired | Your Mastodon instance host, e.g. mastodon.social. |
| Access tokenOptionalSecret | OAuth access token (user, app, or admin-scoped). Required for Bearer operations and optional for Anonymous public operations; authorized-fetch instances may require Bearer. |
Use it in a flow
- Open a flow, open the node library and search for Mastodon.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
To start a flow from Mastodon without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if Mastodon can send webhooks, a Webhook trigger receives them at its own URL.
Operations
342 operations in 58 groups. Each one is a step you can add to a flow.
Accounts39
Block accountpost_api_v1_accounts__id__block | POST | Blocks the given account. |
Check relationships to other accountsget_api_v1_accounts_relationships | GET | Find out whether a given account is followed, blocked, muted, etc. |
Feature account on your profilepost_api_v1_accounts__id__endorse | POST | Add the given account to the user's featured profiles. |
Feature account on your profilepost_api_v1_accounts__id__pin | POST | Add the given account to the user's featured profiles. |
Find familiar followersget_api_v1_accounts_familiar_followers | GET | Obtain a list of all accounts that follow a given account, filtered for accounts you follow. |
Follow accountpost_api_v1_accounts__id__follow | POST | Follow the given account. |
Follow accountpost_api_v1_accounts__id__followForm | POST | Follow the given account. |
Get accountget_api_v1_accounts__id_ | GET | View information about a profile. |
Get accountget_api_v1_accounts__id_Anonymous | GET | View information about a profile. |
Get account's featured tagsget_api_v1_accounts__id__featured_tags | GET | Tags featured by this account. |
Get account's featured tagsget_api_v1_accounts__id__featured_tagsAnonymous | GET | Tags featured by this account. |
Get account's followersget_api_v1_accounts__id__followers | GET | Accounts which follow the given account, if network is not hidden by the account owner. |
Get account's followersget_api_v1_accounts__id__followersAnonymous | GET | Accounts which follow the given account, if network is not hidden by the account owner. |
Get account's followingget_api_v1_accounts__id__following | GET | Accounts which the given account is following, if network is not hidden by the account owner. |
Get account's followingget_api_v1_accounts__id__followingAnonymous | GET | Accounts which the given account is following, if network is not hidden by the account owner. |
Get account's statusesget_api_v1_accounts__id__statuses | GET | Statuses posted to the given account. |
Get account's statusesget_api_v1_accounts__id__statusesAnonymous | GET | Statuses posted to the given account. |
Get featured accountsget_api_v1_accounts__id__endorsements | GET | Accounts that the user is currently featuring on their profile. |
Get featured accountsget_api_v1_accounts__id__endorsementsAnonymous | GET | Accounts that the user is currently featuring on their profile. |
Get lists containing this accountget_api_v1_accounts__id__lists | GET | User lists that you have added this account to. |
Get multiple accountsget_api_v1_accounts | GET | View information about multiple profiles. |
Get multiple accountsget_api_v1_accountsAnonymous | GET | View information about multiple profiles. |
Identity proofsget_api_v1_accounts__id__identity_proofs | GET | Returns: Array of IdentityProof\ |
Lookup account ID from WebFinger addressget_api_v1_accounts_lookup | GET | Quickly lookup a username to see if it is available, skipping WebFinger resolution. |
Mute accountpost_api_v1_accounts__id__mute | POST | Mute the given account. |
Mute accountpost_api_v1_accounts__id__muteForm | POST | Mute the given account. |
Register an accountpost_api_v1_accounts | POST | Creates a user and account records. |
Register an accountpost_api_v1_accountsForm | POST | Creates a user and account records. |
Remove account from followerspost_api_v1_accounts__id__remove_from_followers | POST | Remove the given account from your followers. |
Search for matching accountsget_api_v1_accounts_search | GET | Search for matching accounts by username or display name. |
Set private note on profilepost_api_v1_accounts__id__note | POST | Sets a private note on a user. |
Set private note on profilepost_api_v1_accounts__id__noteForm | POST | Sets a private note on a user. |
Unblock accountpost_api_v1_accounts__id__unblock | POST | Unblock the given account. |
Unfeature account from profilepost_api_v1_accounts__id__unendorse | POST | Remove the given account from the user's featured profiles. |
Unfeature account from profilepost_api_v1_accounts__id__unpin | POST | Remove the given account from the user's featured profiles. |
Unfollow accountpost_api_v1_accounts__id__unfollow | POST | Unfollow the given account. |
Unmute accountpost_api_v1_accounts__id__unmute | POST | Unmute the given account. |
Update account credentialspatch_api_v1_accounts_update_credentials | PATCH | Update the user's display and preferences. |
Verify account credentialsget_api_v1_accounts_verify_credentials | GET | Test to make sure that the user token works. |
Admin15
Approve a pending accountpost_api_v1_admin_accounts__id__approve | POST | Approve the given local account if it is currently pending approval. |
Assign report to selfpost_api_v1_admin_reports__id__assign_to_self | POST | Claim the handling of this report to yourself. |
Enable a currently disabled accountpost_api_v1_admin_accounts__id__enable | POST | Re-enable a local account whose login is currently disabled. |
Mark report as resolvedpost_api_v1_admin_reports__id__resolve | POST | Mark a report as resolved with no further action taken. |
Perform an action against an accountpost_api_v1_admin_accounts__id__action | POST | Perform an action against an account and log this action in the moderation history. |
Perform an action against an accountpost_api_v1_admin_accounts__id__actionForm | POST | Perform an action against an account and log this action in the moderation history. |
Reject a pending accountpost_api_v1_admin_accounts__id__reject | POST | Reject the given local account if it is currently pending approval. |
Reopen a closed reportpost_api_v1_admin_reports__id__reopen | POST | Reopen a currently closed report, if it is closed. |
Unassign reportpost_api_v1_admin_reports__id__unassign | POST | Unassign a report so that someone else can claim it. |
Unsilence an accountpost_api_v1_admin_accounts__id__unsilence | POST | Unsilence an account if it is currently silenced. |
Unsuspend an accountpost_api_v1_admin_accounts__id__unsuspend | POST | Unsuspend a currently suspended account. |
View a single reportget_api_v1_admin_reports__id_ | GET | Returns: Admin::Report\ |
View a specific accountget_api_v1_admin_accounts__id_ | GET | View admin-level information about the given account. |
View accounts (v1)get_api_v1_admin_accounts | GET | View all accounts, optionally matching certain criteria for filtering, up to 100 at a time. |
View all reportsget_api_v1_admin_reports | GET | View information about all reports. |
Admin Accounts3
Delete an accountdelete_api_v1_admin_accounts__id_ | DELETE | Permanently delete data for a suspended account. |
Unmark an account as sensitivepost_api_v1_admin_accounts__id__unsensitive | POST | Stops marking an account's posts as sensitive, if it was previously flagged as sensitive. |
View accounts (v2)get_api_v2_admin_accounts | GET | View all accounts, optionally matching certain criteria for filtering, up to 100 at a time. |
Admin Domain Blocks7
Block a domain from federatingpost_api_v1_admin_domain_blocks | POST | Add a domain to the list of domains blocked from federating. |
Block a domain from federatingpost_api_v1_admin_domain_blocksForm | POST | Add a domain to the list of domains blocked from federating. |
Get a single blocked domainget_api_v1_admin_domain_blocks__id_ | GET | Returns: Admin::DomainBlock\ |
List all blocked domainsget_api_v1_admin_domain_blocks | GET | Show information about all blocked domains. |
Remove a domain blockdelete_api_v1_admin_domain_blocks__id_ | DELETE | Lift a block against a domain. |
Update a domain blockput_api_v1_admin_domain_blocks__id_ | PUT | Change parameters for an existing domain block. |
Update a domain blockput_api_v1_admin_domain_blocks__id_Form | PUT | Change parameters for an existing domain block. |
Admin Reports2
Update a reportput_api_v1_admin_reports__id_ | PUT | Change metadata for a report. |
Update a reportput_api_v1_admin_reports__id_Form | PUT | Change metadata for a report. |
Admin Trends3
View trending linksget_api_v1_admin_trends_links | GET | Links that have been shared more than others, including unapproved and unreviewed links. |
View trending statusesget_api_v1_admin_trends_statuses | GET | Statuses that have been interacted with more than others, including unapproved and unreviewed statuses. |
View trending tagsget_api_v1_admin_trends_tags | GET | Tags that are being used more frequently within the past week, including unapproved and unreviewed tags. |
Announcements4
Add a reaction to an announcementput_api_v1_announcements__id__reactions__name_ | PUT | React to an announcement with an emoji. |
Dismiss an announcementpost_api_v1_announcements__id__dismiss | POST | Allows a user to mark the announcement as read. |
Remove a reaction from an announcementdelete_api_v1_announcements__id__reactions__name_ | DELETE | Undo a react emoji to an announcement. |
View all announcementsget_api_v1_announcements | GET | See all currently active announcements set by admins. |
Annual Reports5
Generate a new annual report {generate}post_api_v1_annual_reports__year__generate | POST | Generate the user's annual report for the specified year. |
Get a single annual reportget_api_v1_annual_reports__year_ | GET | Returns the current user's generated annual report for the given year, if it exists. |
Get all annual reportsget_api_v1_annual_reports | GET | Returns all of the current user's generated annual reports, if any. |
Get the state of an annual reportget_api_v1_annual_reports__year__state | GET | Returns the state of the annual report for the current user and given year. |
Mark an annual report as readpost_api_v1_annual_reports__year__read | POST | Marks the user's generated annual report for the given year as read. |
Apps5
Create an applicationpost_api_v1_apps | POST | Create a new application to obtain OAuth2 credentials. |
Create an applicationpost_api_v1_appsAnonymous | POST | Create a new application to obtain OAuth2 credentials. |
Create an applicationpost_api_v1_appsForm | POST | Create a new application to obtain OAuth2 credentials. |
Create an applicationpost_api_v1_appsFormAnonymous | POST | Create a new application to obtain OAuth2 credentials. |
Verify your app worksget_api_v1_apps_verify_credentials | GET | Confirm that the app's OAuth2 credentials work. |
Authorize2
Authorize a userget_oauth_authorize | GET | Displays an authorization form to the user. |
Authorize a userget_oauth_authorizeAnonymous | GET | Displays an authorization form to the user. |
Blocks1
View blocked usersget_api_v1_blocks | GET | Returns your blocked accounts. |
Bookmarks1
View bookmarked statusesget_api_v1_bookmarks | GET | Statuses the user has bookmarked. |
Canonical Email Blocks7
Block a canonical emailpost_api_v1_admin_canonical_email_blocks | POST | Returns: Admin::CanonicalEmailBlock\ |
Block a canonical emailpost_api_v1_admin_canonical_email_blocksForm | POST | Returns: Admin::CanonicalEmailBlock\ |
Delete a canonical email blockdelete_api_v1_admin_canonical_email_blocks__id_ | DELETE | Returns: Admin::CanonicalEmailBlock\ |
List all canonical email blocksget_api_v1_admin_canonical_email_blocks | GET | Returns: Array of Admin::CanonicalEmailBlock\ |
Show a single canonical email blockget_api_v1_admin_canonical_email_blocks__id_ | GET | Returns: Admin::CanonicalEmailBlock\ |
Testpost_api_v1_admin_canonical_email_blocks_test | POST | Canoniocalize and hash an email address. |
Testpost_api_v1_admin_canonical_email_blocks_testForm | POST | Canoniocalize and hash an email address. |
Collections14
Add an account to a Collectionpost_api_v1_collections__collection_id__items | POST | Add an account to a Collection. |
Add an account to a Collectionpost_api_v1_collections__collection_id__itemsForm | POST | Add an account to a Collection. |
Create a Collectionpost_api_v1_collections | POST | Create a new Collection. |
Create a Collectionpost_api_v1_collectionsForm | POST | Create a new Collection. |
Delete a Collectiondelete_api_v1_collections__id_ | DELETE | Delete a Collection. |
Get a single Collectionget_api_v1_collections__id_ | GET | Returns: CollectionWithAccounts\ |
Get a single Collectionget_api_v1_collections__id_Anonymous | GET | Returns: CollectionWithAccounts\ |
Get all Collections from a given accountget_api_v1_accounts__account_id__collections | GET | Returns: Collections\ |
Get all Collections from a given accountget_api_v1_accounts__account_id__collectionsAnonymous | GET | Returns: Collections\ |
Get all Collections the current account is featured inget_api_v1_accounts__account_id__in_collections | GET | Returns: Collections\ |
Remove account from a Collectiondelete_api_v1_collections__collection_id__items__id_ | DELETE | Remove an account from a Collection. |
Revoke inclusion in a Collectionpost_api_v1_collections__collection_id__items__id__revoke | POST | Remove the current user from a Collection created by a different user. |
Update a Collectionpatch_api_v1_collections__id_ | PATCH | Update an existing Collection. |
Update a Collectionpatch_api_v1_collections__id_Form | PATCH | Update an existing Collection. |
Conversations3
Mark a conversation as readpost_api_v1_conversations__id__read | POST | Returns: Conversation\ |
Remove a conversationdelete_api_v1_conversations__id_ | DELETE | Removes a conversation from your list of conversations. |
View all conversationsget_api_v1_conversations | GET | Returns: Array of Conversation\ |
Custom Emojis2
View all custom emojiget_api_v1_custom_emojis | GET | Returns custom emojis that are available on the server. |
View all custom emojiget_api_v1_custom_emojisAnonymous | GET | Returns custom emojis that are available on the server. |
Dimensions2
Get dimensional datapost_api_v1_admin_dimensions | POST | Obtain information about popularity of certain accounts, servers, languages, etc. |
Get dimensional datapost_api_v1_admin_dimensionsForm | POST | Obtain information about popularity of certain accounts, servers, languages, etc. |
Directory2
View profile directoryget_api_v1_directory | GET | List accounts visible in the directory. |
View profile directoryget_api_v1_directoryAnonymous | GET | List accounts visible in the directory. |
Domain Allows5
Allow a domain to federatepost_api_v1_admin_domain_allows | POST | Add a domain to the list of domains allowed to federate, to be used when the instance is in allow-list federation mode. |
Allow a domain to federatepost_api_v1_admin_domain_allowsForm | POST | Add a domain to the list of domains allowed to federate, to be used when the instance is in allow-list federation mode. |
Delete an allowed domaindelete_api_v1_admin_domain_allows__id_ | DELETE | Delete a domain from the allowed domains list. |
Get a single allowed domainget_api_v1_admin_domain_allows__id_ | GET | Returns: Admin::DomainAllow\ |
List all allowed domainsget_api_v1_admin_domain_allows | GET | Show information about all allowed domains. |
Domain Blocks5
Block a domainpost_api_v1_domain_blocks | POST | Block a domain to change interactions with that domain's server: |
Block a domainpost_api_v1_domain_blocksForm | POST | Block a domain to change interactions with that domain's server: |
Get domain blocksget_api_v1_domain_blocks | GET | View domains the user has blocked. |
Unblock a domaindelete_api_v1_domain_blocks | DELETE | Remove a domain block, if it exists in the user's array of blocked domains. |
Unblock a domaindelete_api_v1_domain_blocksForm | DELETE | Remove a domain block, if it exists in the user's array of blocked domains. |
Email Domain Blocks5
Block an email domain from signupspost_api_v1_admin_email_domain_blocks | POST | Add a domain to the list of email domains blocked from signups. |
Block an email domain from signupspost_api_v1_admin_email_domain_blocksForm | POST | Add a domain to the list of email domains blocked from signups. |
Delete an email domain blockdelete_api_v1_admin_email_domain_blocks__id_ | DELETE | Lift a block against an email domain. |
Get a single blocked email domainget_api_v1_admin_email_domain_blocks__id_ | GET | Returns: Admin::EmailDomainBlock\ |
List all blocked email domainsget_api_v1_admin_email_domain_blocks | GET | Show information about all email domains blocked from signing up. |
Emails2
Resend confirmation emailpost_api_v1_emails_confirmations | POST | Resend a new confirmation email. |
Resend confirmation emailpost_api_v1_emails_confirmationsForm | POST | Resend a new confirmation email. |
Endorsements1
View currently featured profilesget_api_v1_endorsements | GET | Accounts that the user is currently featuring on their profile. |
Experimental async refreshes1
Get Status of Async Refreshget_api_v1_alpha_async_refreshes__id_ | GET | Sometimes an API request might not return the expected results or not all possible results as either a background job is already running to (re-)create these results or the request... |
Favourites1
View favourited statusesget_api_v1_favourites | GET | Statuses the user has favourited. |
Featured Tags5
Feature a tagpost_api_v1_featured_tags | POST | Promote a hashtag on your profile. |
Feature a tagpost_api_v1_featured_tagsForm | POST | Promote a hashtag on your profile. |
Unfeature a tagdelete_api_v1_featured_tags__id_ | DELETE | Stop promoting a hashtag on your profile. |
View suggested tags to featureget_api_v1_featured_tags_suggestions | GET | Shows up to 10 recently-used tags. |
View your featured tagsget_api_v1_featured_tags | GET | List all hashtags featured on your profile. |
Filters26
Add a keyword to a filterpost_api_v2_filters__filter_id__keywords | POST | Add the given keyword to the specified filter group |
Add a keyword to a filterpost_api_v2_filters__filter_id__keywordsForm | POST | Add the given keyword to the specified filter group |
Add a status to a filter grouppost_api_v2_filters__filter_id__statuses | POST | Add a status filter to the current filter group. |
Add a status to a filter grouppost_api_v2_filters__filter_id__statusesForm | POST | Add a status filter to the current filter group. |
Create a filterpost_api_v1_filters | POST | Returns: V1::Filter\ |
Create a filterpost_api_v1_filtersForm | POST | Returns: V1::Filter\ |
Create a filterpost_api_v2_filters | POST | Create a filter group with the given parameters. |
Create a filterpost_api_v2_filtersForm | POST | Create a filter group with the given parameters. |
Delete a filterdelete_api_v2_filters__id_ | DELETE | Delete a filter group with the given id. |
Edit a keyword within a filterput_api_v2_filters_keywords__id_ | PUT | Update the given filter keyword. |
Edit a keyword within a filterput_api_v2_filters_keywords__id_Form | PUT | Update the given filter keyword. |
Remove a filterdelete_api_v1_filters__id_ | DELETE | Returns: Empty\ |
Remove a status from a filter groupdelete_api_v2_filters_statuses__id_ | DELETE | Remove a status filter from the current filter group. |
Remove keywords from a filterdelete_api_v2_filters_keywords__id_ | DELETE | Deletes the given filter keyword. |
Update a filterput_api_v1_filters__id_ | PUT | Replaces a filter's parameters in-place. |
Update a filterput_api_v1_filters__id_Form | PUT | Replaces a filter's parameters in-place. |
Update a filterput_api_v2_filters__id_ | PUT | Update a filter group with the given parameters. |
Update a filterput_api_v2_filters__id_Form | PUT | Update a filter group with the given parameters. |
View a single filterget_api_v1_filters__id_ | GET | Returns: V1::Filter\ |
View a single keywordget_api_v2_filters_keywords__id_ | GET | Get one filter keyword by the given id. |
View a single status filterget_api_v2_filters_statuses__id_ | GET | Obtain a single status filter. |
View a specific filterget_api_v2_filters__id_ | GET | Obtain a single filter group owned by the current user. |
View all filtersget_api_v2_filters | GET | Obtain a list of all filter groups for the current user. |
View all status filtersget_api_v2_filters__filter_id__statuses | GET | Obtain a list of all status filters within this filter group. |
View keywords added to a filterget_api_v2_filters__filter_id__keywords | GET | List all keywords attached to the current filter group. |
View your filtersget_api_v1_filters | GET | Returns: List of V1::Filter\ |
Follow Requests3
Accept follow requestpost_api_v1_follow_requests__account_id__authorize | POST | Returns: Relationship\ |
Reject follow requestpost_api_v1_follow_requests__account_id__reject | POST | Returns: Relationship\ |
View pending follow requestsget_api_v1_follow_requests | GET | Returns: Array of Account\ |
Followed Tags1
View all followed tagsget_api_v1_followed_tags | GET | List your followed hashtags. |
Grouped notifications5
Dismiss a single notification grouppost_api_v2_notifications__group_key__dismiss | POST | Dismiss a single notification group from the server. |
Get a single notification groupget_api_v2_notifications__group_key_ | GET | View information about a specific notification group with a given group key. |
Get accounts of all notifications in a notification groupget_api_v2_notifications__group_key__accounts | GET | Returns: Array of Account\ |
Get all grouped notificationsget_api_v2_notifications | GET | Return grouped notifications concerning the user. |
Get the number of unread notificationsget_api_v2_notifications_unread_count | GET | Get the (capped) number of unread notification groups for the current user. |
Health2
Get basic health status as JSONget_health | GET | Responses other than HTTP 200 should be interpreted as some element of the web process not being healthy. |
Get basic health status as JSONget_healthAnonymous | GET | Responses other than HTTP 200 should be interpreted as some element of the web process not being healthy. |
Instance20
List of connected domainsget_api_v1_instance_peers | GET | Domains that this server is aware of. |
List of connected domainsget_api_v1_instance_peersAnonymous | GET | Domains that this server is aware of. |
List of rulesget_api_v1_instance_rules | GET | Rules that the users of this service should follow. |
List of rulesget_api_v1_instance_rulesAnonymous | GET | Rules that the users of this service should follow. |
View a specific version of the terms of serviceget_api_v1_instance_terms_of_service__date_ | GET | Obtain the contents of this server's terms of service, for a specified date, if configured. |
View a specific version of the terms of serviceget_api_v1_instance_terms_of_service__date_Anonymous | GET | Obtain the contents of this server's terms of service, for a specified date, if configured. |
View extended descriptionget_api_v1_instance_extended_description | GET | Obtain an extended description of this server. |
View extended descriptionget_api_v1_instance_extended_descriptionAnonymous | GET | Obtain an extended description of this server. |
View moderated serversget_api_v1_instance_domain_blocks | GET | Obtain a list of domains that have been blocked. |
View moderated serversget_api_v1_instance_domain_blocksAnonymous | GET | Obtain a list of domains that have been blocked. |
View privacy policyget_api_v1_instance_privacy_policy | GET | Obtain the contents of this server's privacy policy. |
View privacy policyget_api_v1_instance_privacy_policyAnonymous | GET | Obtain the contents of this server's privacy policy. |
View server information (v1)get_api_v1_instance | GET | Obtain general information about the server. |
View server information (v1)get_api_v1_instanceAnonymous | GET | Obtain general information about the server. |
View terms of serviceget_api_v1_instance_terms_of_service | GET | Obtain the contents of this server's terms of service, if configured. |
View terms of serviceget_api_v1_instance_terms_of_serviceAnonymous | GET | Obtain the contents of this server's terms of service, if configured. |
View translation languagesget_api_v1_instance_translation_languages | GET | Translation language pairs supported by the translation engine used by the server. |
View translation languagesget_api_v1_instance_translation_languagesAnonymous | GET | Translation language pairs supported by the translation engine used by the server. |
Weekly activityget_api_v1_instance_activity | GET | Server activity over the last 3 months, binned weekly. |
Weekly activityget_api_v1_instance_activityAnonymous | GET | Server activity over the last 3 months, binned weekly. |
Ip Blocks7
Block an IP address range from signing uppost_api_v1_admin_ip_blocks | POST | Add an IP address range to the list of IP blocks. |
Block an IP address range from signing uppost_api_v1_admin_ip_blocksForm | POST | Add an IP address range to the list of IP blocks. |
Delete an IP blockdelete_api_v1_admin_ip_blocks__id_ | DELETE | Lift a block against an IP range. |
Get a single IP blockget_api_v1_admin_ip_blocks__id_ | GET | Show information about a single IP block. |
List all IP blocksget_api_v1_admin_ip_blocks | GET | Show information about all blocked IP ranges. |
Update a domain blockput_api_v1_admin_ip_blocks__id_ | PUT | Change parameters for an existing IP block. |
Update a domain blockput_api_v1_admin_ip_blocks__id_Form | PUT | Change parameters for an existing IP block. |
Lists11
Add accounts to a listpost_api_v1_lists__id__accounts | POST | Add accounts to the given list. |
Create a listpost_api_v1_lists | POST | Create a new list. |
Create a listpost_api_v1_listsForm | POST | Create a new list. |
Delete a listdelete_api_v1_lists__id_ | DELETE | Returns: Empty\ |
Remove accounts from listdelete_api_v1_lists__id__accounts | DELETE | Remove accounts from the given list. |
Remove accounts from listdelete_api_v1_lists__id__accountsForm | DELETE | Remove accounts from the given list. |
Show a single listget_api_v1_lists__id_ | GET | Fetch the list with the given ID. |
Update a listput_api_v1_lists__id_ | PUT | Change the properties of a list. |
Update a listput_api_v1_lists__id_Form | PUT | Change the properties of a list. |
View accounts in a listget_api_v1_lists__id__accounts | GET | Returns: Array of Account\ |
View your listsget_api_v1_lists | GET | Fetch all lists that the user owns. |
Markers3
Get saved timeline positionsget_api_v1_markers | GET | Get current positions in timelines. |
Save your position in a timelinepost_api_v1_markers | POST | Save current position in timeline. |
Save your position in a timelinepost_api_v1_markersForm | POST | Save current position in timeline. |
Measures2
Get measurable datapost_api_v1_admin_measures | POST | Obtain statistical measures for your server. |
Get measurable datapost_api_v1_admin_measuresForm | POST | Obtain statistical measures for your server. |
Media4
Get media attachmentget_api_v1_media__id_ | GET | Get a media attachment, before it is attached to a status and posted, but after it is accepted for processing. |
Update media attachmentput_api_v1_media__id_ | PUT | Update a MediaAttachment's parameters, before it is attached to a status and posted. |
Upload media as an attachment (async)post_api_v2_media | POST | Creates a media attachment to be used with a new status. |
Upload media as an attachment (v1)post_api_v1_media | POST | Creates an attachment to be used with a new status. |
Mutes1
View muted accountsget_api_v1_mutes | GET | Accounts the user has muted. |
Notifications13
Accept a single notification requestpost_api_v1_notifications_requests__id__accept | POST | Accept a notification request, which merges the filtered notifications from that user back into the main notification and accepts any future notification from them. |
Accept multiple notification requestspost_api_v1_notifications_requests_accept | POST | Accepts multiple notification requests, which merges the filtered notifications from those users back into the main notifications and accepts any future notification from them. |
Dismiss a single notificationpost_api_v1_notifications__id__dismiss | POST | Dismiss a single notification from the server. |
Dismiss a single notification requestpost_api_v1_notifications_requests__id__dismiss | POST | Dismiss a notification request, which hides it and prevent it from contributing to the pending notification requests count. |
Dismiss all notificationspost_api_v1_notifications_clear | POST | Clear all notifications from the server. |
Dismiss multiple notification requestspost_api_v1_notifications_requests_dismiss | POST | Dismiss multiple notification requests, which hides them and prevent them from contributing to the pending notification requests count. |
Get a single notificationget_api_v1_notifications__id_ | GET | View information about a notification with a given ID. |
Get a single notification requestget_api_v1_notifications_requests__id_ | GET | View information about a notification request with a given ID. |
Get all notification requestsget_api_v1_notifications_requests | GET | Notification requests for notifications filtered by the user's policy. |
Get all notificationsget_api_v1_notifications | GET | Notifications concerning the user. |
Get the filtering policy for notificationsget_api_v2_notifications_policy | GET | Notifications filtering policy for the user. |
Get the number of unread notificationsget_api_v1_notifications_unread_count | GET | Get the (capped) number of unread notifications for the current user. |
Update the filtering policy for notificationspatch_api_v2_notifications_policy | PATCH | Update the user's notifications filtering policy. |
Notifications Alpha4
Dismiss a single notification grouppost_api_v2_alpha_notifications__group_key__dismiss | POST | Dismiss a single notification group from the server. |
Get a single notification groupget_api_v2_alpha_notifications__group_key_ | GET | View information about a specific notification group with a given group key. |
Get all grouped notificationsget_api_v2_alpha_notifications | GET | Return grouped notifications concerning the user. |
Get the number of unread notificationsget_api_v2_alpha_notifications_unread_count | GET | Get the (capped) number of unread notification groups for the current user. |
OAuth3
Discover OAuth Server Configurationget_.well-known_oauth-authorization-server | GET | Returns the OAuth 2 Authorization Server Metadata for the Mastodon server, as defined by RFC 8414. |
Discover OAuth Server Configurationget_.well-known_oauth-authorization-serverAnonymous | GET | Returns the OAuth 2 Authorization Server Metadata for the Mastodon server, as defined by RFC 8414. |
Retrieve user informationget_oauth_userinfo | GET | Retrieves standardised OIDC claims about the currently authenticated user.\ |
Oembed2
Get OEmbed info as JSONget_api_oembed | GET | Returns: OEmbed metadata\ |
Get OEmbed info as JSONget_api_oembedAnonymous | GET | Returns: OEmbed metadata\ |
Polls4
View a pollget_api_v1_polls__id_ | GET | View a poll attached to a status. |
View a pollget_api_v1_polls__id_Anonymous | GET | View a poll attached to a status. |
Vote on a pollpost_api_v1_polls__id__votes | POST | Vote on a poll attached to a status. |
Vote on a pollpost_api_v1_polls__id__votesForm | POST | Vote on a poll attached to a status. |
Preferences1
View user preferencesget_api_v1_preferences | GET | Preferences defined by the user in their account settings. |
Profile3
Delete profile avatardelete_api_v1_profile_avatar | DELETE | Returns: CredentialAccount\ |
Delete profile headerdelete_api_v1_profile_header | DELETE | Returns: CredentialAccount\ |
Get current user profileget_api_v1_profile | GET | Returns: Profile\ |
Push6
Change types of notificationsput_api_v1_push_subscription | PUT | Updates the current push subscription. |
Change types of notificationsput_api_v1_push_subscriptionForm | PUT | Updates the current push subscription. |
Get current subscriptionget_api_v1_push_subscription | GET | View the PushSubscription currently associated with this access token. |
Remove current subscriptiondelete_api_v1_push_subscription | DELETE | Removes the current Web Push API subscription. |
Subscribe to push notificationspost_api_v1_push_subscription | POST | Add a Web Push API subscription to receive notifications. |
Subscribe to push notificationspost_api_v1_push_subscriptionForm | POST | Add a Web Push API subscription to receive notifications. |
Reports2
File a reportpost_api_v1_reports | POST | Report problematic accounts and contents to your moderators. |
File a reportpost_api_v1_reportsForm | POST | Report problematic accounts and contents to your moderators. |
Retention2
Calculate retention datapost_api_v1_admin_retention | POST | Generate a retention data report for a given time period and bucket. |
Calculate retention datapost_api_v1_admin_retentionForm | POST | Generate a retention data report for a given time period and bucket. |
Revoke4
Revoke a tokenpost_oauth_revoke | POST | Revoke an access token to make it no longer valid for use. |
Revoke a tokenpost_oauth_revokeAnonymous | POST | Revoke an access token to make it no longer valid for use. |
Revoke a tokenpost_oauth_revokeForm | POST | Revoke an access token to make it no longer valid for use. |
Revoke a tokenpost_oauth_revokeFormAnonymous | POST | Revoke an access token to make it no longer valid for use. |
Scheduled Statuses5
Cancel a scheduled statusdelete_api_v1_scheduled_statuses__id_ | DELETE | Returns: Empty\ |
Update a scheduled status's publishing dateput_api_v1_scheduled_statuses__id_ | PUT | Returns: ScheduledStatus\ |
Update a scheduled status's publishing dateput_api_v1_scheduled_statuses__id_Form | PUT | Returns: ScheduledStatus\ |
View a single scheduled statusget_api_v1_scheduled_statuses__id_ | GET | Returns: ScheduledStatus\ |
View scheduled statusesget_api_v1_scheduled_statuses | GET | Returns: Array of ScheduledStatus\ |
Search2
Perform a searchget_api_v2_search | GET | Perform a search for content in accounts, statuses and hashtags with the given parameters. |
Perform a searchget_api_v2_searchAnonymous | GET | Perform a search for content in accounts, statuses and hashtags with the given parameters. |
Statuses35
Bookmark a statuspost_api_v1_statuses__id__bookmark | POST | Privately bookmark a status. |
Boost a statuspost_api_v1_statuses__id__reblog | POST | Reshare a status on your own profile. |
Boost a statuspost_api_v1_statuses__id__reblogForm | POST | Reshare a status on your own profile. |
Delete a statusdelete_api_v1_statuses__id_ | DELETE | Delete one of your own statuses. |
Edit a statusput_api_v1_statuses__id_ | PUT | Edit a given status to change its text, sensitivity, media attachments, or poll. |
Edit a statusput_api_v1_statuses__id_Form | PUT | Edit a given status to change its text, sensitivity, media attachments, or poll. |
Edit a status' interaction policiesput_api_v1_statuses__id__interaction_policy | PUT | Edit a given status to change its interaction policies. |
Edit a status' interaction policiesput_api_v1_statuses__id__interaction_policyForm | PUT | Edit a given status to change its interaction policies. |
Favourite a statuspost_api_v1_statuses__id__favourite | POST | Add a status to your favourites list. |
Get parent and child statuses in contextget_api_v1_statuses__id__context | GET | View statuses above and below this status in the thread. |
Get parent and child statuses in contextget_api_v1_statuses__id__contextAnonymous | GET | View statuses above and below this status in the thread. |
Mute a conversationpost_api_v1_statuses__id__mute | POST | Do not receive notifications for the thread that this status is part of. |
Pin status to profilepost_api_v1_statuses__id__pin | POST | Feature one of your own public statuses at the top of your profile. |
Post a new statuspost_api_v1_statuses | POST | Publish a status with the given parameters. |
Post a new statuspost_api_v1_statusesForm | POST | Publish a status with the given parameters. |
Revoke a quote postpost_api_v1_statuses__id__quotes__quoting_status_id__revoke | POST | Revoke quote authorization of status quoting status id, detaching status id. |
See quotes of a statusget_api_v1_statuses__id__quotes | GET | View quotes of a status. |
See who boosted a statusget_api_v1_statuses__id__reblogged_by | GET | View who boosted a given status. |
See who boosted a statusget_api_v1_statuses__id__reblogged_byAnonymous | GET | View who boosted a given status. |
See who favourited a statusget_api_v1_statuses__id__favourited_by | GET | View who favourited a given status. |
See who favourited a statusget_api_v1_statuses__id__favourited_byAnonymous | GET | View who favourited a given status. |
Translate a statuspost_api_v1_statuses__id__translate | POST | Translate the status content into some language. |
Translate a statuspost_api_v1_statuses__id__translateForm | POST | Translate the status content into some language. |
Undo bookmark of a statuspost_api_v1_statuses__id__unbookmark | POST | Remove a status from your private bookmarks. |
Undo boost of a statuspost_api_v1_statuses__id__unreblog | POST | Undo a reshare of a status. |
Undo favourite of a statuspost_api_v1_statuses__id__unfavourite | POST | Remove a status from your favourites list. |
Unmute a conversationpost_api_v1_statuses__id__unmute | POST | Start receiving notifications again for the thread that this status is part of. |
Unpin status from profilepost_api_v1_statuses__id__unpin | POST | Unfeature a status from the top of your profile. |
View a single statusget_api_v1_statuses__id_ | GET | Obtain information about a status. |
View a single statusget_api_v1_statuses__id_Anonymous | GET | Obtain information about a status. |
View edit history of a statusget_api_v1_statuses__id__history | GET | Get all known versions of a status, including the initial and current states. |
View edit history of a statusget_api_v1_statuses__id__historyAnonymous | GET | Get all known versions of a status, including the initial and current states. |
View multiple statusesget_api_v1_statuses | GET | Obtain information about multiple statuses. |
View multiple statusesget_api_v1_statusesAnonymous | GET | Obtain information about multiple statuses. |
View status sourceget_api_v1_statuses__id__source | GET | Obtain the source properties for a status so that it can be edited. |
Streaming2
Check if the server is aliveget_api_v1_streaming_health | GET | Verify that the streaming service is alive before connecting to it |
Check if the server is aliveget_api_v1_streaming_healthAnonymous | GET | Verify that the streaming service is alive before connecting to it |
Suggestions3
Remove a suggestiondelete_api_v1_suggestions__account_id_ | DELETE | Remove an account from follow suggestions. |
View follow suggestions (v1)get_api_v1_suggestions | GET | Accounts the user has had past positive interactions with, but is not yet following. |
View follow suggestions (v2)get_api_v2_suggestions | GET | Accounts that are promoted by staff, or that the user has had past positive interactions with, but is not yet following. |
Tags6
Feature a hashtagpost_api_v1_tags__id__feature | POST | Feature the hashtag on your profile. |
Follow a hashtagpost_api_v1_tags__name__follow | POST | Follow a hashtag. |
Unfeature a hashtagpost_api_v1_tags__id__unfeature | POST | Stop featuring the hashtag on your profile. |
Unfollow a hashtagpost_api_v1_tags__name__unfollow | POST | Unfollow a hashtag. |
View information about a single tagget_api_v1_tags__name_ | GET | Show a hashtag and its associated information |
View information about a single tagget_api_v1_tags__name_Anonymous | GET | Show a hashtag and its associated information |
Timelines8
View hashtag timelineget_api_v1_timelines_tag__hashtag_ | GET | View public statuses containing the given hashtag. |
View hashtag timelineget_api_v1_timelines_tag__hashtag_Anonymous | GET | View public statuses containing the given hashtag. |
View home timelineget_api_v1_timelines_home | GET | View statuses from followed users and hashtags. |
View link timelineget_api_v1_timelines_link | GET | View public statuses containing a link to the specified currently-trending article. |
View link timelineget_api_v1_timelines_linkAnonymous | GET | View public statuses containing a link to the specified currently-trending article. |
View list timelineget_api_v1_timelines_list__list_id_ | GET | View statuses in the given list timeline. |
View public timelineget_api_v1_timelines_public | GET | View public statuses. |
View public timelineget_api_v1_timelines_publicAnonymous | GET | View public statuses. |
Token4
Obtain a tokenpost_oauth_token | POST | Obtain an access token, to be used during API calls that are not public. |
Obtain a tokenpost_oauth_tokenAnonymous | POST | Obtain an access token, to be used during API calls that are not public. |
Obtain a tokenpost_oauth_tokenForm | POST | Obtain an access token, to be used during API calls that are not public. |
Obtain a tokenpost_oauth_tokenFormAnonymous | POST | Obtain an access token, to be used during API calls that are not public. |
Trends6
View trending linksget_api_v1_trends_links | GET | Links that have been shared more than others. |
View trending linksget_api_v1_trends_linksAnonymous | GET | Links that have been shared more than others. |
View trending statusesget_api_v1_trends_statuses | GET | Statuses that have been interacted with more than others. |
View trending statusesget_api_v1_trends_statusesAnonymous | GET | Statuses that have been interacted with more than others. |
View trending tagsget_api_v1_trends_tags | GET | Tags that are being used more frequently within the past week. |
View trending tagsget_api_v1_trends_tagsAnonymous | GET | Tags that are being used more frequently within the past week. |