API Entities

Represents a user of Mastodon and their associated profile.

Admin-level information about a given account.

Represents a canonical email block (hashed).

Represents a retention metric.

Represents qualitative data about the server.

Represents a domain allowed to federate.

Represents a domain limited from federating.

Represents an email domain that cannot be used to sign up.

Represents an IP address associated with a user.

Represents an IP address range that cannot be used to sign up.

Represents quantitative data about the server.

Admin-level information about a filed report.

Represents an announcement set by an administrator.

Represents an application that interfaces with the REST API to access accounts or post statuses.

Represents the tree around a given status. Used for reconstructing threads of statuses.

Represents a conversation with “direct message” visibility.

Represents a custom emoji.

Represents a domain that is blocked by the instance.

Represents an error message.

Represents an extended description for the instance, to be shown on its about page.

Represents a subset of your follows who also follow some other user.

Represents a hashtag that is featured on a profile.

Represents a user-defined filter for determining which statuses should not be shown to the user.

Represents a keyword that, if matched, should cause the filter action to be taken.

Represents a filter whose keywords matched a given status.

Represents a status ID that, if matched, should cause the filter action to be taken.

Represents a proof from an external identity provider.

Represents the software instance of Mastodon running on this domain.

Represents a list of some users that the authenticated user follows.

Represents the last read position within a user’s timelines.

Represents a file or media attachment that can be added to a status.

Represents a notification of an event relevant to the user.

Represents a poll attached to a status.

Represents a user’s preferences.

Represents a rich preview card that is generated using OpenGraph tags from a URL.

Represents an emoji reaction to an Announcement.

Represents the relationship between accounts, such as following / blocking / muting / etc.

Reports filed against users and/or statuses, to be taken action on by moderators.

Represents a custom user role that grants permissions.

Represents a rule that server users should follow.

Represents a status that will be published at a future scheduled date.

Represents the results of a search.

Represents a status posted by an account.

Represents a revision of a status that has been edited.

Represents a status’s source as plain text.

Represents a suggested account to follow and an associated reason for the suggestion.

Represents a hashtag used within the content of a status.

Represents an OAuth token used for authenticating with the API and performing actions.

Example { "content": "<p>Hola mundo</p>", "detected_source_language": "en", "provider": "DeepL.com" } Attributes content Description: The translated text of the status. Type: String (HTML) Version history: 4.0.0 - added detected_source_language Description: The language of the source text, as auto-detected by the machine translation provider. Type: String (ISO 639 language code) Version history: 4.0.0 - added provider Description: The service that provided the machine translation. Type: String Version history: 4.0.0 - added

Represents a user-defined filter for determining which statuses should not be shown to the user. Contains a single keyword or phrase.

Represents the software instance of Mastodon running on this domain.

Represents a subscription to the push streaming server.