app.bsky.actor.defs

adultContentPref object

Properties

enabled boolean Required

No description provided.

View raw schema

{
  "type": "object",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "default": false
    }
  }
}

bskyAppProgressGuide object

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

Properties

guide string Required

No description provided.

maxLength: 100 bytes

View raw schema

{
  "type": "object",
  "required": [
    "guide"
  ],
  "properties": {
    "guide": {
      "type": "string",
      "maxLength": 100
    }
  },
  "description": "If set, an active progress guide. Once completed, can be set to undefined. Should have unspecced fields tracking progress."
}

bskyAppStatePref object

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

Properties

activeProgressGuide ref #bskyAppProgressGuide Optional

No description provided.

nuxs array of refapp.bsky.actor.defs#nux Optional

Storage for NUXs the user has encountered.

maxLength: 100 bytes

queuedNudges array of string Optional

An array of tokens which identify nudges (modals, popups, tours, highlight dots) that should be shown to the user.

maxLength: 1000 bytes

View raw schema

{
  "type": "object",
  "properties": {
    "nuxs": {
      "type": "array",
      "items": {
        "ref": "app.bsky.actor.defs#nux",
        "type": "ref"
      },
      "maxLength": 100,
      "description": "Storage for NUXs the user has encountered."
    },
    "queuedNudges": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100
      },
      "maxLength": 1000,
      "description": "An array of tokens which identify nudges (modals, popups, tours, highlight dots) that should be shown to the user."
    },
    "activeProgressGuide": {
      "ref": "#bskyAppProgressGuide",
      "type": "ref"
    }
  },
  "description": "A grab bag of state that's specific to the bsky.app program. Third-party apps shouldn't use this."
}

contentLabelPref object

Properties

label string Required

No description provided.

labelerDid string did Optional

Which labeler does this preference apply to? If undefined, applies globally.

visibility string Required

No description provided.

Known values: ignore, show, warn, hide

View raw schema

{
  "type": "object",
  "required": [
    "label",
    "visibility"
  ],
  "properties": {
    "label": {
      "type": "string"
    },
    "labelerDid": {
      "type": "string",
      "format": "did",
      "description": "Which labeler does this preference apply to? If undefined, applies globally."
    },
    "visibility": {
      "type": "string",
      "knownValues": [
        "ignore",
        "show",
        "warn",
        "hide"
      ]
    }
  }
}

declaredAgePref object

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.

Properties

isOverAge13 boolean Optional

Indicates if the user has declared that they are over 13 years of age.

isOverAge16 boolean Optional

Indicates if the user has declared that they are over 16 years of age.

isOverAge18 boolean Optional

Indicates if the user has declared that they are over 18 years of age.

View raw schema

{
  "type": "object",
  "properties": {
    "isOverAge13": {
      "type": "boolean",
      "description": "Indicates if the user has declared that they are over 13 years of age."
    },
    "isOverAge16": {
      "type": "boolean",
      "description": "Indicates if the user has declared that they are over 16 years of age."
    },
    "isOverAge18": {
      "type": "boolean",
      "description": "Indicates if the user has declared that they are over 18 years of age."
    }
  },
  "description": "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."
}

feedViewPref object

Properties

feed string Required

The URI of the feed, or an identifier which describes the feed.

hideQuotePosts boolean Optional

Hide quote posts in the feed.

hideReplies boolean Optional

Hide replies in the feed.

hideRepliesByLikeCount integer Optional

Hide replies in the feed if they do not have this number of likes.

hideRepliesByUnfollowed boolean Optional

Hide replies in the feed if they are not by followed users.

hideReposts boolean Optional

Hide reposts in the feed.

View raw schema

{
  "type": "object",
  "required": [
    "feed"
  ],
  "properties": {
    "feed": {
      "type": "string",
      "description": "The URI of the feed, or an identifier which describes the feed."
    },
    "hideReplies": {
      "type": "boolean",
      "description": "Hide replies in the feed."
    },
    "hideReposts": {
      "type": "boolean",
      "description": "Hide reposts in the feed."
    },
    "hideQuotePosts": {
      "type": "boolean",
      "description": "Hide quote posts in the feed."
    },
    "hideRepliesByLikeCount": {
      "type": "integer",
      "description": "Hide replies in the feed if they do not have this number of likes."
    },
    "hideRepliesByUnfollowed": {
      "type": "boolean",
      "default": true,
      "description": "Hide replies in the feed if they are not by followed users."
    }
  }
}

