View as Markdown
Readwise icon

Readwise ACTION

List Highlights

A list of highlights with a pagination metadata. The rate limit of this endpoint is restricted to 20 requests per minute. Each request returns 1000 items. See the docs here
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Readwise account once, then configure and run List Highlights from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "readwise-list-highlights",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    readwise: { authProvisionId: "apn_xxxxxxx" },
    bookId: 10,
    limit: 10,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Highlights inputs
Property Type Description
bookId Book Id integer
Id of the book to list highlights
Optional Dynamic
limit Limit integer
Specify number of results per page (default is 100, max is 1000)
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
readwise-list-highlights
Version
0.0.5
App
Readwise
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes