Reference

Shapes

What the routes take and send, by name: one of anahita-libs by its own (NodeItem), one of a service with its module (hashtag.HashtagNodeItem).

abusereport.Case

What an administrator sees of a case in a list.

decided_attime
When it was decided.
decided_byNodeItem
Who decided it.
decision_actionstring
What was done.
decision_notestring
What the administrator noted.
first_reported_attimealways
When it was first reported.
idintegeralways
Its id.
last_reported_attimealways
When it was last reported.
reasonslist of abusereport.ReasonCount or nullalways
The reasons given, with how many gave each.
report_countintegeralways
How many people reported it.
statusstringalways
open, actioned or dismissed.
targetNodeItem
Target is the reported node as it is now, or absent when it is gone.
target_gonebooleanalways
Whether what was reported is gone.
target_idintegeralways
The id of what was reported.
target_ownerNodeItem
The profile it is on.
target_typestringalways
What kind of node it is.
written_byNodeItem
Who wrote it, when it is a reply one of a website's administrators made as the website. Sent only here, to those who handle reports.

abusereport.CaseDetail

A case with its reports and the target's earlier cases.

decided_attime
When it was decided.
decided_byNodeItem
Who decided it.
decision_actionstring
What was done.
decision_notestring
What the administrator noted.
first_reported_attimealways
When it was first reported.
idintegeralways
Its id.
last_reported_attimealways
When it was last reported.
previouslist of abusereport.Case or nullalways
The earlier cases about the same thing.
reasonslist of abusereport.ReasonCount or nullalways
The reasons given, with how many gave each.
report_countintegeralways
How many people reported it.
reportslist of abusereport.Report or nullalways
Each person's report.
statusstringalways
open, actioned or dismissed.
targetNodeItem
Target is the reported node as it is now, or absent when it is gone.
target_gonebooleanalways
Whether what was reported is gone.
target_idintegeralways
The id of what was reported.
target_ownerNodeItem
The profile it is on.
target_typestringalways
What kind of node it is.
written_byNodeItem
Who wrote it, when it is a reply one of a website's administrators made as the website. Sent only here, to those who handle reports.

abusereport.CaseSummary

How many cases wait to be decided.

openintegeralways
How many are open. At least 0.

abusereport.ProfileCase

A case as a group's or an event's administrators see it (roadmap row 102, part 6b): what was reported and the reports against its rules, never who made them, nor the site's decision notes.

idintegeralways
Its id.
last_reported_attimealways
When it was last reported.
reportslist of abusereport.ProfileReport or nullalways
The reports against the profile's rules, oldest first.
statusstringalways
open, actioned or dismissed.
targetNodeItem
Target is the reported node as it is now, or absent when it is gone.
target_gonebooleanalways
Whether what was reported is gone.
target_idintegeralways
The id of what was reported.
target_typestringalways
What kind of node it is.

abusereport.ProfileReport

One report against a profile's rules, with nobody's name.

created_attimealways
When it was made.
detailsstring
What the reporter added.
rulestringalways
The rule broken, by its title.

abusereport.Reason

One entry of the list a reporter chooses from, in their language.

descriptionstring
What it covers.
keystringalways
What it is called in a report.
labelstringalways
What it is called, in the language asked for.
requires_detailsbooleanalways
Whether the reporter must say more in their own words.

abusereport.ReasonCount

How many reports in a case gave one reason.

countintegeralways
How many reports gave it.
keystringalways
The reason.
labelstringalways
What it is called.

abusereport.Report

One person's report, as an administrator sees it.

created_attimealways
When it was made.
detailsstring
What the reporter added.
idintegeralways
Its id.
reason_keystringalways
The reason given.
reason_labelstringalways
What it is called.
reporterNodeItem
Who reported it.
reporter_idintegeralways
Their id.
rulestring
With reason_key "rule": the rule broken, by its title, and whose rule it is, 0 for the site's.
rule_profileNodeItem
The group or event whose rule it is.
rule_profile_idinteger
updated_attimealways
When it was last changed: a second report by the same person updates it.

activitypub.Actor

Somebody, as they are described to another server.

@contextanything
discoverablebooleanalways
endpointsactivitypub.Endpoints
followersstringalways
followingstringalways
iconactivitypub.Image
idstringalways
imageactivitypub.Image
inboxstringalways
manuallyApprovesFollowersbooleanalways
Whether a follow waits to be approved.
namestring
outboxstringalways
preferredUsernamestringalways
publicKeyactivitypub.PublicKeyalways
publishedstring
summarystring
typestringalways
urlstring

activitypub.Collection

A list said only by how long it is: who follows somebody is theirs to know, and how many is all that is told.

@contextanythingalways
idstringalways
totalItemsintegeralways
typestringalways

activitypub.Endpoints

sharedInboxstring

activitypub.Image

mediaTypestring
typestringalways
urlstringalways

activitypub.JRD

A WebFinger answer: who a handle is, and where they are.

aliaseslist of string
linkslist of activitypub.JRDLink or nullalways
subjectstringalways

activitypub.JRDLink

hrefstring
relstringalways
typestring

activitypub.Note

A post, as it is sent to and read from another server.

@contextanything
attachmentlist of activitypub.SentPicture
The pictures of a photo post, or the video of a video post.
attributedTostringalways
cclist of string or nullalways
contentstringalways
contentMapmap of string
idstringalways
imageactivitypub.Image
An Article's cover.
inReplyTostring
What it answers, by the address that has between servers.
locationmap of anything
Where it is: the first location its author chose for it, a Place (roadmap row 82, part 3b). Every one is also a Place in Tag.
namestring
An Article's title, and the opening it is summed up by. A note has neither: Mastodon shows a note's summary as a warning to click past.
publishedstring
summarystring
taglist of activitypub.Tag
tolist of string or nullalways
typestringalways
updatedstring
urlstring

activitypub.PublicKey

idstringalways
ownerstringalways
publicKeyPemstringalways

activitypub.RemotePerson

Somebody on another server, as the web app is told.

aliasstringalways
Their handle: alice@mastodon.example.
bodystringalways
What they say of themselves.
idintegeralways
Their id here.
lockedbooleanalways
Whether a follow of theirs waits to be approved.
namestringalways
Their name.
origin_domainstringalways
typestringalways
Always the type of a person on the fediverse.
uristringalways
Their address between servers, and the server it is on.
urlstringalways
Their page on their own server.

activitypub.SentIcon

A still that stands for a video.

mediaTypestringalways
typestringalways
urlstringalways

activitypub.SentPicture

One picture of a post, as it is sent: where to fetch it, what it is, how big, and what its author said it shows.

heightinteger
iconactivitypub.SentIcon
A video's poster, which Mastodon shows before it plays.
mediaTypestringalways
namestring
typestringalways
urlstringalways
widthinteger

activitypub.Settings

What a person is shown about being on the fediverse.

actorstring
Where those servers find them.
availablebooleanalways
Whether they could be, and why not when they could not.
enabledbooleanalways
Whether they are.
handlestring
What they are, or would be, called from other servers, and where those servers find them.
reasonstring
Why not: site_private, site_unreachable or profile_not_public.

activitypub.Tag

Tag names somebody or a hashtag that a post mentions, beside its text, or a location it was tagged with, a Place with its point.

hrefstringalways
latitudenumber
A Place's point.
longitudenumber
namestringalways
typestringalways

actor.GroupDeletionCounts

What deleting a group or an event would take with it, for the Danger zone.

adminsintegeralways
Its administrators.
followersintegeralways
Who follows it.
member_sincestring
When it was made, when it is known.
postsintegeralways
The posts in it.
repliesintegeralways
The replies in it.

actor.HandleResponse

Which profile an alias is: where the web app reads it, and by what.

aliasstringalways
Its alias, as it is kept.
idintegeralways
Its id.
kindstringalways
"people", "groups" or "events": the profile's own address begins so.

actor.PersonDeletionCounts

What deleting a person would take with it, for the Danger zone.

followersintegeralways
Who follows them.
followingintegeralways
Whom they follow.
groups_administeredintegeralways
The groups they administer.
member_sincestring
When they joined, when it is known.
postsintegeralways
Their posts.
repliesintegeralways
Their replies.

actor.PersonNode

