app.bsky.actor.defs
#profileViewBasic
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| did | string (did) | - | ✅ | - |
| handle | string (handle) | - | ✅ | - |
| displayName | string | - | ❌ | - |
| pronouns | string | - | ❌ | - |
| avatar | string (uri) | - | ❌ | - |
| associated | #profileAssociated | - | ❌ | - |
| viewer | #viewerState | - | ❌ | - |
| labels | array of com.atproto.label.defs#label | - | ❌ | - |
| createdAt | string (datetime) | - | ❌ | - |
| verification | #verificationState | - | ❌ | - |
| status | #statusView | - | ❌ | - |
| debug | unknown | - | ❌ | Debug information for internal development |
#profileView
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| did | string (did) | - | ✅ | - |
| handle | string (handle) | - | ✅ | - |
| displayName | string | - | ❌ | - |
| pronouns | string | - | ❌ | - |
| description | string | - | ❌ | - |
| avatar | string (uri) | - | ❌ | - |
| associated | #profileAssociated | - | ❌ | - |
| indexedAt | string (datetime) | - | ❌ | - |
| createdAt | string (datetime) | - | ❌ | - |
| viewer | #viewerState | - | ❌ | - |
| labels | array of com.atproto.label.defs#label | - | ❌ | - |
| verification | #verificationState | - | ❌ | - |
| status | #statusView | - | ❌ | - |
| debug | unknown | - | ❌ | Debug information for internal development |
#profileViewDetailed
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| did | string (did) | - | ✅ | - |
| handle | string (handle) | - | ✅ | - |
| displayName | string | - | ❌ | - |
| description | string | - | ❌ | - |
| pronouns | string | - | ❌ | - |
| website | string (uri) | - | ❌ | - |
| avatar | string (uri) | - | ❌ | - |
| banner | string (uri) | - | ❌ | - |
| followersCount | integer | - | ❌ | - |
| followsCount | integer | - | ❌ | - |
| postsCount | integer | - | ❌ | - |
| associated | #profileAssociated | - | ❌ | - |
| joinedViaStarterPack | app.bsky.graph.defs#starterPackViewBasic | - | ❌ | - |
| indexedAt | string (datetime) | - | ❌ | - |
| createdAt | string (datetime) | - | ❌ | - |
| viewer | #viewerState | - | ❌ | - |
| labels | array of com.atproto.label.defs#label | - | ❌ | - |
| pinnedPost | com.atproto.repo.strongRef | - | ❌ | - |
| verification | #verificationState | - | ❌ | - |
| status | #statusView | - | ❌ | - |
| debug | unknown | - | ❌ | Debug information for internal development |
#profileAssociated
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| lists | integer | - | ❌ | - |
| feedgens | integer | - | ❌ | - |
| starterPacks | integer | - | ❌ | - |
| labeler | boolean | - | ❌ | - |
| chat | #profileAssociatedChat | - | ❌ | - |
| activitySubscription | #profileAssociatedActivitySubscription | - | ❌ | - |
| germ | #profileAssociatedGerm | - | ❌ | - |
#profileAssociatedChat
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| allowIncoming | string | all none following | ✅ | - |
#profileAssociatedGerm
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| messageMeUrl | string (uri) | - | ✅ | - |
| showButtonTo | string | usersIFollow everyone | ✅ | - |
#profileAssociatedActivitySubscription
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| allowSubscriptions | string | followers mutuals none | ✅ | - |
#viewerState
Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests.
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| muted | boolean | - | ❌ | - |
| mutedByList | app.bsky.graph.defs#listViewBasic | - | ❌ | - |
| blockedBy | boolean | - | ❌ | - |
| blocking | string (at-uri) | - | ❌ | - |
| blockingByList | app.bsky.graph.defs#listViewBasic | - | ❌ | - |
| following | string (at-uri) | - | ❌ | - |
| followedBy | string (at-uri) | - | ❌ | - |
| knownFollowers | #knownFollowers | - | ❌ | - |
| activitySubscription | app.bsky.notification.defs#activitySubscription | - | ❌ | - |
#knownFollowers
The subject's followers whom you also follow
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| count | integer | - | ✅ | - |
| followers | array of #profileViewBasic | - | ✅ | - |
#verificationState
Represents the verification information about the user this object is attached to.
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| verifications | array of #verificationView | - | ✅ | All verifications issued by trusted verifiers on behalf of this user. Verifications by untrusted verifiers are not included. |
| verifiedStatus | string | valid invalid none | ✅ | The user's status as a verified account. |
| trustedVerifierStatus | string | valid invalid none | ✅ | The user's status as a trusted verifier. |
#verificationView
An individual verification for an associated subject.
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| issuer | string (did) | - | ✅ | The user who issued this verification. |
| uri | string (at-uri) | - | ✅ | The AT-URI of the verification record. |
| isValid | boolean | - | ✅ | True if the verification passes validation, otherwise false. |
| createdAt | string (datetime) | - | ✅ | Timestamp when the verification was created. |
#preferences
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| preferences | array of union #adultContentPref #contentLabelPref #savedFeedsPref #savedFeedsPrefV2 #personalDetailsPref #declaredAgePref #feedViewPref #threadViewPref #interestsPref #mutedWordsPref #hiddenPostsPref #bskyAppStatePref #labelersPref #postInteractionSettingsPref #verificationPrefs #liveEventPreferences | - | ❌ | - |
#adultContentPref
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| enabled | boolean | - | ✅ | - |
#contentLabelPref
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| labelerDid | string (did) | - | ❌ | Which labeler does this preference apply to? If undefined, applies globally. |
| label | string | - | ✅ | - |
| visibility | string | ignore show warn hide | ✅ | - |
#savedFeed
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| id | string | - | ✅ | - |
| type | string | feed list timeline | ✅ | - |
| value | string | - | ✅ | - |
| pinned | boolean | - | ✅ | - |
#savedFeedsPrefV2
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| items | array of app.bsky.actor.defs#savedFeed | - | ✅ | - |
#savedFeedsPref
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| pinned | array of string | - | ✅ | - |
| saved | array of string | - | ✅ | - |
| timelineIndex | integer | - | ❌ | - |
#personalDetailsPref
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| birthDate | string (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.
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| isOverAge13 | boolean | - | ❌ | Indicates if the user has declared that they are over 13 years of age. |
| isOverAge16 | boolean | - | ❌ | Indicates if the user has declared that they are over 16 years of age. |
| isOverAge18 | boolean | - | ❌ | Indicates if the user has declared that they are over 18 years of age. |
#feedViewPref
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| feed | string | - | ✅ | The URI of the feed, or an identifier which describes the feed. |
| hideReplies | boolean | - | ❌ | Hide replies in the feed. |
| hideRepliesByUnfollowed | boolean | - | ❌ | Hide replies in the feed if they are not by followed users. |
| hideRepliesByLikeCount | integer | - | ❌ | Hide replies in the feed if they do not have this number of likes. |
| hideReposts | boolean | - | ❌ | Hide reposts in the feed. |
| hideQuotePosts | boolean | - | ❌ | Hide quote posts in the feed. |
#threadViewPref
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| sort | string | oldest newest most-likes random hotness | ❌ | Sorting mode for threads. |
#interestsPref
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| tags | array of string | - | ✅ | A list of tags which describe the account owner's interests gathered during onboarding. |
#mutedWordTarget
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| mutedWordTarget | string | content tag | ❌ | - |
#mutedWord
A word that the account owner has muted.
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| id | string | - | ❌ | - |
| value | string | - | ✅ | The muted word itself. |
| targets | array of app.bsky.actor.defs#mutedWordTarget | - | ✅ | The intended targets of the muted word. |
| actorTarget | string | all exclude-following | ❌ | Groups of users to apply the muted word to. If undefined, applies to all users. |
| expiresAt | string (datetime) | - | ❌ | The date and time at which the muted word will expire and no longer be applied. |
#mutedWordsPref
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| items | array of app.bsky.actor.defs#mutedWord | - | ✅ | A list of words the account owner has muted. |
#hiddenPostsPref
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| items | array of string | - | ✅ | A list of URIs of posts the account owner has hidden. |
#labelersPref
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| labelers | array of #labelerPrefItem | - | ✅ | - |
#labelerPrefItem
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| did | string (did) | - | ✅ | - |
#bskyAppStatePref
A grab bag of state that's specific to the bsky.app program. Third-party apps shouldn't use this.
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| activeProgressGuide | #bskyAppProgressGuide | - | ❌ | - |
| queuedNudges | array of string | - | ❌ | An array of tokens which identify nudges (modals, popups, tours, highlight dots) that should be shown to the user. |
| nuxs | array 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.
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| guide | string | - | ✅ | - |
#nux
A new user experiences (NUX) storage object
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| id | string | - | ✅ | - |
| completed | boolean | - | ✅ | - |
| data | string | - | ❌ | Arbitrary data for the NUX. The structure is defined by the NUX itself. Limited to 300 characters. |
| expiresAt | string (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.
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| hideBadges | boolean | - | ❌ | Hide the blue check badges for verified accounts and trusted verifiers. |
#liveEventPreferences
Preferences for live events.
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| hiddenFeedIds | array of string | - | ❌ | A list of feed IDs that the user has hidden from live events. |
| hideAllFeeds | boolean | - | ❌ | 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.
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| threadgateAllowRules | array 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. |
| postgateEmbeddingRules | array 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
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| uri | string (at-uri) | - | ❌ | - |
| cid | string (cid) | - | ❌ | - |
| status | string | app.bsky.actor.status#live | ✅ | The status for the account. |
| record | unknown | - | ✅ | - |
| embed | union of app.bsky.embed.external#view | - | ❌ | - |
| expiresAt | string (datetime) | - | ❌ | The date when this status will expire. The application might choose to no longer return the status after expiration. |
| isActive | boolean | - | ❌ | True if the status is not expired, false if it is expired. Only present if expiration was set. |
| isDisabled | boolean | - | ❌ | True if the user's go-live access has been disabled by a moderator, false otherwise. |