hiddenPostsPref object

Properties

items array of stringat-uri Required

A list of URIs of posts the account owner has hidden.

View raw schema

{
  "type": "object",
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "at-uri"
      },
      "description": "A list of URIs of posts the account owner has hidden."
    }
  }
}

interestsPref object

Properties

tags array of string Required

A list of tags which describe the account owner's interests gathered during onboarding.

maxLength: 100 bytes

View raw schema

{
  "type": "object",
  "required": [
    "tags"
  ],
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 640,
        "maxGraphemes": 64
      },
      "maxLength": 100,
      "description": "A list of tags which describe the account owner's interests gathered during onboarding."
    }
  }
}

knownFollowers object

The subject's followers whom you also follow

Properties

count integer Required

No description provided.

followers array of ref#profileViewBasic Required

No description provided.

maxLength: 5 bytesminLength: 0 bytes

View raw schema

{
  "type": "object",
  "required": [
    "count",
    "followers"
  ],
  "properties": {
    "count": {
      "type": "integer"
    },
    "followers": {
      "type": "array",
      "items": {
        "ref": "#profileViewBasic",
        "type": "ref"
      },
      "maxLength": 5,
      "minLength": 0
    }
  },
  "description": "The subject's followers whom you also follow"
}

labelerPrefItem object

Properties

did string did Required

A decentralized identifier (DID).

View raw schema

{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    }
  }
}

labelersPref object

Properties

labelers array of ref#labelerPrefItem Required

No description provided.

View raw schema

{
  "type": "object",
  "required": [
    "labelers"
  ],
  "properties": {
    "labelers": {
      "type": "array",
      "items": {
        "ref": "#labelerPrefItem",
        "type": "ref"
      }
    }
  }
}

mutedWord object

A word that the account owner has muted.

Properties

actorTarget string Optional

Groups of users to apply the muted word to. If undefined, applies to all users.

Known values: all, exclude-following

expiresAt string datetime Optional

The date and time at which the muted word will expire and no longer be applied.

id string Optional

No description provided.

targets array of refapp.bsky.actor.defs#mutedWordTarget Required

The intended targets of the muted word.

value string Required

The muted word itself.

maxLength: 10000 bytesmaxGraphemes: 1000 graphemes

View raw schema

{
  "type": "object",
  "required": [
    "value",
    "targets"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "value": {
      "type": "string",
      "maxLength": 10000,
      "description": "The muted word itself.",
      "maxGraphemes": 1000
    },
    "targets": {
      "type": "array",
      "items": {
        "ref": "app.bsky.actor.defs#mutedWordTarget",
        "type": "ref"
      },
      "description": "The intended targets of the muted word."
    },
    "expiresAt": {
      "type": "string",
      "format": "datetime",
      "description": "The date and time at which the muted word will expire and no longer be applied."
    },
    "actorTarget": {
      "type": "string",
      "default": "all",
      "description": "Groups of users to apply the muted word to. If undefined, applies to all users.",
      "knownValues": [
        "all",
        "exclude-following"
      ]
    }
  },
  "description": "A word that the account owner has muted."
}

mutedWordTarget string

ConstraintsmaxLength: 640 bytes, maxGraphemes: 64 graphemes

Known Values (other values may be valid)

content tag

View raw schema

{
  "type": "string",
  "maxLength": 640,
  "knownValues": [
    "content",
    "tag"
  ],
  "maxGraphemes": 64
}

mutedWordsPref object

Properties

items array of refapp.bsky.actor.defs#mutedWord Required

A list of words the account owner has muted.

View raw schema

{
  "type": "object",
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "ref": "app.bsky.actor.defs#mutedWord",
        "type": "ref"
      },
      "description": "A list of words the account owner has muted."
    }
  }
}

nux object

A new user experiences (NUX) storage object

Properties

completed boolean Required

No description provided.

data string Optional

Arbitrary data for the NUX. The structure is defined by the NUX itself. Limited to 300 characters.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes

expiresAt string datetime Optional

The date and time at which the NUX will expire and should be considered completed.

id string Required

No description provided.

maxLength: 100 bytes