accessstringalways
Who may see it: public, registered, followers, leaders, mutuals, admins or myself (permissions.md).
aliasstring
Its handle (ana, or ana@mastodon.social for somebody on another server).
allow_downloadbooleanalways
What this actor's new photos and videos start with: whether they may be downloaded.
allow_follow_requestbooleanalways
Whether people its profile is not open to may ask to follow it.
archived_attime
Permanent, and set only once archived, so the settings page can show the state rather than offering an action that no longer applies.
authorAuthor
Author information
authorizedNodeAuthorized
avatar_urlsmap of Image
Its picture, in each size there is: small, medium, large, square.
bodystring
Its description.
cover_urlsmap of Image
Its cover picture, in each size there is: medium, large.
created_attimealways
When it was made.
deleted_attime
Present only while the actor is scheduled for deletion, so the settings page can offer Restore instead of the delete form. Deleting also clears Enabled, and a client reading only that cannot tell an account on its way out from one an administrator disabled.
editorEditor
enabledbooleanalways
Whether it is enabled: false when a site administrator has disabled it, or while it is being deleted.
eventEvent
On an event: when it is, how many may go and are going, and what the viewer answered. Left out on anything else.
featured_attime
Set only while the installation features this actor, so a super administrator's profile menu can show the toggle's state.
featureslist of NodeFeature
follower_countinteger
How many follow it.
idintegeralways
Its id.
is_admined_by_viewerboolean
Whether the viewer is one of its administrators.
is_blocked_by_viewerboolean
Whether the viewer has blocked it.
is_following_viewerboolean
Whether it follows the viewer.
is_invitedboolean
Whether the viewer has been invited to follow this actor and is yet to answer.
is_leading_viewerboolean
Whether the viewer follows it.
languagestring
The language this person usually posts in. Left out when not set.
leader_countinteger
How many it follows.
namestring
Its name.
origin_domainstring
The server it came from, when it came from another.
permissionsmap of string
person_pronounsstring
person_typestring
quote_policystring
On a person: who may quote their posts, when a post does not say. "anyone", "followers" or "nobody"; left out when they have not said, which is anyone.
show_reposts_on_profilebooleanalways
Whether what this actor reposts is also among its profile's posts.
typestringalways
What kind of profile it is: node.actor.actor-service.person.v1, ...group.v1 or ...event.v1, or one of another server's.
updated_attime
uristring
What it is called on the server it came from, and that server, when it came from another. Left out of everything made here.
verifiedboolean
A mark kept from earlier versions of Anahita. Nothing sets it yet.
website_urlstring
One link on the profile. Rendered as an anchor, so the value is validated to http(s) on the way in — see requests/actor.go.

actor.Rule

One of a profile's rules.

bodystringalways
A line more, if it needs one.
titlestringalways
A few words: "Be kind".

actor.Rules

A profile's rules, as they are now.

agreed_versionintegeralways
The version the viewer last agreed to, 0 for none: behind Version, they are asked again.
itemslist of actor.Rule or nullalways
updated_atstringalways
When they last changed, RFC 3339, or empty.
versionintegeralways
Raised by every change; 0 for a profile that never had any.

actor.TaggedPerson

One person in a post, as the post's list of them answers.

pendingbooleanalways
Waiting for their approval: shown only to them and the post's author.
personone of NodeItem, nullalways
Who.

ActorBrief

An actor named beside something else: who invited, who was invited, what they were invited to. Enough to show a picture and a name and to lead to the profile, and nothing of the profile itself.

aliasstring
A profile's handle (ana, or ana@mastodon.social for somebody on another server), or a hashtag's name.
avatar_urlsmap of Image
Its picture, in each size there is: small, medium, large, square.
idintegeralways
Its id.
namestring
A profile's name, or a post's title where it has one.
typestringalways
What kind of thing it is: node.actor.<service>.person.v1, ...group.v1, ...event.v1, or a post's kind.
verifiedboolean
A mark kept from earlier versions of Anahita. Nothing sets it yet.

ActorEditAddPermission

accessstringalways
Who may add it.
entitystringalways
What may be added: a kind of post.

ActorFeatureRequest

add_permissionslist of ActorEditAddPermission or nullalways
Who may add what.
composerslist of string or nullalways
The composers it offers.
enabledbooleanalways
Whether it is on for this profile.
node_typeslist of string or nullalways
The kinds of post it makes.
optionalbooleanalways
Whether it may be turned off.
orderingintegeralways
Where it comes among the others.
servicestringalways
The service it is.

ActorNode

accessstringalways
Who may see it: public, registered, followers, leaders, mutuals, admins or myself (permissions.md).
administratorslist of Admin
aliasstring
Its handle (ana, or ana@mastodon.social for somebody on another server).
allow_downloadbooleanalways
What this actor's new photos and videos start with: whether they may be downloaded.
allow_follow_requestbooleanalways
Whether people its profile is not open to may ask to follow it.
archived_attime
Permanent, and set only once archived, so the settings page can show the state rather than offering an action that no longer applies.
authorAuthor
Author information
authorizedNodeAuthorized
avatar_urlsmap of Image
Its picture, in each size there is: small, medium, large, square.
bodystring
Its description.
cover_urlsmap of Image
Its cover picture, in each size there is: medium, large.
created_attimealways
When it was made.
deleted_attime
Present only while the actor is scheduled for deletion, so the settings page can offer Restore instead of the delete form. Deleting also clears Enabled, and a client reading only that cannot tell an account on its way out from one an administrator disabled.
editorEditor
enabledbooleanalways
Whether it is enabled: false when a site administrator has disabled it, or while it is being deleted.
eventEvent
On an event: when it is, how many may go and are going, and what the viewer answered. Left out on anything else.
featured_attime
Set only while the installation features this actor, so a super administrator's profile menu can show the toggle's state.
featureslist of NodeFeature
follower_countinteger
How many follow it.
idintegeralways
Its id.
is_admined_by_viewerboolean
Whether the viewer is one of its administrators.
is_blocked_by_viewerboolean
Whether the viewer has blocked it.
is_following_viewerboolean
Whether it follows the viewer.
is_invitedboolean
Whether the viewer has been invited to follow this actor and is yet to answer.
is_leading_viewerboolean
Whether the viewer follows it.
leader_countinteger
How many it follows.
namestring
Its name.
origin_domainstring
The server it came from, when it came from another.
permissionsmap of string
quote_policystring
On a person: who may quote their posts, when a post does not say. "anyone", "followers" or "nobody"; left out when they have not said, which is anyone.
show_reposts_on_profilebooleanalways
Whether what this actor reposts is also among its profile's posts.
typestringalways
What kind of profile it is: node.actor.actor-service.person.v1, ...group.v1 or ...event.v1, or one of another server's.
updated_attime
uristring
What it is called on the server it came from, and that server, when it came from another. Left out of everything made here.
verifiedboolean
A mark kept from earlier versions of Anahita. Nothing sets it yet.
website_urlstring
One link on the profile. Rendered as an anchor, so the value is validated to http(s) on the way in — see requests/actor.go.

ActorNodeItem

A profile: a person, a group or an event.

accessstringalways
Who may see it: public, registered, followers, leaders, mutuals, admins or myself (permissions.md).
aliasstring
Its handle (ana, or ana@mastodon.social for somebody on another server).
allow_downloadbooleanalways
What this actor's new photos and videos start with: whether they may be downloaded.
allow_follow_requestbooleanalways
Whether people its profile is not open to may ask to follow it.
archived_attime
Permanent, and set only once archived, so the settings page can show the state rather than offering an action that no longer applies.
authorAuthor
Author information
avatar_urlsmap of Image
Its picture, in each size there is: small, medium, large, square.
bodystring
Its description.
cover_urlsmap of Image
Its cover picture, in each size there is: medium, large.
created_attimealways
When it was made.
deleted_attime
Present only while the actor is scheduled for deletion, so the settings page can offer Restore instead of the delete form. Deleting also clears Enabled, and a client reading only that cannot tell an account on its way out from one an administrator disabled.
enabledbooleanalways
Whether it is enabled: false when a site administrator has disabled it, or while it is being deleted.
eventEvent
On an event: when it is, how many may go and are going, and what the viewer answered. Left out on anything else.
featured_attime
Set only while the installation features this actor, so a super administrator's profile menu can show the toggle's state.
follower_countinteger
How many follow it.
idintegeralways
Its id.
is_admined_by_viewerboolean
Whether the viewer is one of its administrators.
is_blocked_by_viewerboolean
Whether the viewer has blocked it.
is_following_viewerboolean
Whether it follows the viewer.
is_invitedboolean
Whether the viewer has been invited to follow this actor and is yet to answer.
is_leading_viewerboolean
Whether the viewer follows it.
leader_countinteger
How many it follows.
namestring
Its name.
origin_domainstring
The server it came from, when it came from another.
quote_policystring
On a person: who may quote their posts, when a post does not say. "anyone", "followers" or "nobody"; left out when they have not said, which is anyone.
show_reposts_on_profilebooleanalways
Whether what this actor reposts is also among its profile's posts.
typestringalways
What kind of profile it is: node.actor.actor-service.person.v1, ...group.v1 or ...event.v1, or one of another server's.
uristring
What it is called on the server it came from, and that server, when it came from another. Left out of everything made here.
verifiedboolean
A mark kept from earlier versions of Anahita. Nothing sets it yet.
website_urlstring
One link on the profile. Rendered as an anchor, so the value is validated to http(s) on the way in — see requests/actor.go.

