Skip to main content

app.bsky.actor.defs

#profileViewBasic​

PropertyTypeKnown ValuesRequiredDescription
didstring (did)-✅-
handlestring (handle)-✅-
displayNamestring-❌-
pronounsstring-❌-
avatarstring (uri)-❌-
associated#profileAssociated-❌-
viewer#viewerState-❌-
labelsarray of com.atproto.label.defs#label-❌-
createdAtstring (datetime)-❌-
verification#verificationState-❌-
status#statusView-❌-
debugunknown-❌Debug information for internal development

#profileView​

PropertyTypeKnown ValuesRequiredDescription
didstring (did)-✅-
handlestring (handle)-✅-
displayNamestring-❌-
pronounsstring-❌-
descriptionstring-❌-
avatarstring (uri)-❌-
associated#profileAssociated-❌-
indexedAtstring (datetime)-❌-
createdAtstring (datetime)-❌-
viewer#viewerState-❌-
labelsarray of com.atproto.label.defs#label-❌-
verification#verificationState-❌-
status#statusView-❌-
debugunknown-❌Debug information for internal development

#profileViewDetailed​

PropertyTypeKnown ValuesRequiredDescription
didstring (did)-✅-
handlestring (handle)-✅-
displayNamestring-❌-
descriptionstring-❌-
pronounsstring-❌-
websitestring (uri)-❌-
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-❌-
verification#verificationState-❌-
status#statusView-❌-
debugunknown-❌Debug information for internal development

#profileAssociated​

PropertyTypeKnown ValuesRequiredDescription
listsinteger-❌-
feedgensinteger-❌-
starterPacksinteger-❌-
labelerboolean-❌-
chat#profileAssociatedChat-❌-
activitySubscription#profileAssociatedActivitySubscription-❌-
germ#profileAssociatedGerm-❌-

#profileAssociatedChat​

PropertyTypeKnown ValuesRequiredDescription
allowIncomingstringall
none
following
✅-
allowGroupInvitesstringall
none
following
❌-

#profileAssociatedGerm​

PropertyTypeKnown ValuesRequiredDescription
messageMeUrlstring (uri)-✅-
showButtonTostringusersIFollow
everyone
✅-

#profileAssociatedActivitySubscription​

PropertyTypeKnown ValuesRequiredDescription
allowSubscriptionsstringfollowers
mutuals
none
✅-

#viewerState​

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

PropertyTypeKnown ValuesRequiredDescription
mutedboolean-❌Whether the account is fully muted, directly or via a mutelist. False when the mute is scoped to specific kinds; see mutedOnlyReposts and mutedOnlyQuoteposts.
mutedOnlyRepostsboolean-❌Whether the account's reposts are muted. Scoped mutes are exclusive with muted: this can be true while muted is false. If muted is true, this will be false.
mutedOnlyQuotepostsboolean-❌Whether the account's quote posts are muted. Scoped mutes are exclusive with muted: this can be true while muted is false. If muted is true, this will be false.
mutedByListapp.bsky.graph.defs#listViewBasic-❌-
blockedByboolean-❌-
blockingstring (at-uri)-❌-
blockingByListapp.bsky.graph.defs#listViewBasic-❌-
followingstring (at-uri)-❌-
followedBystring (at-uri)-❌-
knownFollowers#knownFollowers-❌-
activitySubscriptionapp.bsky.notification.defs#activitySubscription-❌-

#knownFollowers​

The subject's followers whom you also follow

PropertyTypeKnown ValuesRequiredDescription
countinteger-✅-
followersarray of #profileViewBasic-✅-

#verificationState​

Represents the verification information about the user this object is attached to.

PropertyTypeKnown ValuesRequiredDescription
verificationsarray of #verificationView-✅All verifications issued by trusted verifiers on behalf of this user. Verifications by untrusted verifiers are not included.
verifiedStatusstringvalid
invalid
none
✅The user's status as a verified account.
trustedVerifierStatusstringvalid
invalid
none
✅The user's status as a trusted verifier.

#verificationView​

An individual verification for an associated subject.

PropertyTypeKnown ValuesRequiredDescription
issuerstring (did)-✅The user who issued this verification.
issuerDisplayNamestring-❌The display name of the issuer.
issuerHandlestring (handle)-❌The handle of the issuer.
uristring (at-uri)-✅The AT-URI of the verification record.
isValidboolean-✅True if the verification passes validation, otherwise false.
createdAtstring (datetime)-✅Timestamp when the verification was created.

#preferences​

PropertyTypeKnown ValuesRequiredDescription
preferencesarray of union
#adultContentPref
#contentLabelPref
#savedFeedsPref
#savedFeedsPrefV2
#personalDetailsPref
#declaredAgePref
#feedViewPref
#threadViewPref
#interestsPref
#mutedWordsPref
#hiddenPostsPref
#bskyAppStatePref
#labelersPref
#postInteractionSettingsPref
#verificationPrefs
#liveEventPreferences
-❌-

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

#declaredAgePref​

Read-only preference containing value(s) inferred from the user's declared birthdate. Absence of this preference object in the response indicates that the user has not made a declaration.

PropertyTypeKnown ValuesRequiredDescription
isOverAge13boolean-❌Indicates if the user has declared that they are over 13 years of age.
isOverAge16boolean-❌Indicates if the user has declared that they are over 16 years of age.
isOverAge18boolean-❌Indicates if the user has declared that they are over 18 years of age.

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

#interestsPref​

PropertyTypeKnown ValuesRequiredDescription
updatedAtstring (datetime)-❌The timestamp when the account owner last updated their interests.
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-❌-
isBetaUserboolean-❌Indicates if the user is participating in the beta features program.
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.

#verificationPrefs​

Preferences for how verified accounts appear in the app.

PropertyTypeKnown ValuesRequiredDescription
hideBadgesboolean-❌Hide the blue check badges for verified accounts and trusted verifiers.

#liveEventPreferences​

Preferences for live events.

PropertyTypeKnown ValuesRequiredDescription
hiddenFeedIdsarray of string-❌A list of feed IDs that the user has hidden from live events.
hideAllFeedsboolean-❌Whether to hide all feeds from live events.

#postInteractionSettingsPref​

Default post interaction settings for the account. These values should be applied as default values when creating new posts. These refs should mirror the threadgate and postgate records exactly.

PropertyTypeKnown ValuesRequiredDescription
threadgateAllowRulesarray of union
app.bsky.feed.threadgate#mentionRule
app.bsky.feed.threadgate#followerRule
app.bsky.feed.threadgate#followingRule
app.bsky.feed.threadgate#listRule
-❌Matches threadgate record. List of rules defining who can reply to this users posts. If value is an empty array, no one can reply. If value is undefined, anyone can reply.
postgateEmbeddingRulesarray of union
app.bsky.feed.postgate#disableRule
-❌Matches postgate record. List of rules defining who can embed this users posts. If value is an empty array or is undefined, no particular rules apply and anyone can embed.

#statusView​

PropertyTypeKnown ValuesRequiredDescription
uristring (at-uri)-❌-
cidstring (cid)-❌-
statusstringapp.bsky.actor.status#live✅The status for the account.
recordunknown-✅-
embedunion of
app.bsky.embed.external#view
-❌-
labelsarray of com.atproto.label.defs#label-❌-
expiresAtstring (datetime)-❌The date when this status will expire. The application might choose to no longer return the status after expiration.
isActiveboolean-❌True if the status is not expired, false if it is expired. Only present if expiration was set.
isDisabledboolean-❌True if the user's go-live access has been disabled by a moderator, false otherwise.