View raw schema

{
  "type": "object",
  "required": [
    "id",
    "completed"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 100
    },
    "data": {
      "type": "string",
      "maxLength": 3000,
      "description": "Arbitrary data for the NUX. The structure is defined by the NUX itself. Limited to 300 characters.",
      "maxGraphemes": 300
    },
    "completed": {
      "type": "boolean",
      "default": false
    },
    "expiresAt": {
      "type": "string",
      "format": "datetime",
      "description": "The date and time at which the NUX will expire and should be considered completed."
    }
  },
  "description": "A new user experiences (NUX) storage object"
}

personalDetailsPref object

Properties

birthDate string datetime Optional

The birth date of account owner.

View raw schema

{
  "type": "object",
  "properties": {
    "birthDate": {
      "type": "string",
      "format": "datetime",
      "description": "The birth date of account owner."
    }
  }
}

postInteractionSettingsPref object

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.

Properties

postgateEmbeddingRules array of union Optional

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.

maxLength: 5 bytes

Known types:

app.bsky.feed.postgate#disableRule

threadgateAllowRules array of union Optional

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.

maxLength: 5 bytes

Known types:

View raw schema

{
  "type": "object",
  "required": [],
  "properties": {
    "threadgateAllowRules": {
      "type": "array",
      "items": {
        "refs": [
          "app.bsky.feed.threadgate#mentionRule",
          "app.bsky.feed.threadgate#followerRule",
          "app.bsky.feed.threadgate#followingRule",
          "app.bsky.feed.threadgate#listRule"
        ],
        "type": "union"
      },
      "maxLength": 5,
      "description": "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": {
      "type": "array",
      "items": {
        "refs": [
          "app.bsky.feed.postgate#disableRule"
        ],
        "type": "union"
      },
      "maxLength": 5,
      "description": "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."
    }
  },
  "description": "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."
}

preferences array

View raw schema

{
  "type": "array",
  "items": {
    "refs": [
      "#adultContentPref",
      "#contentLabelPref",
      "#savedFeedsPref",
      "#savedFeedsPrefV2",
      "#personalDetailsPref",
      "#declaredAgePref",
      "#feedViewPref",
      "#threadViewPref",
      "#interestsPref",
      "#mutedWordsPref",
      "#hiddenPostsPref",
      "#bskyAppStatePref",
      "#labelersPref",
      "#postInteractionSettingsPref",
      "#verificationPrefs"
    ],
    "type": "union"
  }
}

profileAssociated object

Properties

activitySubscription ref #profileAssociatedActivitySubscription Optional

No description provided.

chat ref #profileAssociatedChat Optional

No description provided.

feedgens integer Optional

No description provided.

labeler boolean Optional

No description provided.

lists integer Optional

No description provided.

starterPacks integer Optional

No description provided.

View raw schema

{
  "type": "object",
  "properties": {
    "chat": {
      "ref": "#profileAssociatedChat",
      "type": "ref"
    },
    "lists": {
      "type": "integer"
    },
    "labeler": {
      "type": "boolean"
    },
    "feedgens": {
      "type": "integer"
    },
    "starterPacks": {
      "type": "integer"
    },
    "activitySubscription": {
      "ref": "#profileAssociatedActivitySubscription",
      "type": "ref"
    }
  }
}

profileAssociatedActivitySubscription object

Properties

allowSubscriptions string Required

No description provided.

Known values: followers, mutuals, none

View raw schema

{
  "type": "object",
  "required": [
    "allowSubscriptions"
  ],
  "properties": {
    "allowSubscriptions": {
      "type": "string",
      "knownValues": [
        "followers",
        "mutuals",
        "none"
      ]
    }
  }
}

profileAssociatedChat object

Properties

allowIncoming string Required

No description provided.

Known values: all, none, following

View raw schema

{
  "type": "object",
  "required": [
    "allowIncoming"
  ],
  "properties": {
    "allowIncoming": {
      "type": "string",
      "knownValues": [
        "all",
        "none",
        "following"
      ]
    }
  }
}

profileView object

Properties

associated ref #profileAssociated Optional

No description provided.

avatar string uri Optional

A valid URI.

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

debug unknown Optional

Debug information for internal development

description string Optional

No description provided.

maxLength: 2560 bytesmaxGraphemes: 256 graphemes

did string did Required

A decentralized identifier (DID).

displayName string Optional

No description provided.

maxLength: 640 bytesmaxGraphemes: 64 graphemes

handle string handle Required

An AT Protocol handle (e.g., alice.bsky.social).

indexedAt string datetime Optional

An RFC 3339 formatted timestamp.

labels array of refcom.atproto.label.defs#label Optional

No description provided.

pronouns string Optional

No description provided.

status ref #statusView Optional

No description provided.

verification ref #verificationState Optional

No description provided.

viewer ref #viewerState Optional

No description provided.

View raw schema

{
  "type": "object",
  "required": [
    "did",
    "handle"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "debug": {
      "type": "unknown",
      "description": "Debug information for internal development"
    },
    "avatar": {
      "type": "string",
      "format": "uri"
    },
    "handle": {
      "type": "string",
      "format": "handle"
    },
    "labels": {
      "type": "array",
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      }
    },
    "status": {
      "ref": "#statusView",
      "type": "ref"
    },
    "viewer": {
      "ref": "#viewerState",
      "type": "ref"
    },
    "pronouns": {
      "type": "string"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "associated": {
      "ref": "#profileAssociated",
      "type": "ref"
    },
    "description": {
      "type": "string",
      "maxLength": 2560,
      "maxGraphemes": 256
    },
    "displayName": {
      "type": "string",
      "maxLength": 640,
      "maxGraphemes": 64
    },
    "verification": {
      "ref": "#verificationState",
      "type": "ref"
    }
  }
}

profileViewBasic object

Properties

associated ref #profileAssociated Optional

No description provided.

avatar string uri Optional

A valid URI.

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

debug unknown Optional

Debug information for internal development

did string did Required

A decentralized identifier (DID).

displayName string Optional

No description provided.

maxLength: 640 bytesmaxGraphemes: 64 graphemes

handle string handle Required

An AT Protocol handle (e.g., alice.bsky.social).

labels array of refcom.atproto.label.defs#label Optional

No description provided.

pronouns string Optional

No description provided.

status ref #statusView Optional

No description provided.

verification ref #verificationState Optional

No description provided.

viewer ref #viewerState Optional

No description provided.

View raw schema

{
  "type": "object",
  "required": [
    "did",
    "handle"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "debug": {
      "type": "unknown",
      "description": "Debug information for internal development"
    },
    "avatar": {
      "type": "string",
      "format": "uri"
    },
    "handle": {
      "type": "string",
      "format": "handle"
    },
    "labels": {
      "type": "array",
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      }
    },
    "status": {
      "ref": "#statusView",
      "type": "ref"
    },
    "viewer": {
      "ref": "#viewerState",
      "type": "ref"
    },
    "pronouns": {
      "type": "string"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "associated": {
      "ref": "#profileAssociated",
      "type": "ref"
    },
    "displayName": {
      "type": "string",
      "maxLength": 640,
      "maxGraphemes": 64
    },
    "verification": {
      "ref": "#verificationState",
      "type": "ref"
    }
  }
}

profileViewDetailed object

Properties

associated ref #profileAssociated Optional

No description provided.

avatar string uri Optional

A valid URI.

banner string uri Optional

A valid URI.

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

debug unknown Optional

Debug information for internal development

description string Optional

No description provided.

maxLength: 2560 bytesmaxGraphemes: 256 graphemes

did string did Required

A decentralized identifier (DID).

displayName string Optional

No description provided.

maxLength: 640 bytesmaxGraphemes: 64 graphemes

followersCount integer Optional

No description provided.

followsCount integer Optional

No description provided.

handle string handle Required

An AT Protocol handle (e.g., alice.bsky.social).

indexedAt string datetime Optional

An RFC 3339 formatted timestamp.

joinedViaStarterPack ref app.bsky.graph.defs#starterPackViewBasic Optional

No description provided.

labels array of refcom.atproto.label.defs#label Optional

No description provided.

pinnedPost ref com.atproto.repo.strongRef Optional

No description provided.

postsCount integer Optional

No description provided.

pronouns string Optional

No description provided.

status ref #statusView Optional

No description provided.

verification ref #verificationState Optional

No description provided.

viewer ref #viewerState Optional

No description provided.

website string uri Optional

A valid URI.

View raw schema

{
  "type": "object",
  "required": [
    "did",
    "handle"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "debug": {
      "type": "unknown",
      "description": "Debug information for internal development"
    },
    "avatar": {
      "type": "string",
      "format": "uri"
    },
    "banner": {
      "type": "string",
      "format": "uri"
    },
    "handle": {
      "type": "string",
      "format": "handle"
    },
    "labels": {
      "type": "array",
      "items": {
        "ref": "com.atproto.label.defs#label",
        "type": "ref"
      }
    },
    "status": {
      "ref": "#statusView",
      "type": "ref"
    },
    "viewer": {
      "ref": "#viewerState",
      "type": "ref"
    },
    "website": {
      "type": "string",
      "format": "uri"
    },
    "pronouns": {
      "type": "string"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime"
    },
    "associated": {
      "ref": "#profileAssociated",
      "type": "ref"
    },
    "pinnedPost": {
      "ref": "com.atproto.repo.strongRef",
      "type": "ref"
    },
    "postsCount": {
      "type": "integer"
    },
    "description": {
      "type": "string",
      "maxLength": 2560,
      "maxGraphemes": 256
    },
    "displayName": {
      "type": "string",
      "maxLength": 640,
      "maxGraphemes": 64
    },
    "followsCount": {
      "type": "integer"
    },
    "verification": {
      "ref": "#verificationState",
      "type": "ref"
    },
    "followersCount": {
      "type": "integer"
    },
    "joinedViaStarterPack": {
      "ref": "app.bsky.graph.defs#starterPackViewBasic",
      "type": "ref"
    }
  }
}

savedFeed object

Properties

id string Required

No description provided.

pinned boolean Required

No description provided.

type string Required

No description provided.

Known values: feed, list, timeline

value string Required

No description provided.

View raw schema

{
  "type": "object",
  "required": [
    "id",
    "type",
    "value",
    "pinned"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "knownValues": [
        "feed",
        "list",
        "timeline"
      ]
    },
    "value": {
      "type": "string"
    },
    "pinned": {
      "type": "boolean"
    }
  }
}

savedFeedsPref object

Properties

pinned array of stringat-uri Required

No description provided.

saved array of stringat-uri Required

No description provided.

timelineIndex integer Optional

No description provided.

View raw schema

{
  "type": "object",
  "required": [
    "pinned",
    "saved"
  ],
  "properties": {
    "saved": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "at-uri"
      }
    },
    "pinned": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "at-uri"
      }
    },
    "timelineIndex": {
      "type": "integer"
    }
  }
}

savedFeedsPrefV2 object

Properties

items array of refapp.bsky.actor.defs#savedFeed Required

No description provided.

View raw schema

{
  "type": "object",
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "ref": "app.bsky.actor.defs#savedFeed",
        "type": "ref"
      }
    }
  }
}

statusView object

Properties

embed union Optional

An optional embed associated with the status.

Known types:

app.bsky.embed.external#view

expiresAt string datetime Optional

The date when this status will expire. The application might choose to no longer return the status after expiration.

isActive boolean Optional

True if the status is not expired, false if it is expired. Only present if expiration was set.

record unknown Required

No description provided.

status string Required

The status for the account.

Known values: app.bsky.actor.status#live

View raw schema

{
  "type": "object",
  "required": [
    "status",
    "record"
  ],
  "properties": {
    "embed": {
      "refs": [
        "app.bsky.embed.external#view"
      ],
      "type": "union",
      "description": "An optional embed associated with the status."
    },
    "record": {
      "type": "unknown"
    },
    "status": {
      "type": "string",
      "description": "The status for the account.",
      "knownValues": [
        "app.bsky.actor.status#live"
      ]
    },
    "isActive": {
      "type": "boolean",
      "description": "True if the status is not expired, false if it is expired. Only present if expiration was set."
    },
    "expiresAt": {
      "type": "string",
      "format": "datetime",
      "description": "The date when this status will expire. The application might choose to no longer return the status after expiration."
    }
  }
}