Admin

aliasstring
avatar_urlsmap of Image
idintegeralways
namestring
typestring

atproto.ImportPreview

What following here whoever the viewer follows on Bluesky would do, before it is done.

followingintegeralways
How many accounts the viewer follows on Bluesky.
mostintegeralways
The most followed here in one go.
posts_of_eachintegeralways
How many of each one's latest posts are read.

atproto.ImportStarted

ImportStarted says following them here has begun: it carries on after the answer, and for a long list takes minutes.

limitintegeralways
How many will be followed.
startedbooleanalways
Always true.

atproto.RemotePerson

Somebody on Bluesky, as the web app is told. The same shape as somebody found on the fediverse.

aliasstringalways
Their handle: alice.bsky.social.
bodystringalways
What they say of themselves.
idintegeralways
Their id here.
lockedbooleanalways
Nobody on Bluesky approves who follows them.
namestringalways
Their name.
origin_domainstringalways
typestringalways
Always a Bluesky person's type.
uristringalways
Their address between servers, and where they are kept as from.
urlstringalways
Their page on Bluesky.

atproto.Settings

Somebody's connection to Bluesky, as the web app is told.

brokenbooleanalways
The account's server no longer takes what was kept: it has to be connected again.
connectedbooleanalways
Whether an account is connected.
didstringalways
Its lasting name on Bluesky.
handlestringalways
Its handle.

AudienceRefusal

AudienceRefusal refuses an audience a post may not be given, and says which it may.

allowedlist of string or nullalways
The audiences it may be given, widest first.
errorstringalways
Always access_not_allowed.

auth.Accepted

An acceptance recorded.

acceptedbooleanalways
Always true.
versionstringalways
The version accepted.

auth.AccountItem

admin_countinteger
Groups, events and websites only: how many administrators it has.
aliasstringalways
The username.
content_countintegeralways
How many posts it has written.
created_attimealways
When it was made.
deleted_attime
When it was deleted, while it waits out the thirty days before it is purged; absent otherwise.
email_verifiedboolean
People only: whether they confirmed their address.
follower_countintegeralways
How many follow it.
idintegeralways
The profile's id.
kindstringalways
person, group, event or website.
last_active_attimealways
When it last did anything.
leader_countintegeralways
How many it follows.
namestringalways
The name shown.
onboardedboolean
People only: whether they went through the walk-through after signing up.
person_typestring
People only: registered, administrator or super-administrator.
statestringalways
active, disabled, archived or deleted (on its way to being destroyed).
tierstringalways
empty: nothing written, following nobody and followed by nobody; dormant: not active for as long as the installation calls dormant (ACCOUNT_DORMANT_DAYS); active otherwise.

auth.Agreements

What somebody has accepted of the two documents.

privacyauth.consentItemalways
The Privacy Policy.
rulesauth.consentItemalways
The site's rules (site.json, roadmap row 102).
tosauth.consentItemalways
The Terms of Service.

auth.AuthLogItem

citystringalways
Roughly where it began, from its address. Empty when not known.
client_idstringalways
The app it signed in to.
countrystringalways
The country, likewise.
created_attimealways
When it began.
devicestringalways
The kind of device: desktop, mobile, tablet or bot.
idintegeralways
The session's id: what signing it out names.
is_activebooleanalways
Whether it is still signed in.
is_viewerbooleanalways
Whether it is the session asking.
namestringalways
The app, or the browser.
osstringalways
Its operating system.

auth.CodeMismatch

CodeMismatch refuses a wrong code, and says how many tries are left before it stops working.

remainingintegeralways
How many tries are left.

auth.ConfirmationMismatch

ConfirmationMismatch refuses a confirmation that names another number than there is now.

errorstringalways
Always confirmation_mismatch.
totalintegeralways
How much is public now: what to confirm instead.

auth.consentItem

One recorded acceptance, as a client sees it.

acceptedbooleanalways
Whether they have accepted it.
accepted_atstring or nullalways
When. Null when they never have.
versionstringalways
Which version they accepted: 1.0.

auth.InviteItem

An invitation, as its sender sees it. Not the link: that is in the mail that was sent, and nowhere else.

authorone of Author, nullalways
Who sent it: the viewer.
created_atstringalways
When it was sent.
idintegeralways
Its id: what taking it back names.
recipient_emailstringalways
Who it was sent to.
statusstringalways
pending, used or expired.

auth.InviteList

A page of the viewer's invitations, and how many of them are waiting.

datalist of auth.InviteItem or nullalways
The latest first.
paginationPaginationalways
Where this page is among all of them.
pendingintegeralways
How many are waiting: sent, and not yet accepted, expired or taken back. The most that may wait is the viewer's entitlement, in userinfo (entitlements.invites.max_pending); sending another at it is refused (too_many_invitations).

auth.Item

One rule, promise or suggestion: a short title, and a line more if it needs one.

bodymap of string
titlemap of string or nullalways

auth.JWKSet

The keys a token's signature is checked with (RFC 7517).

keyslist of map of anything or nullalways
Each a JSON Web Key: kid, kty, alg, use, n and e.

auth.NodeInfoDocument

What the installation is (NodeInfo 2.1).

metadatamap of anything or nullalways
What the web app reads of the installation: nodeName, nodeDescription, registrationMode, approvalRequired, invitationsAccepted, invitesFrom, groupsFrom, eventsFrom, websitesFrom, locationsFrom, minContentAccess, readAccess, networks, photoMaxFiles, siteRules, spamRemovalMaxDays, accountGraceDays, videoUploads, videoMaxBytes, videoMaxSeconds, animationMaxBytes, animationMaxSeconds, termsOfServiceUrl, privacyPolicyUrl, and the support contacts supportEmail, supportPhone and supportWebsite.
openRegistrationsbooleanalways
Whether anybody may sign up without being invited or approved.
protocolslist of string or nullalways
What it speaks with other servers: activitypub, when it federates.
servicesauth.nodeInfoServicesalways
What it bridges to: nothing.
softwareauth.nodeInfoSoftwarealways
What it runs.
usageauth.nodeInfoUsagealways
How much it is used.
versionstringalways
2.1.

auth.nodeInfoLink

Where one version of the document is.

hrefstringalways
Where it is.
relstringalways
The version's schema: http://nodeinfo.diaspora.software/ns/schema/2.1.

auth.NodeInfoLinks

Where the NodeInfo document is, for each version there is.

linkslist of auth.nodeInfoLink or nullalways
One: 2.1.

auth.nodeInfoServices

What the installation bridges to and from: nothing.

inboundlist of string or nullalways
Both are required by the schema and both are empty: this installation does not bridge to or from anything. They are []string{} rather than nil because the schema says array, and a JSON null there makes strict consumers reject the whole document.
outboundlist of string or nullalways
Empty.

auth.nodeInfoSoftware

What the installation runs.

namestringalways
anahita.
repositorystring
Where its code is.
versionstringalways
Its version.

auth.nodeInfoUsage

How much the installation is used.

localPostsintegeralways
Posts written here.
usersauth.nodeInfoUsersalways
People.

auth.nodeInfoUsers

How many people have accounts.

activeHalfyearintegeralways
Those active in the last six months.
activeMonthintegeralways
Those active in the last month.
totalintegeralways
All of them.

auth.OAuthClientCreatedItem

The response shape used only on Add and RotateSecret — the plaintext client_secret is exposed once and never returned by any other endpoint.

activebooleanalways
Whether it may sign people in.
client_idstringalways
What it calls itself when it signs people in: a slug.
client_secretstringalways
Its secret, shown this once and never again. Empty for a public app.
confidentialbooleanalways
Whether it can keep a secret: an app's own server can, an app in a browser or on a phone cannot.
created_attimealways
When it was registered.
first_partybooleanalways
Whether it is one of the installation's own apps.
grant_typeslist of string or nullalways
How it may get tokens: authorization_code, refresh_token, client_credentials.
idintegeralways
Its number here: what the routes name it by.
namestringalways
What people are shown it is called.
redirect_urislist of string or nullalways
Where people may be sent back to after signing in. Exactly these.
scopeslist of string or nullalways
What it may ask to do (oauth.md).
skip_consentbooleanalways
Whether people are not asked to allow it.
token_expiryintegeralways
How long its access tokens last, in seconds.

auth.OAuthClientItem

activebooleanalways
Whether it may sign people in.
client_idstringalways
What it calls itself when it signs people in: a slug.
confidentialbooleanalways
Whether it can keep a secret: an app's own server can, an app in a browser or on a phone cannot.
created_attimealways
When it was registered.
first_partybooleanalways
Whether it is one of the installation's own apps.
grant_typeslist of string or nullalways
How it may get tokens: authorization_code, refresh_token, client_credentials.
idintegeralways
Its number here: what the routes name it by.
namestringalways
What people are shown it is called.
redirect_urislist of string or nullalways
Where people may be sent back to after signing in. Exactly these.
scopeslist of string or nullalways
What it may ask to do (oauth.md).
skip_consentbooleanalways
Whether people are not asked to allow it.
token_expiryintegeralways
How long its access tokens last, in seconds.

auth.OAuthErrorResponse

The standard OAuth error response body per RFC 6749 §5.2.

errorstringalways
Why, as RFC 6749 names it: invalid_client, invalid_grant and so on.
error_codestring
For a refused refresh token, which it was: refresh_expired, refresh_not_found and refresh_reuse end the session; refresh_raced does not, since another request refreshed first.
error_descriptionstring
The same in words.

auth.OAuthIntrospectItem

activebooleanalways
Whether it is live. Nothing else is said of one that is not.
client_idstring
The app it was issued to.
expinteger
When it expires, in seconds since 1970.
iatinteger
When it was issued, likewise.
issstring
Who issued it: this installation.
jtistring
Its own id.
scopestring
What it may do, separated by spaces.
substring
Whose it is: the person's id, or the app's for its own.

auth.OAuthSigningKeyItem

A key the installation signs tokens with, as an administrator sees it. Neither half of the key is sent: the public one is in the JWKS, and the private one never leaves the service.

activebooleanalways
Whether new tokens are signed with it. Tokens it signed are still verified while it is in the JWKS.
algorithmstringalways
RS256.
backendstringalways
Where the private key is kept: local, in the database, or kms.
created_attimealways
When it was made.
expires_attimealways
When it stops being signed with.
idintegeralways
Its number here.
key_idstringalways
The kid a token names it by, in its header.

auth.OAuthTokenResponse

access_tokenstringalways
What a request is signed with: Authorization: Bearer <token>. A JWT.
expires_inintegeralways
How long the access token lasts, in seconds.
id_tokenstring
Who signed in, when openid was asked for (OpenID Connect).
refresh_tokenstring
What gets the next tokens when this one expires; used once. Not for an app acting for itself.
scopestringalways
What the tokens may do, separated by spaces.
token_typestringalways
Bearer.

auth.Onboarded

Onboarded says when the viewer went through the walk-through.

onboarded_attime or nullalways
The first time: calling again does not move it.

auth.OnboardingState

What the walk-through needs that userinfo does not carry.

invited_bystring or nullalways
The username of whoever invited the viewer, to show first. Null when nobody did, or they can no longer be followed.

auth.OpenIDConfiguration

The OpenID Connect discovery document (OpenID Connect Discovery 1.0, section 3): where each endpoint is, and what the installation supports.

authorization_endpointstringalways
/oauth/authorize.
claims_supportedlist of string or nullalways
What a token or userinfo may say.
code_challenge_methods_supportedlist of string or nullalways
S256 and plain.
grant_types_supportedlist of string or nullalways
authorization_code, refresh_token and client_credentials.
id_token_signing_alg_values_supportedlist of string or nullalways
RS256.
introspection_endpointstringalways
/oauth/introspect.
issuerstringalways
Who issues the tokens: the iss in each.
jwks_uristringalways
/.well-known/jwks.json.
response_types_supportedlist of string or nullalways
code.
revocation_endpointstringalways
/oauth/revoke.
scopes_supportedlist of string or nullalways
Every scope there is (oauth.md).
subject_types_supportedlist of string or nullalways
public.
token_endpointstringalways
/oauth/token.
token_endpoint_auth_methods_supportedlist of string or nullalways
client_secret_basic and client_secret_post.
userinfo_endpointstringalways
/oauth/userinfo.

auth.PasskeyCount

How many passkeys somebody holds, and nothing else about them.

countintegeralways
How many.

auth.PasskeySignedIn

Where the browser goes next, now that it is signed in: back to the authorization that sent it to sign in, or to the app.

redirect_tostringalways
Where to send the browser.

auth.PasskeysRevoked

How many passkeys were removed.

revokedintegeralways
How many.

auth.PasswordChanged

PasswordChanged says how many other sessions were signed out.

revoked_sessionsintegeralways
Every one but the one that changed it.

auth.PersonTypeChanged

A person's type, and whether this changed it.

changedbooleanalways
False when they already had it.
idintegeralways
person_typestringalways
The type they have now.
previousstringalways
The type they had before.

auth.PublicContent

How much is public: on the installation, or changed by making it registered-only.

groupsintegeralways
Groups anybody may see.
peopleintegeralways
People whose profiles anybody may see.
postsintegeralways
Posts anybody may see.
public_allowedbooleanalways
Whether new public content is still allowed here. While it is, the conversion is refused: it would be undone by the next public post.
totalintegeralways
The three together: the number to confirm.

auth.Rules

The site's rules, with the version agreed to. Raising the version asks everybody to agree again; a correction that leaves it as it is asks nobody.

itemslist of auth.Item or nullalways
versionstringalways

auth.SessionStarted

SessionStarted says the app's session holds its tokens now.

statusstringalways
Always authenticated.

auth.SignupDecided

The answer given to a request.

person_idinteger
The account made, when it was approved.
statusstringalways
approved or rejected.

auth.SignupRequestItem

What an administrator sees.

bodystringalways
What they say of themselves.
created_atstringalways
When they asked.
created_ipstringalways
The address they asked from.
emailstringalways
Their address, confirmed.
idintegeralways
The request's id: what answering it names.
invited_byinteger
Who invited them, when somebody did: a person's id.
namestringalways
Their name.
statusstringalways
pending.
usernamestringalways
The username asked for.
username_takenbooleanalways
UsernameTaken says whether the name they asked for is still free.
website_urlstringalways
Their website.

auth.SiteAbout

What GET /site answers: every text in every language it is written in, keyed by the web app's language names ("en-CA", "fr-FR"), for the reader's app to choose from.

promiseslist of auth.Item or nullalways
Shown on the About page, under "Our promises to you".
rule_suggestionslist of auth.Item or nullalways
Offered to a group's administrators when they write its rules.
rulesauth.Rulesalways
The site's rules, and the version agreed to: everybody ticks each before using the site, and again when the version is raised.

auth.TotpStatus

Whether somebody has two-factor authentication.

enabledbooleanalways
Whether it is on.
expiredbooleanalways
Whether its last passcode is too long ago, so that signing in asks for one. Always false when it is off.

auth.UsernameChanged

The username as it was stored.

usernamestringalways
The new username.

auth.WebAuthnCredentialItem

The person-facing shape of an enrolled passkey.

clone_warningbooleanalways
Whether it looked copied when last used: worth removing.
created_attimealways
When it was added.
idintegeralways
Its id: what renaming or removing it names.
last_used_attime or nullalways
When it was last used. Null when never.
nicknamestringalways
What it is called: the device, unless its owner renamed it.
syncedbooleanalways
Whether it is kept in sync across devices, so that losing one loses nothing.
transportslist of string or nullalways
How the browser reaches it: internal, usb, nfc, ble, hybrid.

Author

Who wrote something.

aliasstring
A profile's handle (ana, or ana@mastodon.social for somebody on another server), or a hashtag's name.
avatar_urlsmap of Image
Its picture, in each size there is: small, medium, large, square.
idintegeralways
Its id.
namestring
A profile's name, or a post's title where it has one.
typestring
What kind of thing it is: node.actor.<service>.person.v1, ...group.v1, ...event.v1, or a post's kind.

DomainBlock

A server this installation will have nothing to do with.

created_attimealways
When.
created_byintegeralways
The super administrator who refused it.
domainstringalways
The server's name.
reasonstringalways
Why it is refused.

Editor

Who changed something last.

aliasstring
A profile's handle (ana, or ana@mastodon.social for somebody on another server), or a hashtag's name.
avatar_urlsmap of Image
Its picture, in each size there is: small, medium, large, square.
idintegeralways
Its id.
namestring
A profile's name, or a post's title where it has one.
typestring
What kind of thing it is: node.actor.<service>.person.v1, ...group.v1, ...event.v1, or a post's kind.

Event

What only an event has, on the actor it is.

