app.bsky.actor.getPreferences

GET 
/xrpc/app.bsky.actor.getPreferences

This endpoint is part of the Bluesky application Lexicon APIs (app.bsky.*). Public endpoints which don't require authentication can be made directly against the public Bluesky AppView API: https://public.api.bsky.app. Authenticated requests are usually made to the user's PDS, with automatic service proxying. Authenticated requests can be used for both public and non-public endpoints.

To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.

Get private preferences attached to the current account. Expected use is synchronization between multiple devices, and import/export during account migration. Requires auth.

Request

Responses

200

OK

application/json

Schema

Schema

preferences

object[]

required

Array [

oneOf

app.bsky.actor.defs.adultContentPref

enabled booleanrequired

app.bsky.actor.defs.contentLabelPref

labelerDid did

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

label stringrequired

visibility stringrequired

Possible values: [ignore, show, warn, hide]

app.bsky.actor.defs.savedFeedsPref

pinned at-uri[]required

saved at-uri[]required

timelineIndex integer

app.bsky.actor.defs.savedFeedsPrefV2

items

object[]

required

Array [

id stringrequired

type stringrequired

Possible values: [feed, list, timeline]

value stringrequired

pinned booleanrequired

]

app.bsky.actor.defs.personalDetailsPref

birthDate date-time

The birth date of account owner.

app.bsky.actor.defs.feedViewPref

feed stringrequired

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

hideReplies boolean

Hide replies in the feed.

hideRepliesByUnfollowed boolean

Default value: true

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

hideRepliesByLikeCount integer

hideReposts boolean

Hide reposts in the feed.

hideQuotePosts boolean

Hide quote posts in the feed.

app.bsky.actor.defs.threadViewPref

sort string

Possible values: [oldest, newest, most-likes, random]

Sorting mode for threads.

prioritizeFollowedUsers boolean

Show followed users at the top of all replies.

app.bsky.actor.defs.interestsPref

tags string[]required

Possible values: <= 100

app.bsky.actor.defs.mutedWordsPref

items

object[]

required

Array [

id string

value stringrequired

Possible values: <= 10000 characters

The muted word itself.

targets app.bsky.actor.defs.mutedWordTarget[]required

Possible values: <= 640 characters, [content, tag]

actorTarget string

Possible values: [all, exclude-following]

Default value: all

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

expiresAt date-time

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

]

app.bsky.actor.defs.hiddenPostsPref

items at-uri[]required

app.bsky.actor.defs.bskyAppStatePref

activeProgressGuide

object

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

guide stringrequired

Possible values: <= 100 characters

queuedNudges string[]

Possible values: <= 1000

nuxs

object[]

Possible values: < 100

Array [

id stringrequired

Possible values: <= 100 characters

completed booleanrequired

data string

Possible values: <= 3000 characters

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

expiresAt date-time

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

]

app.bsky.actor.defs.labelersPref

labelers

object[]

required

Array [

did didrequired

]

]

Example (from schema)

{
  "preferences": [
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {},
    {}
  ]
}

400

Bad Request

application/json

Schema

Schema

error stringrequired

Possible values: [InvalidRequest, ExpiredToken, InvalidToken]

message stringrequired

Example (from schema)

{
  "error": "InvalidRequest",
  "message": "string"
}

401

Unauthorized

application/json

Schema

Schema

error required
message stringrequired

Example (from schema)

{
  "message": "string"
}

Loading...