Skip to main content

app.bsky.actor.defs

#profileViewBasic

PropertyTypeKnown ValuesRequiredDescription
didstring (did)--
handlestring (handle)--
displayNamestring--
avatarstring (uri)--
associated#profileAssociated--
viewer#viewerState--
labelsarray of com.atproto.label.defs#label--

#profileView

PropertyTypeKnown ValuesRequiredDescription
didstring (did)--
handlestring (handle)--
displayNamestring--
descriptionstring--
avatarstring (uri)--
associated#profileAssociated--
indexedAtstring (datetime)--
viewer#viewerState--
labelsarray of com.atproto.label.defs#label--

#profileViewDetailed

PropertyTypeKnown ValuesRequiredDescription
didstring (did)--
handlestring (handle)--
displayNamestring--
descriptionstring--
avatarstring (uri)--
bannerstring (uri)--
followersCountinteger--
followsCountinteger--
postsCountinteger--
associated#profileAssociated--
indexedAtstring (datetime)--
viewer#viewerState--
labelsarray of com.atproto.label.defs#label--

#profileAssociated

PropertyTypeKnown ValuesRequiredDescription
listsinteger--
feedgensinteger--
labelerboolean--

#viewerState

Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.

PropertyTypeKnown ValuesRequiredDescription
mutedboolean--
mutedByListapp.bsky.graph.defs#listViewBasic--
blockedByboolean--
blockingstring (at-uri)--
blockingByListapp.bsky.graph.defs#listViewBasic--
followingstring (at-uri)--
followedBystring (at-uri)--

#preferences

PropertyTypeKnown ValuesRequiredDescription
preferencesarray of union
#adultContentPref
#contentLabelPref
#savedFeedsPref
#personalDetailsPref
#feedViewPref
#threadViewPref
#interestsPref
#mutedWordsPref
#hiddenPostsPref
--

#adultContentPref

PropertyTypeKnown ValuesRequiredDescription
enabledboolean--

#contentLabelPref

PropertyTypeKnown ValuesRequiredDescription
labelerDidstring (did)-Which labeler does this preference apply to? If undefined, applies globally.
labelstring--
visibilitystringignore
show
warn
hide
-

#savedFeedsPref

PropertyTypeKnown ValuesRequiredDescription
pinnedarray of string--
savedarray of string--
timelineIndexinteger--

#personalDetailsPref

PropertyTypeKnown ValuesRequiredDescription
birthDatestring (datetime)-The birth date of account owner.

#feedViewPref

PropertyTypeKnown ValuesRequiredDescription
feedstring-The URI of the feed, or an identifier which describes the feed.
hideRepliesboolean-Hide replies in the feed.
hideRepliesByUnfollowedboolean-Hide replies in the feed if they are not by followed users.
hideRepliesByLikeCountinteger-Hide replies in the feed if they do not have this number of likes.
hideRepostsboolean-Hide reposts in the feed.
hideQuotePostsboolean-Hide quote posts in the feed.

#threadViewPref

PropertyTypeKnown ValuesRequiredDescription
sortstringoldest
newest
most-likes
random
Sorting mode for threads.
prioritizeFollowedUsersboolean-Show followed users at the top of all replies.

#interestsPref

PropertyTypeKnown ValuesRequiredDescription
tagsarray of string-A list of tags which describe the account owner's interests gathered during onboarding.

#mutedWordTarget

PropertyTypeKnown ValuesRequiredDescription
mutedWordTargetstringcontent
tag
-

#mutedWord

A word that the account owner has muted.

PropertyTypeKnown ValuesRequiredDescription
valuestring-The muted word itself.
targetsarray of app.bsky.actor.defs#mutedWordTarget-The intended targets of the muted word.

#mutedWordsPref

PropertyTypeKnown ValuesRequiredDescription
itemsarray of app.bsky.actor.defs#mutedWord-A list of words the account owner has muted.

#hiddenPostsPref

PropertyTypeKnown ValuesRequiredDescription
itemsarray of string-A list of URIs of posts the account owner has hidden.

#labelersPref

PropertyTypeKnown ValuesRequiredDescription
labelersarray of #labelerPrefItem--

#labelerPrefItem

PropertyTypeKnown ValuesRequiredDescription
didstring (did)--