addressEventAddress
Where it is held, when it is somewhere. Sent to the same people as the address to join online, and for the same reason: it may be somebody's home. HasAddress says there is one all the same.
cancelled_attime
Set when it was called off.
capacityintegeralways
How many may be going. 0 for no limit. At least 0.
ends_attimealways
When it ends, in UTC.
going_countintegeralways
How many are going. At least 0.
has_addressbooleanalways
Whether it has an address, said to everybody.
has_online_urlbooleanalways
Whether it has an address to join online, said to everybody.
hostActorBrief
The group hosting it, when there is one the viewer may see.
is_fullbooleanalways
Every place is taken. Maybe is still open.
maybe_countintegeralways
How many may go. At least 0.
online_urlstring
Where to join online. Sent only to whoever is going and whoever looks after the event; HasOnlineURL says there is one all the same.
open_to_host_followersboolean
Whether everybody who follows the host may see that it is on and answer it.
starts_attimealways
When it begins, in UTC.
statestringalways
upcoming, happening, past or cancelled, as of when it was sent.
timezone_namestringalways
The zone the times were given in, as IANA names it. The times themselves are UTC.
viewer_rsvpstring
What the viewer has answered: going, maybe, or left out.

EventAddress

Where an event is held, as it was typed: the node's own address fields. It is not a place on the site's map. Nobody else can find it, tag it or search for it.

citystring
countrystring
latitudenumber
Where that is on a map, when whoever made the event asked for one and the address was found. Left out otherwise.
longitudenumber
postal_codestring
state_provincestring
streetstring

export.ExportItem

An export as its owner is told of it.

created_attimealways
When it was asked for.
download_urlstring
Where the archive is fetched from, while it is ready: an address good for a few minutes, made afresh each time this is read.
errorstring
Why it failed, when it did.
expires_attime
When the archive will be deleted.
idstringalways
Its id: a UUID.
ready_attime
When it was ready.
size_bytesinteger
How big the archive is, once it is ready.
statusstringalways
pending, building, ready, failed, cancelled or expired.

export.ExportList

The viewer's exports, and when they may ask again.

datalist of export.ExportItem or nullalways
The latest first.
every_daysintegeralways
How many days must pass between two exports. 0 for no wait.
keep_daysintegeralways
How many days an archive is kept once it is ready.
next_attime
When they may next ask, while they must wait.

export.TooSoon

TooSoon refuses an export asked for before it is time, and says when.

errorstringalways
Always too_soon.
next_attimealways
When they may ask.

feed.CustomFeedAuthorized

copybooleanalways
deletebooleanalways
Whether the viewer may delete it.
editbooleanalways
Whether the viewer may change it.
pinbooleanalways
Keep it on the home page, and make a copy to change.

feed.CustomFeedPage

A page of a custom feed's posts.

datalist of NodeItem or nullalways
Its posts, the latest first.
paginationfeed.CustomFeedPaginationalways
Where the page is.

feed.CustomFeedPagination

A feed is paged by what came before, and has no total: counting it would be reading all of it.

has_morebooleanalways
Whether there is a next page.
limitintegeralways
The most a page holds. At least 0.
next_cursorstringalways
What to ask for as cursor for the next page.

feed.CustomFeedResponse

A feed as it is sent.

accessstringalways
Who may see it.
authorizedfeed.CustomFeedAuthorizedalways
What the viewer may do with it.
bodystringalways
What it is for, in its owner's words.
created_attimealways
When it was made.
definitionanythingalways
What it shows (feeds.md).
iconstringalways
The name of its picture.
idintegeralways
Its id.
is_pinnedbooleanalways
Whether the viewer keeps it on their home page.
namestringalways
What it is called.
ownerNodeItem
Whose it is.
referenceslist of NodeItem
The profiles and places its definition names, the ones the viewer may see, for the editor to show by name. Sent with a single feed.
typestringalways
Always a custom feed's type.
updated_attimealways
When it last changed.

feed.DiscoverPage

A page of the feeds people have shared.

datalist of feed.CustomFeedResponse or nullalways
The feeds.
paginationfeed.DiscoverPaginationalways
Where the page is.

feed.DiscoverPagination

Where a page of shared feeds is: by how many came before it, and with no total.

has_morebooleanalways
Whether there is a next page.
limitintegeralways
The most a page holds. At least 0.
next_startintegeralways
What to ask for as start for the next page. At least 0.
startintegeralways
How many came before this page. At least 0.

FeedBrief

What a custom feed is beyond its name and its owner, for where one is listed among other things, as in search results: its picture and what it shows.

definitionanythingalways
What it shows, as its owner set it (feeds.md).
iconstringalways
The name of the icon its owner chose for it.

hashtag.HashtagNodeItem

A hashtag.

aliasstring
What it is found by: /hashtags/<alias>.
followedboolean
In the following and all lists: the viewer follows it.
idintegeralways
Its id.
namestring
The hashtag as it is shown, without its #.
profilesinteger
In a trending list: how many profiles used it in the window, each once: the writers of posts carrying it, and the profiles tagged with it. At least 0.
typestringalways
Always node.tag.hashtag-service.hashtag.v1.
usesinteger
In the following and all lists: how many posts it is on that anybody may see, and the viewer's own. At least 0.

hashtag.Suggestion

A hashtag in use, offered.

aliasstringalways
In lower case: what it is found by, and what to write after the #.
followedbooleanalways
In one of the viewer's custom feeds.
idintegeralways
namestringalways
As it is shown.
usesintegeralways
How many posts it is on that anybody may see, and the viewer's own.

hashtag.SuggestResponse

The hashtags offered, the best first.

datalist of hashtag.Suggestion or nullalways

Image

One size of a picture.

sizeImageSizealways
How big it is.
urlstringalways
Where it is read from.

ImageSize

How big an image is.

heightintegeralways
In pixels.
widthintegeralways
In pixels.

LimitedActor

What somebody is shown of a profile they may not see, when that profile lets people ask to follow it: enough to know whose it is and to ask.

aliasstring
allow_follow_requestbooleanalways
Whether it lets people ask to follow it. False for one shown only because the viewer was invited.
avatar_urlsmap of Image
bodystring
And what it is, for the same reason. Only with Event.
eventEvent
On an event the viewer was invited to: when it is, so they can decide. Never where to join it online.
idintegeralways
is_follow_requested_by_viewerbooleanalways
Whether the viewer has asked already and is waiting.
is_invitedboolean
Whether the viewer has been invited to follow it and is yet to answer.
namestring
restrictedbooleanalways
Always true. What tells a client this is not the profile itself.
typestringalways
verifiedboolean
via_hostboolean
An event that lets in the followers of the group hosting it, shown to one of them. They can answer it as it stands, going or maybe.

LinkPreview

The card a note carries for a link in it: what the page was called and was about when the note was written.

descriptionstring
What the page says of itself.
imagestring
Where its picture is read from, on this installation: a path under the API. Never the other site's own address for it.
site_namestring
The site it is on, as it calls itself.
titlestringalways
What the page is called.
urlstringalways
The link.

linkpreview.PreviewResponse

A preview as it is sent: what the page says of itself.

descriptionstring
What the page says of itself.
imagestring
Where the picture is read from, on this installation.
site_namestring
The site it is on, as it calls itself.
titlestringalways
What the page is called.
urlstringalways
The link, as it was made plain before it was read.

location.LocationNodeItem

A place posts can be tied to.

addressstring
Its street address.
aliasstring
Its short name.
authorizedNodeAuthorized
What the viewer may do with it.
citystring
Its city.
countrystring
Its country.
idintegeralways
Its id.
latitudenumber
Where it is: latitude, found from its address.
longitudenumber
Where it is: longitude.
namestring
What it is called.
postal_codestring
Its postal or zip code.
profilesinteger
In a trending list: how many profiles used it in the window, each once: the writers of posts tied to it, and the profiles tagged with it. At least 0.
state_provincestring
Its state or province.
typestringalways
Always a place's type.

MediaRemoved

What a post from another server says of pictures that are no longer stored here: how many there were, what each showed, and whether they can still be had from where they came from.

altslist of string or nullalways
What each showed, as its author said; "" where nothing was said.
countintegeralways
How many pictures there were.
goneboolean
They are not where they came from any more either: the post was taken away there, or its server is gone.

MediumNode

A post or a reply, read on its own or answered with after a change.