threadViewPref object

Properties

sort string Optional

Sorting mode for threads.

Known values: oldest, newest, most-likes, random, hotness

View raw schema

{
  "type": "object",
  "properties": {
    "sort": {
      "type": "string",
      "description": "Sorting mode for threads.",
      "knownValues": [
        "oldest",
        "newest",
        "most-likes",
        "random",
        "hotness"
      ]
    }
  }
}

verificationPrefs object

Preferences for how verified accounts appear in the app.

Properties

hideBadges boolean Optional

Hide the blue check badges for verified accounts and trusted verifiers.

View raw schema

{
  "type": "object",
  "required": [],
  "properties": {
    "hideBadges": {
      "type": "boolean",
      "default": false,
      "description": "Hide the blue check badges for verified accounts and trusted verifiers."
    }
  },
  "description": "Preferences for how verified accounts appear in the app."
}

verificationState object

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

Properties

trustedVerifierStatus string Required

The user's status as a trusted verifier.

Known values: valid, invalid, none

verifications array of ref#verificationView Required

All verifications issued by trusted verifiers on behalf of this user. Verifications by untrusted verifiers are not included.

verifiedStatus string Required

The user's status as a verified account.

Known values: valid, invalid, none

View raw schema

{
  "type": "object",
  "required": [
    "verifications",
    "verifiedStatus",
    "trustedVerifierStatus"
  ],
  "properties": {
    "verifications": {
      "type": "array",
      "items": {
        "ref": "#verificationView",
        "type": "ref"
      },
      "description": "All verifications issued by trusted verifiers on behalf of this user. Verifications by untrusted verifiers are not included."
    },
    "verifiedStatus": {
      "type": "string",
      "description": "The user's status as a verified account.",
      "knownValues": [
        "valid",
        "invalid",
        "none"
      ]
    },
    "trustedVerifierStatus": {
      "type": "string",
      "description": "The user's status as a trusted verifier.",
      "knownValues": [
        "valid",
        "invalid",
        "none"
      ]
    }
  },
  "description": "Represents the verification information about the user this object is attached to."
}

