Skip to content

Relationship

The viewer’s relationship with an account. It never says whether the account blocks the viewer: such an account is not found at all.

A token sees the fields its scopes cover, wherever the relationship comes from, and the rest are absent, which tells nothing about them: following, requested, followed_by, requested_by, show_boosts, and notify need read:follows or write:follows; blocking needs read:blocks or write:blocks; muting and muting_notifications need read:mutes or write:mutes; note needs read:accounts or write:accounts.

object
id
required

The ID of a resource, a UUIDv7 in its canonical string form.

string format: uuid
following

Whether the viewer actively follows the account.

boolean
requested

Whether the viewer’s follow request awaits the account’s approval.

boolean
followed_by

Whether the account actively follows the viewer.

boolean
requested_by

Whether the account’s follow request awaits the viewer’s approval.

boolean
show_boosts

Whether the viewer’s follow shows the account’s boosts in the home timeline (true without a follow).

boolean
notify

Whether the viewer subscribes to the account’s new posts (subscribeAccount), with or without a follow. A subscription asked for with a follow request to an account on another server is false until that server accepts the follow.

boolean
blocking

Whether the viewer blocks the account.

boolean
muting

Whether the viewer mutes the account (a mute that has not expired).

boolean
muting_notifications

Whether the viewer’s mute also hides the account’s notifications.

boolean
note

The viewer’s private note on the account (setAccountNote), empty without one. Only the viewer reads it.

string
<= 2000 characters

Example generated

{
"id": "01890a5d-ac96-774b-bcce-b302099a8057",
"following": true,
"requested": true,
"followed_by": true,
"requested_by": true,
"show_boosts": true,
"notify": true,
"blocking": true,
"muting": true,
"muting_notifications": true,
"note": "example"
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site