Skip to main content

app.bsky.graph.defs

#listViewBasic​

PropertyTypeKnown ValuesRequiredDescription
uristring (at-uri)-✅-
cidstring (cid)-✅-
namestring-✅-
purpose#listPurpose-✅-
avatarstring (uri)-❌-
listItemCountinteger-❌-
labelsarray of com.atproto.label.defs#label-❌-
viewer#listViewerState-❌-
indexedAtstring (datetime)-❌-

#listView​

PropertyTypeKnown ValuesRequiredDescription
uristring (at-uri)-✅-
cidstring (cid)-✅-
creatorapp.bsky.actor.defs#profileView-✅-
namestring-✅-
purpose#listPurpose-✅-
descriptionstring-❌-
descriptionFacetsarray of app.bsky.richtext.facet-❌-
avatarstring (uri)-❌-
listItemCountinteger-❌-
labelsarray of com.atproto.label.defs#label-❌-
viewer#listViewerState-❌-
indexedAtstring (datetime)-✅-

#listItemView​

PropertyTypeKnown ValuesRequiredDescription
uristring (at-uri)-✅-
subjectapp.bsky.actor.defs#profileView-✅-
subjectOptedOutboolean-❌Set to true when the subject has opted out of appearing in the reference list. Only set when the viewer owns the list.

#starterPackView​

PropertyTypeKnown ValuesRequiredDescription
uristring (at-uri)-✅-
cidstring (cid)-✅-
recordunknown-✅-
creatorapp.bsky.actor.defs#profileViewBasic-✅-
list#listViewBasic-❌-
listItemsSamplearray of #listItemView-❌-
feedsarray of app.bsky.feed.defs#generatorView-❌-
joinedWeekCountinteger-❌-
joinedAllTimeCountinteger-❌-
labelsarray of com.atproto.label.defs#label-❌-
indexedAtstring (datetime)-✅-

#starterPackViewBasic​

PropertyTypeKnown ValuesRequiredDescription
uristring (at-uri)-✅-
cidstring (cid)-✅-
recordunknown-✅-
creatorapp.bsky.actor.defs#profileViewBasic-✅-
listItemCountinteger-❌-
joinedWeekCountinteger-❌-
joinedAllTimeCountinteger-❌-
labelsarray of com.atproto.label.defs#label-❌-
indexedAtstring (datetime)-✅-

#listPurpose​

PropertyTypeKnown ValuesRequiredDescription
listPurposestringapp.bsky.graph.defs#modlist
app.bsky.graph.defs#curatelist
app.bsky.graph.defs#referencelist
❌-

#modlist​

TOKEN: A list of actors to apply an aggregate moderation action (mute/block) on.

#curatelist​

TOKEN: A list of actors used for curation purposes such as list feeds or interaction gating.

#referencelist​

TOKEN: A list of actors used for only for reference purposes such as within a starter pack.

#listViewerState​

PropertyTypeKnown ValuesRequiredDescription
mutedboolean-❌-
blockedstring (at-uri)-❌-
referenceListOptOutstring (at-uri)-❌The authenticated viewer's app.bsky.graph.referencelistoptout record URI for this reference list. Only set for reference lists. A client can delete this record to undo the opt-out.

#notFoundActor​

indicates that a handle or DID could not be resolved

PropertyTypeKnown ValuesRequiredDescription
actorstring (at-identifier)-✅-
notFoundboolean-✅-

#relationship​

lists the bi-directional graph relationships between one actor (not indicated in the object), and the target actors (the DID included in the object)

PropertyTypeKnown ValuesRequiredDescription
didstring (did)-✅-
followingstring (at-uri)-❌if the actor follows this DID, this is the AT-URI of the follow record
followedBystring (at-uri)-❌if the actor is followed by this DID, contains the AT-URI of the follow record
blockingstring (at-uri)-❌if the actor blocks this DID, this is the AT-URI of the block record
blockedBystring (at-uri)-❌if the actor is blocked by this DID, contains the AT-URI of the block record
blockingByListstring (at-uri)-❌if the actor blocks this DID via a block list, this is the AT-URI of the listblock record
blockedByListstring (at-uri)-❌if the actor is blocked by this DID via a block list, contains the AT-URI of the listblock record