verificationView object

An individual verification for an associated subject.

Properties

createdAt string datetime Required

Timestamp when the verification was created.

isValid boolean Required

True if the verification passes validation, otherwise false.

issuer string did Required

The user who issued this verification.

uri string at-uri Required

The AT-URI of the verification record.

View raw schema

{
  "type": "object",
  "required": [
    "issuer",
    "uri",
    "isValid",
    "createdAt"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT-URI of the verification record."
    },
    "issuer": {
      "type": "string",
      "format": "did",
      "description": "The user who issued this verification."
    },
    "isValid": {
      "type": "boolean",
      "description": "True if the verification passes validation, otherwise false."
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "description": "Timestamp when the verification was created."
    }
  },
  "description": "An individual verification for an associated subject."
}

viewerState object

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

Properties

activitySubscription ref app.bsky.notification.defs#activitySubscription Optional

This property is present only in selected cases, as an optimization.

blockedBy boolean Optional

No description provided.

blocking string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

blockingByList ref app.bsky.graph.defs#listViewBasic Optional

No description provided.

followedBy string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

following string at-uri Optional

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

knownFollowers ref #knownFollowers Optional

This property is present only in selected cases, as an optimization.

muted boolean Optional

No description provided.

mutedByList ref app.bsky.graph.defs#listViewBasic Optional

No description provided.

View raw schema

{
  "type": "object",
  "properties": {
    "muted": {
      "type": "boolean"
    },
    "blocking": {
      "type": "string",
      "format": "at-uri"
    },
    "blockedBy": {
      "type": "boolean"
    },
    "following": {
      "type": "string",
      "format": "at-uri"
    },
    "followedBy": {
      "type": "string",
      "format": "at-uri"
    },
    "mutedByList": {
      "ref": "app.bsky.graph.defs#listViewBasic",
      "type": "ref"
    },
    "blockingByList": {
      "ref": "app.bsky.graph.defs#listViewBasic",
      "type": "ref"
    },
    "knownFollowers": {
      "ref": "#knownFollowers",
      "type": "ref",
      "description": "This property is present only in selected cases, as an optimization."
    },
    "activitySubscription": {
      "ref": "app.bsky.notification.defs#activitySubscription",
      "type": "ref",
      "description": "This property is present only in selected cases, as an optimization."
    }
  },
  "description": "Metadata about the requesting account's relationship with the subject account. Only has meaningful content for authed requests."
}

app.bsky.actor.defs

Documentation

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties

Properties