Schemas
The schemas of the requests and responses of the client API, each with its fields and an example.
Account: An account, as clients show it.AccountAlias: An account that the user moves from:AccountAliasList: The aliases of the user, oldest first; at most 5.AccountBadge: A badge that the account shows on its profile:AccountFieldSource: A metadata field of a profile as the user typed it.AccountList: The accounts, best match first.AccountMove: The move that an account_moved or an admin_account_moved tells of:AccountNoteUpdate: The viewer's private note on an account.AccountPage: A page of accounts.AccountSource: The profile as the user typed it, for editing.AccountStatusPage: A page of the statuses of an account.AccountSuggestion: An account suggested to follow, with why it is suggested.AccountSuggestionList: The suggested accounts.AddAccountAliasRequest: The account to add as an alias.AdminAccount: An account as the moderators see it.AdminAccountAction: A moderation action on an account.AdminAccountActionPage: A page of account actions, newest first.AdminAccountDetail: The details of an account.AdminAccountInvite: The invite that a local account signed up with, and who created it, which invited the user.AdminAccountPage: A page of accounts, newest first.AdminAccountPrivateData: The email address and the IP addresses of a local account.AdminAccountRegistration: The registration application of a local account.AdminAccountSignIn: Where one sign-in came from.AdminAccountSignInPage: A page of the sign-ins of an account, newest first.AdminAnnouncement: An announcement with its Markdown text and its state.AdminAnnouncementCreateRequest: A new announcement, with its title, its text, and its window.AdminAnnouncementInput: The title, the text, and the window of an announcement.AdminAnnouncementPage: A page of announcements, newest first.AdminAppeal: A local user's appeal of an action on their account, as the moderators see it, with the action.AdminAppealPage: A page of appeals, newest first.AdminAuditEntry: One operation of a moderator or an administrator.AdminAuditEntryPage: A page of the audit log, newest first.AdminAvailabilityEvent: The time a remote server was marked unavailable or available again, and why.AdminAvailabilityEventPage: A page of availability events, newest first.AdminBrandImage: A brand image as the administrators see it:AdminBrands: The brand images of the instance; a kind that uses the built-in images is omitted.AdminCounts: What awaits the staff; a count whose permission the user lacks is omitted.AdminCustomEmoji: A custom emoji as the administrators manage it:AdminCustomEmojiPage: A page of custom emoji.AdminCustomEmojiRequest: A custom emoji request as the administrators review it, with the requester.AdminCustomEmojiRequestPage: A page of custom emoji requests with their requesters.AdminDelivery: The delivery of an activity to one inbox of a remote server, with its attempts.AdminDeliveryAttempt: One attempt of a delivery.AdminDeliveryPage: A page of the deliveries to a remote server, newest first.AdminDeliveryReveal: The fields of a delivery that the list masks.AdminDeliverySender: The local account that sent the activity.AdminDomainAction: A moderation action on a remote domain and its subdomains.AdminDomainActionPage: A page of domain actions, newest first.AdminDomainListDraft: A difference between a subscribed list and the actions the subscription issued, waiting for a moderator.AdminDomainListDraftList: The drafts of a subscription, the lifts first, each by domain and kind.AdminDomainListDraftResult: What accepting or rejecting drafts did.AdminDomainListFetch: One fetch of a subscribed domain block list.AdminDomainListFetchPage: A page of the fetches of a subscription, newest first.AdminDomainListSubscription: A subscription to a domain block list that another server or person publishes.AdminDomainListSubscriptionPage: A page of subscriptions to domain block lists, newest first.AdminEventCancel: A moderator cancelling an event.AdminEventCancellation: The cancellation of an event as the moderators see it.AdminEventRevision: A revision of the settings of an event with all its places.AdminHook: A decision hook with its settings and the decisions of the period.AdminHookAppeal: An author's appeal of a reject of local.status, with the text the author tried to post.AdminHookAppealPage: A page of appeals, the newest first.AdminHookDecision: What a decision hook answered about one subject.AdminHookDecisionPage: A page of decisions, the newest first.AdminHookOutcome: How many decisions of one mode and outcome a hook made, and how long they took.AdminHookSummary: Every decision hook with its settings, and its decisions of the last 7 days.AdminIncomePeriodTotal: A week, month, or year of the income totals as the administrators see it:AdminIncomeTotals: The income totals as the administrators see them over the periods from the one that holds from to the one that holds to, oldest first, with the number of members of each supporter plan now, and tips, whether the server takes tips now.AdminInstanceHealth: Whether deliveries go to a remote server.AdminInstanceHealthPage: A page of server health, in domain order.AdminInstanceText: The current text of a key, the same in every locale.AdminInstanceTextList: The current instance texts, by key.AdminInvite: An invite that lets people sign up while the registration mode is open, approval, or invite.AdminInvitePage: A page of invites, newest first.AdminJob: A job of the job queue.AdminJobAttempt: A run of a job that did not succeed.AdminJobAttemptPage: A page of attempts, the most recently finished first.AdminJobCount: The number of jobs of one type in one state.AdminJobPage: A page of jobs.AdminJobWait: How long a job type has kept a job waiting.AdminLoginProvider: An external login provider that users sign in, sign up, and link their accounts with.AdminLoginProviderList: The login providers, newest first.AdminOAuthClient: An OAuth client, as the administrators see it.AdminOAuthClientHostDenial: A host whose Client ID Metadata Documents an administrator denied.AdminOAuthClientHostDenialPage: A page of the denied hosts, newest denial first.AdminOAuthClientPage: A page of OAuth clients, newest first.AdminPasswordResetLink: A password reset link that an administrator issued for a local account.AdminQueue: The state of the job queue.AdminRegistration: A user's registration as the moderators review it.AdminRegistrationPage: A page of registrations, longest in their state first.AdminRelay: A relay that the instance joins or joined.AdminRelayList: The relays, in registration order.AdminReport: A report of an account to the moderators.AdminReportDetail: A report as a moderator opens it:AdminReportEvent: The event that a report points at, as the moderators review it:AdminReportHookOrigin: The decision hook that filed the report; omitted for a report that a person or another server filed.AdminReportNote: A moderator's internal note on a report; never shown to the target or the reporter.AdminReportPage: A page of reports, newest first.AdminReportStatus: A post that a report points at, as a moderator reviews it.AdminReportTargetHistory: What the moderators had about the target of a report.AdminReportVoiceRoom: The voice chat room that a report points at, as the moderators review it:AdminRole: A role:AdminRoleList: Roles, highest position first.AdminRoleSupporterPlan: The supporter plan that grants a role to its subscribers, and so manages it.AdminRule: A rule of the instance.AdminRuleList: The rules.AdminSameIpAccounts: The other accounts that used one IP address.AdminServiceClosure: The service closure as its administrators see it.AdminServiceClosureCheck: What the administrator reviews before closing the server.AdminServiceClosureDeliveries: The deliveries of the closure's Deletes by state.AdminServiceClosureProgress: How far the closure's Delete of every local actor has gone, in GET /api/v1/admin/closure once the server is closed.AdminSetting: An instance setting:AdminSettingImage: The image of a media setting (preview_image, thumbnail):AdminSettingList: Every instance setting, in a fixed order.AdminSignupBlock: A block on sign-ups from the registration page.AdminSignupBlockPage: A page of sign-up blocks, newest first.AdminSupporterPlan: A supporter plan as the administrators see it.AdminSupporterPlanCreateRequest: A new supporter plan on a role that nobody holds, whose permissions are member permissions and whose position is below every staff role.AdminSupporterPlanList: Every supporter plan, retired ones too, by rank.AdminSupporterPlanRole: The role of a supporter plan, which only its subscriptions grant.AdminSupporterPlanUpdateRequest: A change of a supporter plan; an omitted property keeps its value.AdminSupporterProgram: The supporter program.AdminSupporterProgramRequest: Enables or disables the supporter program.AdminSupporterSubscription: A subscription as the administrators see it, without the history of its payments.AdminSupporterSubscriptionPage: A page of subscriptions, newest first.AdminSupporterTipLimits: The smallest and largest amount that the tips may offer in a currency.AdminSupporterTips: The tips:AdminSupporterTipsRequest: Enables the tips with their amounts, all in one currency, or disables them (enabled false, without amounts).AdminTheme: The instance theme as its administrators edit it.AdminThemeRevision: A publication of a token set, which made it the theme in effect.AdminTranslationOverview: How translation is used in the current month, and the providers that this server has.AdminVoiceRoomBan: An account removed from a voice chat room, who may not join it again.AdminVoiceRoomEnd: A moderator ending an open voice chat room.AdminVoiceRoomParticipation: An account taking part in a voice chat room, from joining to leaving.AdminVoiceRoomRevision: A revision of the settings of a voice chat room.AdminWebhook: A webhook endpoint.AdminWebhookAttempt: The last attempt of a delivery.AdminWebhookCreated: A new webhook and its secret.AdminWebhookDelivery: A message to a webhook and its attempts.AdminWebhookDeliveryPage: A page of the deliveries of a webhook, newest first.AdminWebhookFailure: The attempts that failed since the last success; omitted when the last attempt succeeded.AdminWebhookList: The webhooks, newest first.AdminWebhookSecret: A new secret of a webhook.Announcement: An announcement of the server to every local user, as the user sees it.AnnouncementList: The announcements.AnnouncementPage: A page of announcements.AnnounceServiceClosureRequest: The schedule of an announcement of the closure of the service.AppealHookDecisionRequest: An appeal of a post that the automated review refused.AppealModerationActionRequest: An appeal of an action on the user's own account.ArticleCoverInput: The cover image of an article:ArticlePreview: The body of an article as publishing it would store it.ArticlePreviewRequest: The body of an article to preview.ArticleSource: What the author wrote of an article besides its Markdown body, for editing it.AuthorizedApp: An app the authenticated user authorized:AuthorizedAppList: The apps the authenticated user authorized, one per client, most recently used first.AutoDeleteLimit: The server maximum of the automatic deletion of old posts:AutoDeletePolicy: The authenticated user's automatic deletion of their own old posts.AutoDeletePreview: What a draft automatic deletion policy would delete now:AutoDeleteServerLimit: The server maximum as it applies to the authenticated user, and the policy that the automatic deletion uses under it.AutoDeleteSettings: The authenticated user's automatic deletion of their own old posts as they saved it, with the server maximum when it applies to them.BadgeChoice: A role that the authenticated user holds and that has a badge, with whether the user shows the badge on their profile.BadgeChoiceList: The roles with a badge that the authenticated user holds, highest position first; empty when there are none.BillingImport: The state of the imports of a billing source.BillingImportList: The billing sources and the state of their imports.BillingImportMonth: A billing month of a source:BillingImportRun: The last attempt of a billing import; omitted before the first.BrandDropped: Something the server removed from an uploaded SVG:BrandError: Why a brand image cannot be saved.BrandFile: A PNG rendition of a brand image, served at a URL whose content never changes.BrandProblem: A 422 of the brand image operations.BrandRenditionSize: A rendition that a brand image needs, and its size in pixels.BrandSanitized: An SVG as the server would save it:BrowserSession: A browser signed in to the authenticated user's account.BrowserSessionList: The browsers signed in to the authenticated user's account, the one that asks first.ChangePasswordRequest: A change of the user's password, confirmed with current_password, passkey, or external_confirmation.ClientErrorReport: An uncaught error of the web client.ClientMeasurement: One sample of how fast the web client responded.ClientMeasurementReport: Samples of how fast the web client responded, sent together.CloseServiceRequest: The confirmation of the closure of the server.Conversation: A conversation of the user's direct messages:ConversationPage: A page of the user's direct messages by conversation.CopyCustomEmojiRequest: The local custom emoji that a copy of a remote one becomes.CostBreakdownLine: The amount of a provider, category, and currency in a period.CostItem: A cost of the instance that is not deleted, with its current label and end and every price revision.CostItemCreateRequest: A new cost item.CostItemEndRequest: The end of a cost item:CostItemLabelRequest: A change of a cost item's label; an omitted property keeps its value.CostItemPage: A page of cost items, newest first.CostPeriodTotal: A week, month, or year of the totals (label:CostPriceRevision: A price of a cost item for its payments on or after effective_on, until a later revision; of revisions with the same date, the last recorded wins.CostPriceRevisionRequest: A price for the payments on or after effective_on, on or after the start date:CostSourceRule: The cut of an imported provider's billing months:CostTotals: The totals of the instance's costs over the periods from the one that holds from to the one that holds to, oldest first.CostTotalsRules: How the totals cut the periods, to show next to them:CreateAccountActionRequest: A moderation action to take on an account.CreateArticleRequest: A new article.CreateCustomEmojiRequest: A new local custom emoji.CreateDomainActionRequest: A moderation action to take on a domain.CreateDomainAllowRequest: A domain to allow.CreateDomainListSubscriptionRequest: A new subscription to a domain block list.CreateInviteRequest: A new invite.CreateLoginProviderRequest: A new login provider.CreateOAuthAppRequest: A new OAuth app.CreateOwnInviteRequest: A new invite of the user's own, within the caps of the instance settings.CreatePasskeyRequest: The browser's answer to a passkey registration.CreateRelayRequest: A relay to register and join.CreateReportNoteRequest: A note to add to a report.CreateReportRequest: A report of an account to the moderators.CreateRoleRequest: A new role.CreateSignupBlockRequest: A new block on sign-ups.CreateStatusRequest: A new status.CreateWebhookRequest: A new webhook.CredentialAccount: The authenticated user's own account, with what only its owner sees.CustomEmoji: A custom emoji that a text uses.CustomEmojiProblem: The problem of a custom emoji that breaks a rule (422, /api/v1/problems/invalid-custom-emoji); reason says which.CustomEmojiRequest: A request of a holder of create_custom_emojis for a new local custom emoji, or for a new image of one they made, which a holder of manage_custom_emojis approves or rejects.CustomEmojiRequestPage: A page of custom emoji requests.CustomEmojiRequestProblem: The problem of a custom emoji request that cannot be decided or withdrawn (409, /api/v1/problems/custom-emoji-request-conflict); reason says why.DataExport: A request for an archive of the user's data.DataExportList: The user's latest data exports, newest first.DataImport: An import of a CSV file, with its progress.DataImportList: The user's latest imports, newest first.DataImportPreview: What an import of a CSV file would do.DataImportRequest: A CSV file to import, and how.DataImportSkipped: A line of a CSV file that is not an entry.DeactivateOwnAccountRequest: The confirmation of the deactivation of the user's own account:Deactivation: The deactivation of the user's own account.DeactivationPreview: What deactivating the user's own account would do now.DecideAppealRequest: The moderators' explanation of a decision on an appeal.DeleteOwnAccountRequest: The confirmation of the deletion of the user's own account:DenyOAuthClientHostRequest: A host to deny.DomainAllow: A domain of the allowlist of federation, which covers its subdomains.DomainAllowList: The allowed domains, by domain.DomainBlock: A row of Mastodon's domain block CSV.DomainBlockImportPreview: What importing each row of a domain block CSV would do, in row order.DomainBlockImportResult: What an import of domain blocks did.DomainBlockImportRow: A row of a domain block CSV and what importing it would do.DomainBlockImportSkipped: A block of an import that issued nothing.DomainListDraftsRequest: The drafts to accept or reject, by key; omitted or empty for every draft.DomainMute: A domain that the viewer mutes, with its subdomains.DomainMutePage: A page of domain mutes.DomainSuspendImpact: What a suspend of a domain would end now:Draft: A draft of a post or of an article (article), saved on the server so that the user goes on writing it on another device, and publishes it at once or at a chosen time.DraftArticle: What makes a draft that of an article:DraftArticleInput: Makes the draft that of an article, whose text is the body in Markdown.DraftPage: A page of drafts, newest first.DraftPoll: The poll of a draft.DraftRequest: The whole content of a draft; a save replaces what the draft had.DraftScheduleOutcome: How the newest schedule of a draft that is over ended.DraftScheduleRequest: When to publish a draft.EditArticleRequest: The new content of an article.EditStatusRequest: The new content of a status.EmailSuppression: The suppression of the primary email address:EnableTotpRequest: The setup to enroll and a code of the app that shows it has the secret.ErrorGroup: An error group:ErrorGroupDetail: An error group with its latest occurrence, its hourly counts, and the changes of its state.ErrorGroupEvent: A change of the state of an error group:ErrorGroupHourCount: The occurrences of an error group in one hour.ErrorGroupPage: A page of error groups, the most recently seen first.ErrorGroupSample: The latest occurrence of an error group, scrubbed.Event: An event of the local users of this server, as the user sees it.EventAttendee: An attendee of an event, who answered going or maybe.EventAttendeePage: A page of the attendees of an event, in the order of their answers.EventBallot: The answer of a user to a candidate date.EventBallotPage: A page of the answers to a candidate date, in the order of the users' IDs.EventBoardAccess: What the user may do with the board of an event.EventBoardPage: A page of the posts of the board of an event, newest first.EventBoardPostCreate: A new post on the board of an event.EventCancellation: The cancellation of an event.EventCancelRequest: The cancellation of an event by its organizer.EventCandidate: A candidate date of an event's date poll, with how many users answered it each way.EventCandidateCreate: A candidate date of an event's date poll, in UTC.EventCandidateList: The candidate dates of an event's date poll, the earliest start first; up to 20.EventCreate: A new event, either with a fixed date (starts_at and ends_at) or with the candidate dates of a date poll (candidates), not both.EventInvitation: An invitation to an event.EventInvitationCreate: An invitation of a user to an event.EventInvitationPage: A page of the invitations of an event that were not revoked, oldest first.EventPage: A page of the events that the user sees and that have not ended, the nearest start first.EventPlace: A place of an event.EventReminders: The reminders of events of the authenticated user.EventRemindersUpdate: A change of the reminders of events of the authenticated user.EventRSVP: An answer to an event.EventUpdate: Changes to an event; an omitted field keeps its value, and places replaces every place.EventViewer: What an event says of the user who reads it.EventVoteUpdate: An answer to a candidate date.ExternalAuthorizationStart: Where the browser goes to sign in at a login provider.ExternalConfirmationRequest: The linked login provider to confirm an operation with.FeaturedHashtag: A hashtag that an account features on its profile, with how many of the account's public and unlisted posts that this server has carry it.FeaturedHashtagCollection: The hashtags that an account features on its profile, at most 10, in the order it chose.FederationScopeImpact: What switching the instance setting federation_scope to allowlist with the current allowlist would end now:FederationScopeImpactDomain: The follows with one server that switching to the allowlist would end.FilterResult: A keyword filter of the user with the action warn that a post matched, and the words it matched.FinanceCostItemLine: The amount of a cost item, or of a service of the imported costs, in a currency over a period, with the provider and the category of its breakdown line.FinanceCostPeriodTotal: A week, month, or year of the totals, as in CostPeriodTotal, with the item lines of the period:FinanceCostTotals: The totals of the instance's costs as the holders of view_finance read them over the periods from the one that holds from to the one that holds to, oldest first, and the instance settings that decide what they read.FinanceViewerSettings: What the holders of view_finance read of the instance's finances beyond the totals and their breakdown, by instance settings:FollowAccountRequest: The viewer's preferences of the follow; a preference left out keeps its value.FollowedHashtag: A hashtag that the user follows.FollowedHashtagCollection: The hashtags that the user follows, at most 100, the latest followed first.ForwardReportRequest: What a moderator sends with a report forwarded to the target's server.FundingMeter: How far this month's net income goes toward the instance's monthly target (the instance setting funding_meter_visibility):Hashtag: A hashtag and whether the user follows it.ImportDomainBlocksRequest: The rows of a domain block CSV to import.ImportSignupBlocksRequest: A list of values to block sign-ups by, all with the same settings.IncomeMovement: A money movement of the payment provider as the income records keep it:IncomeMovementPage: A page of money movements, newest first.IncomePeriodTotal: A week, month, or year of the income totals (label:IncomePlanCount: The number of members of a supporter plan now:IncomeProviderRule: The IANA time zone (UTC, Asia/Tokyo) in which a payment provider's money movements fall on their dates:IncomeSourceNet: The net of one source over a period, by currency.IncomeTotals: The income totals over the periods from the one that holds from to the one that holds to, oldest first.IncomeTotalsRules: How the income totals cut the periods and place the payments, to show next to them:Instance: Public information about the instance.InstanceArticleLimits: The limits of the body of an article (the instance settings max_article_bytes and max_article_images).InstanceBrandImage: A brand image that the administrators set:InstanceClosure: The closure of the service, present while a closure is announced and after the server closes; absent when none is announced.InstanceContact: How people reach the instance's operators (the instance settings contact_account and contact_email).InstanceCounts: How many members the instance has, how many public posts they made lately, and since when it runs, as counted at counted_at.InstanceDocument: A document that the instance has published, rendered for reading.InstanceDomainAction: A moderation action in effect on a remote domain and its subdomains, as the instance lists it publicly.InstanceDomainActionPage: A page of public domain actions, newest first.InstanceDraftLimits: The limits of drafts and scheduled posts (the instance settings of the same names).InstanceExternalReviewScope: The settings that narrow what the decision hooks in use send to the external review, which the information page states.InstanceFederation: How the instance federates with other servers, so that clients offer only the operations on remote accounts and posts that can work.InstanceFullTextSearch: The full-text search of statuses on this server.InstanceLimits: Limits that clients check before sending a request.InstanceOverview: The counts of the instance (GET /instance/overview), omitted while the instance setting public_counts is off.InstanceRegistrations: How people sign up on the instance.InstanceRule: A rule of the instance.InstanceRuleInput: The text and the hint of a rule, written once in any language and shown as they are in every locale; they replace the earlier ones.InstanceTheme: The instance's theme, for clients that do not load the server's HTML shell:InstanceThumbnail: The image that represents the instance (the instance setting thumbnail):InstanceTimelines: Who may read the public timelines the instance serves:InstanceTranslation: What the instance offers for translating posts, and what it sends where.InstanceTranslationProvider: A provider that this instance sends the text of posts to when a reader asks for a translation.InteractionPermissions: What the authenticated user may do with a status, by each kind of interaction.InteractionPolicy: Who may reply to, boost, and quote a status.InteractionPolicyChange: A change of an interaction policy:InteractionRequest: A reply to, a boost of, or a quote of a status of the authenticated user that waits for the user's approval, because only the manual rule of the status's interaction policy admits the account that interacts.InteractionRequestPage: A page of interaction requests.InteractionRule: Who may interact with a status in one way.InvitesNotAllowedProblem: The problem of a user who may not create invites of their own now (403, /api/v1/problems/invites-not-allowed); reason says why, and detail says it to the user.IssueOAuthAppTokenRequest: The scope of the tokens of an app for the authenticated user.KeywordFilter: A keyword filter of the user, which only the user sees.KeywordFilterCollection: The user's keyword filters, oldest first, the expired ones too.KeywordFilterKeyword: A word of a keyword filter.KeywordFilterRequest: A keyword filter as the user writes it.LiftAccountActionRequest: Why an action on an account is lifted.LinkableLoginProvider: An enabled login provider that users sign in with.LinkCard: The card of the first link in a status:LinkCardDomainRule: The rule of the crawler of link cards for a domain and its subdomains.LinkCardDomainRuleList: The rules, by domain.LinkCardImage: The image of a link card, served by this server's media proxy in the small size of an attachment's image.LinkedIdentity: An account at an external login provider that the authenticated user links.LinkedIdentityList: The authenticated user's linked accounts and the login providers.LinkIdentityRequest: The login provider to link an account at, and what confirms it:List: A list of accounts that the user follows, which only the user sees.ListCollection: The user's lists, oldest first.ListRequest: The name of a list.LoginProviderClaimCondition: A condition of an oidc provider:LoginProviderProblem: The problem of a login provider that breaks a rule (422, /api/v1/problems/invalid-login-provider); reason says which.LoginProvidersOnlyImpact: Who the instance setting login_providers_only keeps from signing in, whether or not the setting is on.MatchedKeywordFilter: The keyword filter that a post matched, as far as a folded post shows it.MediaAnimatedVariants: The moving renditions of an animation, absent for a still image:MediaAttachment: A media file, as an upload of the user (the media operations) or as an attachment of a status (Status.media_attachments).MediaFocus: The focal point that previews keep in view when they crop the image, from -1.0 (left, bottom) to 1.0 (right, top) on each axis; (0, 0) is the center.MediaMeta: What the server knows about the media file.MediaUpdate: The changes to a media file; a property left out keeps its value.MediaUpload: An upload of a media file.MediaVariant: A rendition of a media file, without metadata.MediaVariants: The renditions of a ready media file within the sizes of its purpose (see MediaUpload.purpose), never larger than the file.MemberInviteLimits: The caps and defaults of the invites that members create, from the instance settings member_invite_max_active, member_invite_max_uses, and member_invite_max_lifetime_seconds.ModerationAction: A moderation action on the authenticated user's own account, as the user sees it.ModerationActionPage: A page of the actions on the user's own account, newest first.ModerationAppeal: The authenticated user's appeal of an action on their account.Money: An amount of money:MoveInstanceRuleRequest: The new place of a rule.MoveOwnAccountRequest: The move of the user's own account:MoveProblem: The problem of a refused move of the user's account (422).MuteAccountRequest: The settings of a mute.MutedAccount: An account that the viewer mutes, with the mute's settings.MuteDomainRequest: The domain to mute.MutePage: A page of mutes.NewCustomEmojiRequest: A new custom emoji request:Notification: A notification of something that happened to the authenticated user.NotificationAutoDeleteLimit: The notice that the server maximum of the automatic deletion of old posts binds the user:NotificationErrorGroup: What an admin_error_group tells of:NotificationMarker: How far the authenticated user has read the notifications, across all clients.NotificationMarkerUpdate: The new position of the read marker.NotificationPage: A page of notifications, newest first.NotificationPolicy: What the authenticated user's notification policy does with the notifications of other accounts, by condition on their source.NotificationPolicyUpdate: Changes of the authenticated user's notification policy; an omitted condition keeps its action.NotificationRequest: The filtered notifications of one source that wait for the authenticated user to accept or dismiss them.NotificationRequestPage: A page of notification requests, the one with the newest notification first.NotificationRequestSummary: How many notification requests wait for the authenticated user.NotificationScheduledStatusFailure: The scheduled post that a scheduled_status_failed tells of:NotificationSettingCell: One channel of one row of the notification settings.NotificationSettingRow: One row of the notification settings with its channels.NotificationSettings: The authenticated user's notification settings:NotificationSettingsUpdate: Changes of the authenticated user's notification settings.NotificationsRead: The data of the stream event notifications_read:OAuthApp: An OAuth app that the authenticated user registered.OAuthAppCreated: A new OAuth app, with the secret of a confidential app.OAuthAppList: The OAuth apps that the authenticated user registered, oldest first; there are at most 25.OAuthAppSecret: A new secret of a confidential OAuth app.OAuthAppToken: An access token and a refresh token of the app for the authenticated user, as the token endpoint returns them (RFC 6749 §5.1).OwnCustomEmoji: A local custom emoji that the user made.OwnCustomEmojiPage: A page of the custom emoji that the user made, with what the user used of their monthly limit:OwnHookAppeal: The user's appeal of a post that the automated review refused.OwnInvite: An invite that the user created as a member, which always has a limit of uses and an expiry.OwnInvitePage: A page of the user's own invites, newest first, with what the user may do.OwnSupporterSubscription: The authenticated user's subscription that goes on, and whether they may subscribe.PageInfo: The pagination of a collection page; collection responses embed it with allOf.Passkey: A passkey that signs the authenticated user in instead of the password.PasskeyAssertion: The browser's answer to a confirmation with a passkey, which confirms an operation.PasskeyConfirmation: The start of a confirmation with a passkey.PasskeyList: The authenticated user's passkeys, oldest first.PasskeyRegistration: The start of a passkey registration.PasskeyRegistrationRequest: The name of a new passkey and what confirms it:PasswordStatus: Whether the authenticated user has a password.PaymentReconciliationRun: The last attempt of the reconciliation with the payment provider; omitted before the first.PaymentStatus: The state of the payment provider.PickerCustomEmoji: A local custom emoji that the picker offers.PickerCustomEmojiList: The custom emoji of the picker.Poll: The poll of a status; omitted when the status has none.PollInput: A poll of a new status.PollOption: One option of a poll.PostingLimits: What the account's current moderation restrictions let it post.Preferences: The authenticated user's preferences.PreviewDomainBlockImportRequest: A domain block CSV to preview.Problem: An RFC 9457 problem document.ProfileField: One metadata field of a profile.PushSubscription: The Web Push subscription of a grant.PushSubscriptionKeys: The keys of a browser's push subscription (RFC 8291 §3), in base64url.PushSubscriptionRequest: A browser's push subscription and the notification types to push to it.QrCode: A QR code as an SVG path:ReactionEmoji: The emoji of a reaction:ReactToStatusRequest: The emoji to react with.RecoveryCodes: Recovery codes, each of which signs in once in place of a code of the app.RegistrationDecisionRequest: A moderator's decision on a registration.RejectCustomEmojiRequestRequest: The rejection of a custom emoji request.Relationship: The viewer's relationship with an account.RelationshipList: The relationships, in the order of the request.RelationshipSeverance: The follows that a relationships_severed tells of:RelayProblem: The problem of a relay operation that breaks a rule (422, /api/v1/problems/invalid-relay); reason says which.RemovePasswordRequest: What confirms the removal of the user's password:ReplaceCustomEmojiImageRequest: The new image of a local custom emoji.Report: A report that the user filed.ReportCommentTranslation: The comment of a report in another language.ReportPage: A page of the user's reports, newest first.ResolveReportRequest: How a report is resolved.RoleBadge: The badge of a role, which its holders may show on their profile.RoleProblem: The problem of a role change that breaks a rule (422, /api/v1/problems/invalid-role); reason says which.RotateLoginProviderSecretRequest: A new client secret of a login provider.SanitizeBrandRequest: An SVG to check before setting it as a brand image.ServerHealth: The health of the server.ServiceClosureNotice: What a service_closure, an admin_service_closure_due, or a supporter_service_closure tells of the closure of the service.SetBrandRequest: A brand image:SetFeaturedTagsRequest: The hashtags to feature on the user's profile, in the order to show them.SetInstanceTextRequest: A new revision of an instance text.SetLinkCardDomainRuleRequest: The rule to set on a domain.SetThemeRequest: A whole token set; tokens left out keep their defaults.SignupBlockImportResult: What an import of a list of sign-up blocks did.SignupBlockImportSkipped: A line of an imported list whose block was not added.StaleThemeToken: A stored override that no longer applies, as it was saved, and why.Status: A status (post), as the viewer sees it.StatusArticle: What makes a status an article:StatusContext: The thread around a status.StatusEdit: One revision of a status.StatusEditArticle: The title and summary of one revision of an article.StatusEventBoard: The board of an event that a status is posted on (listEventBoard).StatusHistory: The revisions of a status.StatusMediaItem: A media file to attach, with its alternative text.StatusMention: An account that a status mentions.StatusPage: A page of statuses.StatusQuote: The status that a status quotes.StatusReaction: The reactions to a status with one emoji.StatusReactionPage: A page of the emoji reactions to a status, newest first.StatusReactor: One emoji reaction to a status, with the account that reacted.StatusRejectedProblem: The problem of a post that the server's automated review refused (422, /api/v1/problems/status-rejected).StatusSource: What the author typed, for editing a status.StatusTag: A hashtag of a status.StatusTranslation: A post in another language.StatusTranslationAttachment: The alt text of an attached media file in the language of the translation.StatusTranslationRequest: What to translate a post into.SupporterCheckout: The payment provider's hosted checkout of a subscription.SupporterListEntry: A member on the supporter list.SupporterListing: Whether the user is on the supporter list.SupporterListPage: A page of the supporter list:SupporterListPlan: A plan of the supporter list.SupporterPlan: A supporter plan that takes subscriptions.SupporterPlanChoice: A plan and how often its subscription renews.SupporterPlanList: The supporter plans that take subscriptions, by rank.SupporterPlanProblem: The problem of a supporter plan that breaks a rule (422, /api/v1/problems/invalid-supporter-plan); reason says which.SupporterPortal: The payment provider's portal of the user's payment methods and invoices.SupporterScheduledChange: A change to a lower plan or to the monthly price that waits for the end of the period.SupporterSubscription: The authenticated user's subscription to a supporter plan.SupporterTip: A tip of the authenticated user.SupporterTipCheckout: The payment provider's hosted checkout of a tip.SupporterTipRequest: A tip to start, of one of the amounts of GET /instance/tip_amounts.TagSuggestion: A hashtag that the prefix search of hashtags found.TagSuggestionList: The tags that match.ThemeError: One reason a token set cannot be saved or published.ThemeProblem: A 422 of the theme operations.ThemeSet: A saved token set of the instance theme.ThemeTokenValue: The override of one design token, named without -- (color-accent, radius-control):TipAmounts: The amounts that a tip may be, smallest first, all in one currency.TipAmountsProblem: The problem of amounts of the tips that break a rule (422, /api/v1/problems/invalid-tip-amounts); reason says which.TotpSetup: A new TOTP secret to add to an authenticator app.TranslationProvider: The service that translated a post, for the attribution next to the translation.TwoFactor: Where the authenticated user's two-factor authentication (TOTP) stands.TwoFactorCodeRequest: A code that confirms an operation on two-factor authentication.UpdateBadgeChoiceRequest: Whether to show the badge of the role on the authenticated user's profile.UpdateCredentialsRequest: A change of the profile; properties left out keep their current values.UpdateCustomEmojiRequest: The settings of a custom emoji to change; absent ones stay.UpdateDomainListSubscriptionRequest: The changes to the settings of a subscription; what is omitted stays.UpdateInstanceSettingsRequest: New values of some instance settings, saved together.UpdateLoginProviderRequest: The changes to a login provider; what is omitted stays.UpdateOAuthAppRequest: The changes to an OAuth app, checked as for a new one; what is omitted stays.UpdateOwnCustomEmojiRequest: The settings of a custom emoji that the user made to change; absent ones stay.UpdatePreferencesRequest: A change of the preferences; properties left out keep their current values.UpdateRoleRequest: The changes to a role; what is omitted stays.UpdateWebhookRequest: The changes to a webhook; what is omitted stays.UXMeasurementBucket: The samples whose value is above the bound of the bucket before and at most le.UXMeasurementList: The UX measurements of a window of hours, by metric and then by most samples.UXMeasurementSummary: The samples of one metric and name over the window.VoiceGrant: What the client of a session needs to connect to the audio of a room.VoiceHostChoice: The participant who becomes the host.VoiceIceServer: A STUN or TURN server, the RTCIceServer of the browser.VoiceMic: The microphone of a session of the user in a voice chat room.VoiceReaction: A reaction in a voice chat room.VoiceRoom: An open voice chat room:VoiceRoomEntry: The open voice chat room where an account is the host or a speaker, on its profile.VoiceRoomHistoryEntry: A voice chat room that the user hosted, as its settings stand last.VoiceRoomHistoryPage: A page of the voice chat rooms that the user hosted, newest first.VoiceRoomIcon: The emoji that a voice chat room shows before its name:VoiceRoomInvitation: An invitation to a voice chat room.VoiceRoomInvitationCreate: The user to invite to a voice chat room, and as what:VoiceRoomInvitationPage: A page of the invitations of a voice chat room that were not revoked, oldest first.VoiceRoomJoin: A session of the user in a voice chat room:VoiceRoomPage: A page of the open voice chat rooms that the user sees:VoiceRoomParticipant: A participant of a voice chat room.VoiceRoomSettings: The settings of a new voice chat room.VoiceRoomSummary: What the page of a voice chat room shows to a visitor who does not see the room, such as a visitor who is not signed in or a user of another server:VoiceRoomUpdate: A change of the settings of a voice chat room; an omitted property keeps its value.VoiceSession: A session of the user in a voice chat room.VoiceSignal: A WebRTC signal from a session of the user to another session of a voice chat room.VoiceStartPost: The post that the host writes when opening a voice chat room.VoiceStreamEnd: The data of the removed, replaced, and ended events of a voice chat room stream, after which the stream ends.VoiceStreamGrant: The data of a grant event of a voice chat room stream.VoiceStreamMic: The data of a mic event of a voice chat room stream.VoiceStreamMuted: The data of a muted event of a voice chat room stream.VoiceStreamReaction: The data of a reaction event of a voice chat room stream.VoiceStreamSignal: The data of a signal event of a voice chat room stream.VoteInPollRequest: A vote in the poll of a status.WebhookCustomEmoji: The emoji of a custom_emoji.* message:WebhookMessage: The body of a message that a webhook receives (Standard Webhooks), posted as application/json with the headers webhook-id, webhook-timestamp, and webhook-signature.WebhookProblem: The problem of a webhook that breaks a rule (422, /api/v1/problems/invalid-webhook); reason says which.WebhookStatus: The post of a status.created message, always public and local.WebhookTest: The data of a webhook.test message.
For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt