Get my preferences
GET /account/preferences
Returns your saved preferences, along with the notification events and channels this build knows about and each event’s default channels.
The preferences are notification channels and email cadence per
event, default views, feed filters, browse-rail changes and the
mature-content opt-in. Until you save something, you get empty
notification_channels and email_cadence, an empty
default_views, every filter and the mature-content opt-in off, and
an empty rail. Reading doesn’t save anything.
notification_channels holds only the events you’ve set. An event
you haven’t set uses its entry in default_channels_by_event; an
event you’ve muted comes back as null.
This is your own account’s data, read with your session or API token.
Authorizations
Section titled “Authorizations ”Responses
Section titled “ Responses ”User preferences.
Your preferences, plus what a client needs to show them: the known events and channels and the default channels for each event.
object
Channels for each event you’ve set. An event that isn’t here uses its default; an event you’ve muted comes back as null.
object
Email cadence for each event you’ve set. An event that isn’t here
gets immediate.
object
Your default views: the tab the browse page opens on, its layout and its sort. In the web app they’re starting points: a choice this device has already stored wins over the account default.
object
The feed tab the browse page opens on. Empty or unset means
latest.
The default browse layout, used when the operator has that layout turned on. Otherwise the app picks a default for the device from the layouts that are turned on.
The default sort order: newest posts first or oldest first.
Empty or unset means newest.
Feed filters. Always present, with every filter set to true or
false.
object
Whether GET /posts keeps placeholders for assets you can’t see.
It’s off by default: the feed drops those assets, and drops a post
altogether when it had assets and none are left, unless you wrote
it. Turn it on to keep every placeholder. Other endpoints, such as
GET /posts/{id}, don’t use this setting.
Your browse-rail changes. Always present, with every list included even when it’s empty.
object
Teams the person has hidden from the rail. Empty means none.
Followed teams the person has moved to the front, in that order. Other teams keep their usual order behind them. Empty means the server’s order.
Followed tags the person has hidden from the rail. Hiding a tag isn’t unfollowing it: its posts still reach the following feed.
Followed tags the person has moved to the front, in that order, with the rest behind them. Empty means the server’s order, most recently followed first.
Your mature-content opt-in. Always present, with show set.
object
Whether the account has opted in to mature content. Absent or
false means it hasn’t, which is the default.
The notification events this build knows about, in the order to show them.
The channels this build supports: in_app and email.
The channels each event uses when you haven’t set it. Every event
defaults to in_app; direct messages and an expired license also
default to email.
object
Authentication required, missing, or invalid
object
Human-readable error summary
Example
the request could not be completedExample
{ "error": "authentication required: sign in and retry with a valid session or API token"}Unexpected server error
object
Human-readable error summary
Example
the request could not be completed