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--
createdAtstring (datetime)--

#profileView

PropertyTypeKnown ValuesRequiredDescription
didstring (did)--
handlestring (handle)--
displayNamestring--
descriptionstring--
avatarstring (uri)--
associated#profileAssociated--
indexedAtstring (datetime)--
createdAtstring (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--
joinedViaStarterPackapp.bsky.graph.defs#starterPackViewBasic--
indexedAtstring (datetime)--
createdAtstring (datetime)--
viewer#viewerState--
labelsarray of com.atproto.label.defs#label--
pinnedPostcom.atproto.repo.strongRef--

#profileAssociated

PropertyTypeKnown ValuesRequiredDescription
listsinteger--
feedgensinteger--
starterPacksinteger--
labelerboolean--
chat#profileAssociatedChat--

#profileAssociatedChat

PropertyTypeKnown ValuesRequiredDescription
allowIncomingstringall
none
following
-

#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)--
knownFollowers#knownFollowers--

#knownFollowers

The subject's followers whom you also follow

PropertyTypeKnown ValuesRequiredDescription
countinteger--
followersarray of #profileViewBasic--

#preferences

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

#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
-

#savedFeed

PropertyTypeKnown ValuesRequiredDescription
idstring--
typestringfeed
list
timeline
-
valuestring--
pinnedboolean--

#savedFeedsPrefV2

PropertyTypeKnown ValuesRequiredDescription
itemsarray of app.bsky.actor.defs#savedFeed--

#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
hotness
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
idstring--
valuestring-The muted word itself.
targetsarray of app.bsky.actor.defs#mutedWordTarget-The intended targets of the muted word.
actorTargetstringall
exclude-following
Groups of users to apply the muted word to. If undefined, applies to all users.
expiresAtstring (datetime)-The date and time at which the muted word will expire and no longer be applied.

#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)--

#bskyAppStatePref

A grab bag of state that's specific to the bsky.app program. Third-party apps shouldn't use this.

PropertyTypeKnown ValuesRequiredDescription
activeProgressGuide#bskyAppProgressGuide--
queuedNudgesarray of string-An array of tokens which identify nudges (modals, popups, tours, highlight dots) that should be shown to the user.
nuxsarray of app.bsky.actor.defs#nux-Storage for NUXs the user has encountered.

#bskyAppProgressGuide

If set, an active progress guide. Once completed, can be set to undefined. Should have unspecced fields tracking progress.

PropertyTypeKnown ValuesRequiredDescription
guidestring--

#nux

A new user experiences (NUX) storage object

PropertyTypeKnown ValuesRequiredDescription
idstring--
completedboolean--
datastring-Arbitrary data for the NUX. The structure is defined by the NUX itself. Limited to 300 characters.
expiresAtstring (datetime)-The date and time at which the NUX will expire and should be considered completed.