Mastodon API Specification (https://github.com/mastodon/mastodon), an HTTP API described by an OpenAPI document.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: http://mastodon.local https://mastodon.social
auth: b e a r ,
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
Mastodon API Specification (https://github.com/mastodon/mastodon), an HTTP API described by an OpenAPI document.
| method | path | what the vendor says it does |
|---|---|---|
GET | /api/oembed | OEmbed as JSON |
GET | /api/proofs | View identity proof |
POST | /api/v1/accounts | Creates a user and account records. Returns an account access token for the app that initiated the request. Th |
GET | /api/v1/accounts/relationships | Sets a private note on a user. accounts |
GET | /api/v1/accounts/search | Search for matching accounts by username or display name. accounts |
PATCH | /api/v1/accounts/update_credentials | Update the user's display and preferences. accounts |
GET | /api/v1/accounts/verify_credentials | Test to make sure that the user token works. accounts |
POST | /api/v1/accounts/{id}/block | Block the given account. Clients should filter statuses from this account if received (e.g. due to a boost in |
GET | /api/v1/accounts/{id}/featured_tags | Tags featured by this account. accounts |
POST | /api/v1/accounts/{id}/follow | Follow the given account. Can also be used to update whether to show reblogs or enable notifications. accounts |
GET | /api/v1/accounts/{id}/followers | Accounts which follow the given account, if network is not hidden by the account owner. accounts |
GET | /api/v1/accounts/{id}/following | Accounts which the given account is following, if network is not hidden by the account owner. accounts |
GET | /api/v1/accounts/{id}/identity_proofs | Array of IdentityProof accounts |
GET | /api/v1/accounts/{id}/lists | User lists that you have added this account to. accounts |
POST | /api/v1/accounts/{id}/mute | Mute the given account. Clients should filter statuses and notifications from this account, if received (e.g. |
POST | /api/v1/accounts/{id}/note | Sets a private note on a user. accounts |
POST | /api/v1/accounts/{id}/pin | Add the given account to the user's featured profiles. (Featured profiles are currently shown on the user's ow |
GET | /api/v1/accounts/{id}/statuses | Statuses posted to the given account. accounts |
POST | /api/v1/accounts/{id}/unblock | Block the given account. Clients should filter statuses from this account if received (e.g. due to a boost in |
POST | /api/v1/accounts/{id}/unfollow | Unfollow the given account. accounts |
POST | /api/v1/accounts/{id}/unmute | Unmute the given account. accounts |
POST | /api/v1/accounts/{id}/unpin | Remove the given account from the user's featured profiles. accounts |
GET | /api/v1/admin/accounts | View accounts matching certain criteria for filtering, up to 100 at a time. Pagination may be done with the HT |
GET | /api/v1/admin/accounts/{id} | View admin-level information about the given account. |
POST | /api/v1/admin/accounts/{id}/action | Perform an action against an account and log this action in the moderation history. |
POST | /api/v1/admin/accounts/{id}/approve | Approve the given local account if it is currently pending approval. |
POST | /api/v1/admin/accounts/{id}/enable | Re-enable a local account whose login is currently disabled. |
POST | /api/v1/admin/accounts/{id}/reject | Reject the given local account if it is currently pending approval. |
POST | /api/v1/admin/accounts/{id}/unsilence | Unsilence a currently silenced account. |
POST | /api/v1/admin/accounts/{id}/unsuspend | Unsuspend a currently suspended account. |
GET | /api/v1/admin/reports | View all reports. Pagination may be done with HTTP Link header in the response. |
GET | /api/v1/admin/reports/{id} | View information about the report with the given ID. |
POST | /api/v1/admin/reports/{id}/assign_to_self | Claim the handling of this report to yourself. |
POST | /api/v1/admin/reports/{id}/reopen | Mark a report as resolved with no further action taken. |
POST | /api/v1/admin/reports/{id}/resolve | Mark a report as resolved with no further action taken. |
POST | /api/v1/admin/reports/{id}/unassign | Unassign a report so that someone else can claim it. |
GET | /api/v1/announcements | See all currently active announcements set by admins. |
POST | /api/v1/announcements/{id}/dismiss | Allows a user to mark the announcement as read. |
PUT | /api/v1/announcements/{id}/reactions/{name} | Allows a user to mark the announcement as read. |
DELETE | /api/v1/announcements/{id}/reactions/{name} | Undo a react emoji to an announcement. |
and 80 more operation(s) in this specification, all searchable.
specification origin: https://raw.githubusercontent.com/oneslash/mastodon/feat/add-open-api-spec/api-specificati
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.