accessstring
Who may see it: public, registered, followers, leaders, mutuals, admins or myself (permissions.md).
aliasstring
Its short name, where it has one.
allow_downloadboolean
Whether whoever can see it may download what it holds. Sent on a post that holds a file, for whoever may change it.
authorAuthor
Related Entities
authorizedNodeAuthorized
Authorization Information
citation_countintegeralways
How many people cite it, each once, never its author.
comment_countintegeralways
How many replies are under it.
comment_statusbooleanalways
Whether it takes replies at all.
contentstring
Its words, as Markdown.
cover_urlsmap of Image
Media URLs
created_attime
When it was written.
deletedboolean
On a reply: removed, and kept as an empty placeholder because other replies hang from it. It carries no text and no author.
draftboolean
That it is a draft, an article or a topic still being written, seen by its author alone.
editorEditor
Who changed it last.
enabledbooleanalways
Whether it is shown: false when it has been disabled.
fileslist of PhotoFile
The images of a photo post, in order. The first is the one portrait_urls shows.
hiddenboolean
On a reply: hidden from its thread. Sent only to somebody who may show it again.
idintegeralways
Its id.
is_liked_by_viewerbooleanalways
Whether the viewer likes it.
is_reposted_by_viewerbooleanalways
Whether the viewer has reposted it.
is_saved_by_viewerboolean
Whether the viewer has saved it. Sent to them alone, like the rest of what is said here about the viewer.
is_subscribed_by_viewerboolean
Whether the viewer asked to be told of its replies (Get notifications, docs/notifications.md).
languagestring
The language it is written in, as its author said (en, fa).
library_onlyboolean
That it is in its author's media library only: put up to be shown in an article, and listed nowhere else.
likes_countintegeralways
How many like it.
link_previewLinkPreview
On a note that carries one: the preview of a link in it.
link_previewslist of LinkPreview
The cards of the pages it shows within its text, an article's or a topic's: an address on a line of its own each.
media_removedMediaRemoved
On a photo post from another server whose pictures are no longer stored here.
mimetypestring
The kind of file it holds, where it holds one.
origin_domainstring
The server it came from, when it came from another.
ownerOwner
The profile it is on.
parent_idinteger
As on MediumNodeItem.
pinnedbooleanalways
Whether it is pinned to the profile it is on, which it then leads.
portrait_urlsmap of Image
A photo post's first picture, in each size there is: square, small, medium, large, original.
quoteQuoteEmbed
On a note that quotes a post: that post, or why it is not shown.
quote_countintegeralways
How many notes quote it.
quote_idinteger
The id of the post it quotes, whether or not it is shown.
quote_policystring
Who may quote this post, when its author has said: "anyone", "followers" or "nobody". Left out when they have not, and their own setting applies.
reply_accessstring
Who may reply, as the author set it: "anyone", "nobody", or any of "followers", "following" and "mentioned" joined by commas. Not on a reply, which follows the post at the top of its thread.
repost_countintegeralways
How many have reposted it.
rootParent
On a reply read on its own: the post at the top of its thread.
root_idinteger
On a reply: the post at the top of its thread.
titlestring
Its title, where it has one.
typestringalways
What kind of post it is: node.medium.text-service.note.v1 for a note, and so on.
updated_attime
When it was last changed.
uristring
What it is called on the server it came from, and that server, when it came from another. Left out of everything made here.
videoVideo
What a video post plays.
view_countintegeralways
How many times it has been read.

MediumNodeItem

A post or a reply in a list.

accessstring
Who may see it: public, registered, followers, leaders, mutuals, admins or myself (permissions.md).
aliasstring
Its short name, where it has one.
authorAuthor
Related Entities
authorizedNodeAuthorized
What the viewer may do with it, as on the post's own page: reply, like, quote and the rest. Left out where a list does not say.
comment_countintegeralways
How many replies are under it.
contentstring
Its words, as Markdown.
cover_urlsmap of Image
Media URLs
created_attime
When it was written.
deletedboolean
On a reply: removed, and kept as an empty placeholder because other replies hang from it. It carries no text and no author.
fileslist of PhotoFile
The images of a photo post, in order. The first is the one portrait_urls shows.
hiddenboolean
On a reply: hidden from its thread. Sent only to somebody who may show it again.
idintegeralways
Its id.
is_liked_by_viewerbooleanalways
Whether the viewer likes it.
is_reposted_by_viewerbooleanalways
Whether the viewer has reposted it.
is_saved_by_viewerboolean
Whether the viewer has saved it. Sent to them alone, like the rest of what is said here about the viewer.
is_subscribed_by_viewerboolean
Whether the viewer asked to be told of its replies (Get notifications, docs/notifications.md).
languagestring
The language the author said it is written in. Left out when they did not say.
likes_countintegeralways
How many like it.
link_previewLinkPreview
On a note that carries one: the preview of a link in it.
link_previewslist of LinkPreview
The cards of the pages it shows within its text, an article's or a topic's: an address on a line of its own each.
media_removedMediaRemoved
On a photo post from another server whose pictures are no longer stored here.
mimetypestring
The kind of file it holds, where it holds one.
origin_domainstring
The server it came from, when it came from another.
ownerOwner
The profile it is on.
parent_idinteger
On a reply: the post or reply it answers, and the post at the top of its thread. Left out on anything that is not a reply.
portrait_urlsmap of Image
A photo post's first picture, in each size there is: square, small, medium, large, original.
quoteQuoteEmbed
On a note that quotes a post: that post, or why it is not shown.
quote_countintegeralways
How many notes quote it.
quote_idinteger
The id of the post it quotes, whether or not it is shown.
repost_countintegeralways
How many have reposted it.
root_idinteger
On a reply: the post at the top of its thread.
titlestring
Its title, where it has one.
typestringalways
What kind of post it is: node.medium.text-service.note.v1 for a note, and so on.
uristring
What it is called on the server it came from, and that server, when it came from another. Left out of everything made here.
videoVideo
What a video post plays.

NodeAddPermission

accessstringalways
entitystringalways

NodeAuthorized

What the viewer may do with what it is sent with, as the server's own rules answer. edit, delete and administration are always there. The rest are left out when not worked out for this answer, so that a client can tell "no" from "not answered here" (see entities.AnahitaNodeAuthorized); composers is left out when empty too, since every person and group answer works it out.

add_followerboolean
On a profile: whether the viewer may add a follower to it.
administrationbooleanalways
Whether the viewer may look after it: on a profile, its settings.
audienceslist of string
On a person or group: who a new post there may be shown to. On a post: who it may be changed to be shown to, for somebody who may edit it. Widest first; left out otherwise.
block_from_ownerboolean
On a post or a reply in a group or an event: whether the viewer may block its writer from there, as the group.
commentboolean
Whether the viewer may reply to it.
composerslist of string
On a profile: the kinds of post the viewer may make on it.
deletebooleanalways
Whether the viewer may delete it.
downloadboolean
On a post that holds a file: whether the viewer may download it.
editbooleanalways
Whether the viewer may change it.
hideboolean
On a reply: whether the viewer may hide it from its thread.
inviteboolean
Whether the viewer may invite people to follow this actor.
likeboolean
Whether the viewer may like it.
pinboolean
On a post: whether the viewer may pin it to the profile it is on.
quoteboolean
On a post: whether the viewer may quote it.

NodeFeature

add_permissionslist of NodeAddPermission or nullalways
composerslist of string or nullalways
enabledbooleanalways
node_typeslist of string or nullalways
optionalbooleanalways
orderingintegeralways
servicestringalways

NodeItem

A post, a reply, a profile or anything else there is, as a list or a read sends it: what it is not is left out.

accessstring
Who may see it: public, registered, followers, leaders, mutuals, admins or myself (permissions.md).
aliasstring
A profile's handle (ana, or ana@mastodon.social for somebody on another server), or a hashtag's name.
authorAuthor
Related Entities
authorizedNodeAuthorized
What the viewer may do with the item. feed-service fills in comment and like, which the feed's buttons read; nothing else here computes it.
avatar_urlsmap of Image
Media URLs
bodystring
A profile's description, or a custom feed's. Left out on a post, whose words are its content.
comment_countinteger
How many replies are under it. A post in a feed said nothing of this, so its interactions counted its replies as none.
contentstring
A post's words, as Markdown.
cover_urlsmap of Image
A profile's cover picture, in each size there is: medium, large.
created_attime
When it was made.
editorEditor
Who changed it last.
eventEvent
On an event: when it is and how many are going. Left out on anything else, and where whoever sent the node did not attach it.
feedFeedBrief
On a custom feed: its picture and what it shows. Left out on anything else.
fileslist of PhotoFile
The images of a photo post, in order. The first is the one portrait_urls shows.
follower_countinteger
How many follow it, on a profile.
idintegeralways
Its id.
is_admined_by_viewerboolean
On a profile: whether the viewer is one of its administrators.
is_blocked_by_viewerboolean
On a profile: whether the viewer has blocked it.
is_following_viewerboolean
On a profile: whether it follows the viewer.
is_leading_viewerboolean
On a profile: whether the viewer follows it.
is_liked_by_viewerboolean
Whether the viewer likes it.
is_reposted_by_viewerboolean
Whether the viewer has reposted it.
is_saved_by_viewerboolean
Whether the viewer has saved it. Sent to them alone, like the rest of what is said here about the viewer.
is_subscribed_by_viewerboolean
Set by the subscribe and unsubscribe handlers, which answer with the node they acted on. The mapper had no field for it, so mapping their response would have silently dropped the one thing it reports.
languagestring
The language it is written in, as its author said (en, fa).
likes_countinteger
How many like it.
link_previewLinkPreview
On a note that carries one: the preview of a link in it.
media_removedMediaRemoved
On a photo post from another server whose pictures are no longer stored here.
mimetypestring
The kind of file it holds, where it holds one.
namestring
A profile's name, a custom feed's or a hashtag's. Left out on a post, which has a title instead.
origin_domainstring
The server it came from, when it came from another.
ownerOwner
The profile it is on.
parentParent
What it answers, on a reply; what it reposts, on a repost.
pinnedboolean
Pinned to the profile it is on, which it then leads.
portrait_urlsmap of Image
A photo post's first picture, in each size there is: square, small, medium, large, original.
quoteQuoteEmbed
On a note that quotes a post: that post, or why it is not shown.
quote_countinteger
How many notes quote it.
quote_idinteger
The id of the post it quotes, on a note that quotes one.
repost_countinteger
How many have reposted it.
rootParent
On a reply: the post at the top of its thread, with the profile the thread is on.
root_idinteger
Set on a reply: the post at the top of its thread. Its parent, what it directly answers, is sent whole as parent.
titlestring
A post's title, where it has one.
typestringalways
What kind of thing it is: node.medium.text-service.note.v1 for a note, node.actor.actor-service.person.v1 for a person, and so on.
uristring
What it is called on the server it came from, and that server, when it came from another. Left out of everything made here.
verifiedboolean
A mark kept from earlier versions of Anahita. Nothing sets it yet.
videoVideo
What a video post plays.

