Back

Get highlights

This query returns highlights from your Readwise account that match optional filters for source, tag, date range, or keyword.

Developer info

API endpoint slug: readwise.get_highlights
Runtime method: performQuery("readwise.get_highlights"}

Query fields

Book Dropdown list

Label: Source
Helper text: Pick a book or article to filter by, or choose "Any source" to search across all sources.
Slug: book_id
Required: false
Can have default value: false

Tag Text input > Other

Label: Tag
Helper text: Filter highlights by tag name. Leave blank to ignore tags.
Slug: tag
Required: false
Can have default value: true

Date from Text input > Other

Label: From date
Helper text: Only return highlights updated on or after this date (YYYY-MM-DD). Leave blank for no lower bound.
Slug: date_from
Required: false
Can have default value: true

Date to Text input > Other

Label: To date
Helper text: Only return highlights updated on or before this date (YYYY-MM-DD). Leave blank for no upper bound.
Slug: date_to
Required: false
Can have default value: true

Keyword Text input > Other

Label: Keyword
Helper text: Search highlight text and notes for this word or phrase. Leave blank to skip keyword search.
Slug: keyword
Required: false
Can have default value: true

Ingredients

Highlight The unique ID of the highlight.

Slug: highlight_id
Filter code: Readwise.getHighlights.HighlightId
Type: String
Example: 987654321

Highlight text The text of the highlight.

Slug: highlight_text
Filter code: Readwise.getHighlights.HighlightText
Type: String
Example: The best way to predict the future is to invent it.

Source title The title of the book, article, or other source.

Slug: source_title
Filter code: Readwise.getHighlights.SourceTitle
Type: String
Example: The Mythical Man-Month

Source author The author of the source.

Slug: source_author
Filter code: Readwise.getHighlights.SourceAuthor
Type: String
Example: Frederick P. Brooks Jr.

Highlighted at The date and time the highlight was made.

Slug: highlighted_at
Filter code: Readwise.getHighlights.HighlightedAt
Type: Date with time (ISO8601)
Example: 2020-07-08T04:17:06+05:00

Tag list Comma-separated list of tags applied to the highlight.

Slug: tag_list
Filter code: Readwise.getHighlights.TagList
Type: String
Example: engineering, planning

Highlight url Deep link to view this highlight in Readwise.

Slug: highlight_url
Filter code: Readwise.getHighlights.HighlightUrl
Type: Web URL
Example: https://readwise.io/open/987654321

Location in source Where in the source the highlight is located.

Slug: location_in_source
Filter code: Readwise.getHighlights.LocationInSource
Type: String
Example: page 45