Schema reference

com.para.highlight.listHighlights

experimental

List query for indexed highlight annotations with subject, creator, community, state, and pagination filters.

Fields

highlights

com.para.highlight.defs#highlightView[]

Required

Highlight views returned for the browse surface.

cursor

string

Optional

Pagination cursor for continuing highlight browsing.

Metadata

Schema ID
com.para.highlight.listHighlights
Lexicon source
lexicons/com/para/highlight/listHighlights.json
Website source path
watx/lexicons/com/para/highlight/listHighlights.json
Product surfaces
Highlights list

Constraints

  • `limit` defaults to 30 and maxes at 100.
  • Filters support community, state, subject, and creator.

Relationships

  • Returns arrays of com.para.highlight.defs#highlightView.

Lifecycle

  • Powers browse, filter, and discovery views for public highlight annotations.

Writers

  • Read-only query over indexed highlight state.

Readers

  • Highlights route
  • Post highlight browsing

Routes

  • /highlights
  • /profile/:name/post/:rkey/highlights

XRPC methods

  • com.para.highlight.listHighlights

Indexing and moderation

Indexing

  • Serves from indexed highlight views rather than raw annotation records.

Moderation

  • Visibility and subject filtering constrain what can be listed publicly.

Examples

{"highlights":[{"subjectUri":"at://did:plc:example/app.bsky.feed.post/3x","tag":"water"}],"cursor":"next-token"}