notification.MarkedRead

How many notifications Mark all read marked.

countintegeralways
How many were unread, and are read now.

notification.NotificationItem

Something the viewer is told of.

actionslist of string
What the viewer can do from it, now: answer_request (accept or decline a request to follow that is still waiting), follow (they do not follow whoever did it), reply. Left out when nothing.
comment_idinteger
The reply or the repost that holds what was done, where it is not the object: the reply to answer, for a reply.
created_attimealways
When it was made.
idintegeralways
Its id.
idslist of integer
Grouped with it (likes of one post, reposts of one post, follows of one profile): every notification's id, this one's first. Reading or deleting it is reading or deleting them all.
is_readbooleanalways
Whether the viewer has read it.
objectone of notification.Object, nullalways
What was done.
otherslist of notification.Subject
Whoever else did the same, newest first, at most two.
others_countinteger
How many more did it than are named.
servicestringalways
The service that told it.
subjectone of notification.Subject, nullalways
Who did it.
targetone of notification.Target, nullalways
What it was done to.
typestringalways
What it tells of, as the event that made it is named.
updated_attimealways
When it last changed: when it was read, for one.

notification.Object

What was done: a post, a reply, a like.

aliasstring
Its handle, or its short name.
bodystring
A profile's description. Left out on a post, whose words are its content.
contentstring
A post's words, as Markdown.
idintegeralways
Its id.
namestring
A profile's name. Left out on a post, which has a title instead.
portrait_urlsmap of Image
A photo post's first picture, in each size there is.
servicestring
The service it belongs to.
titlestring
A post's title, where it has one.
typestringalways
What kind of thing it is.

notification.Settings

Settings are what a person is told about, every kind of thing in order.

topicslist of notification.TopicChoice or nullalways

notification.Subject

Who did what a notification tells of.

aliasstring
Its handle, or its short name.
avatar_urlsmap of Image
Their picture, in each size there is.
idintegeralways
Its id.
namestring
Its name, or its title.
typestring
What kind of thing it is.

notification.Target

What it was done to: the viewer's post, or the viewer.

aliasstring
Its handle, or its short name.
idintegeralways
Its id.
namestring
A profile's name. Left out on a post, which has a title instead.
titlestring
A post's title, where it has one.
typestring
What kind of thing it is.

notification.TopicChoice

Whether a person is told about one kind of thing.

onbooleanalways
Whether they are told about it.
topicstringalways
The kind of thing: likes, reposts, replies, mentions, follows, posts, events or invitations.

notification.UnreadCount

How many notifications the viewer has not read.

countintegeralways
How many. At least 0.
newest_attime
When the newest of all their notifications, read or not, was told: changed, there is something new to fetch. Left out when they have none.

Owner

The profile something is on.

aliasstring
A profile's handle (ana, or ana@mastodon.social for somebody on another server), or a hashtag's name.
avatar_urlsmap of Image
Its picture, in each size there is: small, medium, large, square.
bodystring
Its description.
idintegeralways
Its id.
is_following_viewerboolean
Whether the owner follows the viewer.
is_leading_viewerboolean
Whether the viewer follows the owner: with is_following_viewer, what the Follow item in a post's menu says (Unfollow, Follow, Follow back).
namestring
A profile's name, or a post's title where it has one.
typestringalways
What kind of thing it is: node.actor.<service>.person.v1, ...group.v1, ...event.v1, or a post's kind.

Parent

A post another one hangs from: what a reply answers, what a repost reposts, or the post at the top of a thread.

accessstring
Who may see it. Said so that a repost can be shared as what it reposts.
aliasstring
A profile's handle (ana, or ana@mastodon.social for somebody on another server), or a hashtag's name.
authorAuthor
Who wrote it.
authorizedNodeAuthorized
What the viewer may do with it.
bodystring
A profile's description. Left out on a post, whose words are its content.
contentstring
A post's words, as Markdown.
cover_urlsmap of Image
A profile's cover picture, in each size there is.
created_attime
When it was written, so that a reposted post can be shown as itself.
fileslist of PhotoFile
The pictures of a photo post, in order.
idintegeralways
Its id.
is_liked_by_viewerboolean
Whether the viewer likes it.
is_reposted_by_viewerboolean
Whether the viewer has reposted it.
is_saved_by_viewerboolean
Whether the viewer has saved it. Sent to them alone, like the rest of what is said here about the viewer.
link_previewLinkPreview
The preview of a link in it.
namestring
A profile's name. Left out on a post, which has a title instead.
ownerOwner
The profile it is on.
portrait_urlsmap of Image
A photo post's first picture, in each size there is.
titlestring
A post's title, where it has one.
typestringalways
What kind of thing it is: node.actor.<service>.person.v1, ...group.v1, ...event.v1, or a post's kind.
videoVideo
What a video post plays.

PersonEditAddPermission

accessstringalways
Who may add it.
entitystringalways
What may be added: a kind of post.

PersonFeatureRequest

add_permissionslist of PersonEditAddPermission or nullalways
Who may add what.
composerslist of string or nullalways
The composers it offers.
enabledbooleanalways
Whether it is on for this profile.
node_typeslist of string or nullalways
The kinds of post it makes.
optionalbooleanalways
Whether it may be turned off.
orderingintegeralways
Where it comes among the others.
servicestringalways
The service it is.

photo.FileRef

FileRef names one image a post is to have: one it has already, by its id, or one that was uploaded for it, by the upload's id.

alt_textstringalways
What it shows, for people who cannot see it.
idstringalways
An image the post has already, by its id.
upload_idintegeralways
An image uploaded for it, by the upload's id.

photo.FilesRefusal

FilesRefusal says why a post's images were refused, and how many a post may have.

errorstringalways
Why: files_required, too_many_files, file_not_found, file_repeated, upload_not_yours, alt_text_too_long, file_unreadable, file_unsupported or file_too_large.
maxintegeralways
How many images a post may have.

photo.Uploaded

An image stored for a post that is not made yet.

heightintegeralways
In pixels.
upload_idintegeralways
What the post names it by, in uploads.
urlsmap of Image or nullalways
Each size made of it, as a post's pictures are sent.
widthintegeralways
In pixels.

PhotoFile

One image of a photo post.

alt_textstringalways
What the image shows, for people who cannot see it. Always sent, empty when there is none, so a client can tell "none" from "not told".
heightinteger
Of the image as uploaded, in pixels.
idstringalways
What an edit names the image by. The stored name, which is already in every address below.
positionintegeralways
Where it comes among the post's pictures, from 0.
urlsmap of Image
Each stored size, as portrait_urls is for the first image.
widthinteger
Of the image as uploaded. Left out for an image stored before these were recorded.

PicturesRestored

PicturesRestored says the pictures of a post from another server are here again.

restoredintegeralways
How many were copied.

Preview

What was read off a page.

descriptionstring
What the page says of itself.
final_urlstring
Where the address led, after any redirects.
image_keystring
The picture, as a key in this installation's own storage. Never the page's own address for it: nobody reading a note is sent to another site for a picture.
site_namestring
The site it is on, as it calls itself.
statusstringalways
How reading the page went: ok, failed, or blocked when the address may not be read.
titlestring
What the page is called.
urlstringalways
The address as it was asked for, and where it led.

PurgeItem

How far one profile of a purge has got.

aliasstringalways
What it was called.
errorstring
Why it failed.
idintegeralways
The profile's id.
statusstringalways
queued, done or failed.

PurgeProgress

How far a purge request has got.

batch_idstringalways
What it is asked about by.
doneintegeralways
How many are purged.
failedintegeralways
How many failed.
itemslist of PurgeItem or nullalways
Each profile.
queuedintegeralways
How many are waiting.
totalintegeralways
How many it names.

PurgeQueued

PurgeQueued says what a request to purge did.

batch_idstringalways
What to ask about it by.
queuedintegeralways
How many were queued.
skippedintegeralways
How many were purged or queued already.

PurgeRefusal

Why one profile cannot be purged.

idintegeralways
The profile's id.
reasonstringalways
Why not.

PurgeRefused

PurgeRefused refuses a purge: nothing was queued.

errorstringalways
Always purge_refused.
refusedlist of PurgeRefusal or nullalways
Each profile that cannot be purged, and why.

QuoteEmbed

What a note that quotes a post carries about it: the post, when this viewer may see it, or why it is not shown.

postParent
The quoted post, with its author, the profile it is on and its date.
statestring
"unavailable" when the viewer may not see the quoted post or it is gone; "detached" when its author took it out of this quote. Left out when the post is there.

recommendation.ActorsResponse

Who the viewer might follow, and why.

itemslist of recommendation.SuggestionItem or nullalways
The suggestions, best first.
relatedlist of ActorBrief or nullalways
What the reasons name, for saying them in words: the people who follow somebody suggested, the hashtags shared. The ones the viewer may see.

recommendation.Interest

A hashtag offered to pick, and on how many public posts it was lately.

aliasstringalways
What it is found by.
countintegeralways
How many posts it was on, lately.
idintegeralways
The hashtag's id.
namestringalways
The hashtag, as it is shown.

recommendation.PreferencesResponse

Somebody's choices as they are sent: with the weights they are ranked by, each reason there, and the service's own to go back to.

active_within_choiceslist of integer or nullalways
What active_within_days may be, nearest first, and what it is for somebody who has not chosen.
active_within_daysintegeralways
How lately somebody must have been here to be suggested to them, in days. Nothing is no limit.
active_within_defaultintegeralways
What active_within_days is for somebody who has not chosen.
default_weightsmap of number or nullalways
The service's own weights.
discoverablebooleanalways
That they may be suggested to other people.
max_weightnumberalways
The most a weight may be.
reasonslist of string or nullalways
The reasons, in the order to list them.
suggest_eventsbooleanalways
To be suggested events.
suggest_groupsbooleanalways
To be suggested groups.
suggest_peoplebooleanalways
To be suggested people, and groups.
use_activitybooleanalways
That what they liked and wrote may be used to choose for them.
weightsmap of number or nullalways
What each reason counts for, for the viewer, by its name.

recommendation.Reason

Why a profile is suggested, as it is sent.

countintegeralways
How strongly.
idslist of integer
Up to three of what it was found through: the people or the hashtags, named in the answer's related.
typestringalways
Which reason: follows_you, followed_by_leaders, cited_by_leaders, inviter, hosted_by_leader, shared_interest, you_engaged, cited, popular or featured (recommendations.md).

recommendation.SuggestionItem

One suggestion as it is sent: the profile, and why.

actorone of NodeItem, nullalways
The profile.
actor_idintegeralways
The profile's id.
reasonslist of recommendation.Reason or nullalways
Why, the one that counted most first.
scorenumberalways
What it scored: higher is better.

Refusal

Why a request was refused, where the answer says: most refusals have no body, and some send this.

descriptionstring
The same in words, for whoever is building a client.
errorstringalways
Why, as a code a client can tell apart: language_invalid, quote_not_allowed and so on. Each route lists its own.
reasonstring
What lies behind it, where one code has several causes: why a post may not be quoted, for one.

search.PreferencesResponse

The viewer's own steps for search's Most relevant: how much each sign that something was found useful counts for them, as a step that multiplies the installation's own weight.

adjustablelist of string or nullalways
What may be set: like, save, reply, follow, cite and following (what the viewer follows coming first).
optionslist of number or nullalways
What each may be set to: 0 (off), 0.5, 1 (as is), 1.5 and 2.
stepsmap of number or nullalways
By name, what they have set; what is not here is 1, as the installation has it.

socialgraph.InviteAnswer

The viewer's answer to an invitation.

acceptedbooleanalways
Whether they accepted it: they follow now.

socialgraph.InviteItem

One invitation as it is sent: who, to what, by whom, and until when.

actorone of ActorBrief, nullalways
What they are invited to follow.
created_attimealways
When.
ends_attimealways
When it lapses, unanswered.
inviterone of ActorBrief, nullalways
Who invited them.
personone of ActorBrief, nullalways
Who is invited.

socialgraph.InviteResult

What became of one person invited.

person_idintegeralways
Who.
resultstringalways
invited; or why not: already_follower, not_follower, blocked, cooldown, pending, requested, unavailable, full or closed.

syndication.Checked

Checked says whether the token was found.

methodstring
dns or file: where it was found.
provedbooleanalways

syndication.Connection

A website being connected: its feed, and the token with both places it may be put.

domainstringalways
The domain to prove, and the host the file is read from.
feed_descriptionstring
feed_titlestring
feed_urlstringalways
file_urlstringalways
Or a file at this address, holding the token.
hoststringalways
idintegeralways
The connection's id, for checking the proof and making the website.
record_namestringalways
A TXT record of this name, holding the token.
site_urlstringalways
The site and its feed, as found.
suggested_aliasstringalways
suggested_namestringalways
A name and a handle to begin with: the feed's title, and the domain's first word.
tokenstringalways
What to put in either place.

syndication.Made

The website as it was made: where to go to see it.

aliasstringalways
idintegeralways

text.HiddenAnswer

HiddenAnswer says whether a reply is hidden now.

hiddenbooleanalways
Whether it is hidden.
idintegeralways
The reply's id.

text.NotARoot

NotARoot refuses a thread asked for by a reply, and says the post at the top of the one it is in.

errorstringalways
Always not_a_root.
root_idintegeralways
The post whose thread it is in.

text.SavedAnswer

SavedAnswer says whether a post is among the viewer's saved now.

idintegeralways
The post's id.
is_saved_by_viewerbooleanalways
Whether the viewer has it saved.

text.Thread

Everything said under a post: the replies, and what the viewer may do there.

can_replybooleanalways
Whether the viewer may reply here at all, for a thread with nothing in it yet.
datalist of MediumNode or nullalways
The replies, each saying what it answers. Hidden ones are sent only to whoever may show them again, marked hidden.
hidden_countintegeralways
For whoever looks after the thread: how many of the replies sent are hidden from everybody else.
reply_accessstringalways
Who the post's author lets reply, for saying why not: anyone, nobody, or any of followers, following and mentioned.
truncatedbooleanalways
Whether the thread is longer than is sent at once: 500 replies.

text.ThreadAdded

A thread as it was made: its notes, first to last.

partslist of MediumNode or nullalways

text.ThreadPart

One note of a thread: what it says, in what language, and the link in it to show a card for, as on a note.

contentstringalways
languagestringalways
link_preview_urlstringalways

Video

What a video post plays: its sizes, largest first, and the still shown before it does.

durationnumberalways
How long it plays, in seconds.
fileslist of VideoFile or nullalways
Each size it can be played in, the largest first.
heightintegeralways
In pixels.
loopboolean
A GIF or an animated PNG: played silently, on a loop.
posterstring
The picture shown before it plays: a path under the API.
widthintegeralways
In pixels: its shape, which a player can be laid out by before it loads.

video.UploadPart

Where one part of an upload is sent.

numberintegeralways
Which part, from 1.
urlstringalways
Where it is sent, with PUT: good for an hour.

video.UploadResponse

An upload as its uploader is told of it.

created_attimealways
When it was begun.
errorstring
Why it failed.
idstringalways
Its id.
node_idinteger
The post, once it is one.
owner_idintegeralways
The profile the post will be on.
parent_idinteger
What it answers, when it is a reply.
part_countinteger
How many parts to send it in.
part_sizeinteger
How large each part is, in bytes, while it is being sent.
sizeinteger
How large it said it is, in bytes.
statusstringalways
uploading, processing, ready, failed or cancelled.
titlestringalways
The post's title.

video.UploadTooLarge

UploadTooLarge refuses a video, a GIF or an animated PNG larger than the installation takes, and says how large it may be.

errorstringalways
Always too_large.
max_bytesintegeralways
The most it may be, in bytes.

VideoFile

One size of a video.

heightintegeralways
In pixels.
typestringalways
The kind of file: video/mp4.
urlstringalways
Where it is read from: a path under the API, the same for as long as the post is there, answered for whoever may see the post.
widthintegeralways
In pixels.

Written by Claude, reviewed by Rastin Mehr · About this