Readwise
App · 13 actions
Save links to Readwise Reader to read later, organise them, and work with your Readwise highlights: add, tag and find them, and get your daily review. Start a workflow when you highlight something or save a document.
Actions
| Action | What it does |
|---|---|
| Add highlight | Add a highlight to Readwise, filed under the book or article it's from. |
| Change highlight | Change a highlight's words, note or colour. |
| Change Reader document | Move a Reader document to the Inbox, Later or Archive, or change its details, tags or note. |
| Delete highlight | Delete a highlight. |
| Delete Reader document | Delete a Reader document, with its highlights and notes. |
| Get daily review | Get today's daily review: the highlights Readwise picked for you to look at again. |
| Get highlight | Get one highlight, with its note, colour and tags. |
| Get Reader document | Get one Reader document: its title, location, tags, notes and how far you've read. |
| List books | List the books, articles, tweets and podcasts your highlights come from. |
| List highlights | List highlights, in every book or one, or only those added or changed after a time. |
| List Reader documents | List Reader documents by location, kind or tag, or those changed after a time. |
| Save to Reader | Save a link to Reader to read later. |
| Tag highlight | Add a tag to a highlight. |
Add highlight
Add a highlight to Readwise, filed under the book or article it's from.
Inputs
- Highlight
texttextRequired - The highlighted words.
- From
titletext - The book or article's title. Leave empty to file it under Quotes.
- Author
authortext - Its author.
- Link
source_urltext - The page it's from, starting with https://.
- Kind
categorytext - What it's from. Defaults to an article with a link, otherwise a book.One of:
books(Book),articles(Article),tweets(Tweet),podcasts(Podcast). - Note
notetext - Your note on it.
- Highlighted
highlighted_atdate and time - When it was highlighted. Leave empty for now.
Outputs
book_idnumber- The book or article it's from
book_titletext- The book or article it was filed under
colortext- yellow, blue, pink, orange, green or purple
created_attext- When it was added to Readwise (ISO 8601)
highlighted_attext- When it was highlighted (ISO 8601)
idnumber- The highlight's number
notetext- Your note on it
readwise_urltext- Its link in Readwise
tagslist- Its tags
texttext- The highlighted words
updatedtext- When it last changed (ISO 8601)
urltext- A link to where it is in the source, if any
Example output
{
"book_id": 2608,
"book_title": "How to Take Smart Notes",
"color": "yellow",
"created_at": "2026-10-28T09:00:05Z",
"highlighted_at": "2026-10-28T09:00:00Z",
"id": 503017,
"note": "Use in Friday's talk",
"readwise_url": "https://readwise.io/open/503017",
"tags": [
"favorite"
],
"text": "Writing is not the outcome of thinking; it is the medium in which thinking takes place.",
"updated": "2026-10-28T09:00:05Z",
"url": ""
}Change highlight
Change a highlight's words, note or colour.
Inputs
- Highlight
highlighttextRequired - The highlight's number, from 'Add highlight' or 'List highlights', or its readwise.io link.
- Highlight
texttext - New words. Leave empty to keep them.
- Note
notetext - A new note, replacing the one there. Leave empty to keep it.
- Colour
colortext - A new colour. Leave empty to keep it.One of:
yellow,blue,pink,orange,green,purple.
Outputs
book_idnumber- The book or article it's from
colortext- yellow, blue, pink, orange, green or purple
created_attext- When it was added to Readwise (ISO 8601)
highlighted_attext- When it was highlighted (ISO 8601)
idnumber- The highlight's number
notetext- Your note on it
readwise_urltext- Its link in Readwise
tagslist- Its tags
texttext- The highlighted words
updatedtext- When it last changed (ISO 8601)
urltext- A link to where it is in the source, if any
Example output
{
"book_id": 2608,
"color": "yellow",
"created_at": "2026-10-28T09:00:05Z",
"highlighted_at": "2026-10-28T09:00:00Z",
"id": 503017,
"note": "Use in Friday's talk",
"readwise_url": "https://readwise.io/open/503017",
"tags": [
"favorite"
],
"text": "Writing is not the outcome of thinking; it is the medium in which thinking takes place.",
"updated": "2026-10-28T09:00:05Z",
"url": ""
}Change Reader document
Move a Reader document to the Inbox, Later or Archive, or change its details, tags or note.
Inputs
- Document
documenttextRequired - The document's ID, from 'Save to Reader' or 'List Reader documents', or its Reader link.
- Move to
locationtext - Where to move it. Leave empty to keep it where it is.One of:
new(Inbox),later,archive,feed. - Title
titletext - A new title. Leave empty to keep it.
- Author
authortext - A new author. Leave empty to keep it.
- Summary
summarytext - A new summary. Leave empty to keep it.
- Note
notestext - A new note, replacing the one there. Leave empty to keep it.
- Tags
tagslist - Its tags, replacing the ones there. Leave empty to keep them.
- Kind
categorytext - What it is. Leave empty to keep it.One of:
article,email,rss(RSS item),pdf,epub(EPUB book),tweet,video.
Outputs
authortext- Its author
categorytext- article, email, rss, pdf, epub, tweet, video, highlight or note
created_attext- When it was saved (ISO 8601)
idtext- The document's ID
locationtext- new (Inbox), later, shortlist, archive or feed
notestext- Your note on it
parent_idtext- For a highlight or note, the document it's in
reader_urltext- Its link in Reader
reading_progressnumber- How far through it you are, from 0 to 1
site_nametext- The website's name
summarytext- Its summary
tagslist- Its tags
titletext- Its title
updated_attext- When it last changed (ISO 8601)
urltext- The page it was saved from
word_countnumber- How many words it has
Example output
{
"author": "S\u00f6nke Ahrens",
"category": "article",
"created_at": "2026-10-28T09:00:00Z",
"id": "01gwfvp9pyaabcdgmx14f6ha0",
"location": "later",
"notes": "Read before Friday",
"parent_id": "",
"reader_url": "https://read.readwise.io/read/01gwfvp9pyaabcdgmx14f6ha0",
"reading_progress": 0.25,
"site_name": "Example",
"summary": "Why writing notes as you read pays off.",
"tags": [
"notes"
],
"title": "How to take smart notes",
"updated_at": "2026-10-28T09:05:00Z",
"url": "https://example.com/smart-notes",
"word_count": 2400
}Delete highlight
Delete a highlight. It cannot be undone.
Inputs
- Highlight
highlighttextRequired - The highlight's number, from 'Add highlight' or 'List highlights', or its readwise.io link.
Outputs
deletedtrue/false- True once deleted
idnumber- The highlight's number
Example output
{
"deleted": true,
"id": 503017
}Delete Reader document
Delete a Reader document, with its highlights and notes. It cannot be undone.
Inputs
- Document
documenttextRequired - The document's ID, from 'Save to Reader' or 'List Reader documents', or its Reader link.
Outputs
deletedtrue/false- True once deleted
idtext- The document's ID
Example output
{
"deleted": true,
"id": "01gwfvp9pyaabcdgmx14f6ha0"
}Get daily review
Get today's daily review: the highlights Readwise picked for you to look at again.
Inputs
None.
Outputs
completedtrue/false- True once you've done today's review
countnumber- How many highlights
highlightslist- The highlights to review
review_urltext- The review's link in Readwise
Example output
{
"completed": false,
"count": 1,
"highlights": [
{
"author": "S\u00f6nke Ahrens",
"id": 503017,
"note": "",
"source_url": "",
"text": "Writing is not the outcome of thinking; it is the medium in which thinking takes place.",
"title": "How to Take Smart Notes"
}
],
"review_url": "https://readwise.io/reviews/1234"
}Get highlight
Get one highlight, with its note, colour and tags.
Inputs
- Highlight
highlighttextRequired - The highlight's number, from 'Add highlight' or 'List highlights', or its readwise.io link.
Outputs
book_idnumber- The book or article it's from
colortext- yellow, blue, pink, orange, green or purple
created_attext- When it was added to Readwise (ISO 8601)
highlighted_attext- When it was highlighted (ISO 8601)
idnumber- The highlight's number
notetext- Your note on it
readwise_urltext- Its link in Readwise
tagslist- Its tags
texttext- The highlighted words
updatedtext- When it last changed (ISO 8601)
urltext- A link to where it is in the source, if any
Example output
{
"book_id": 2608,
"color": "yellow",
"created_at": "2026-10-28T09:00:05Z",
"highlighted_at": "2026-10-28T09:00:00Z",
"id": 503017,
"note": "Use in Friday's talk",
"readwise_url": "https://readwise.io/open/503017",
"tags": [
"favorite"
],
"text": "Writing is not the outcome of thinking; it is the medium in which thinking takes place.",
"updated": "2026-10-28T09:00:05Z",
"url": ""
}Get Reader document
Get one Reader document: its title, location, tags, notes and how far you've read.
Inputs
- Document
documenttextRequired - The document's ID, from 'Save to Reader' or 'List Reader documents', or its Reader link.
Outputs
authortext- Its author
categorytext- article, email, rss, pdf, epub, tweet, video, highlight or note
created_attext- When it was saved (ISO 8601)
idtext- The document's ID
locationtext- new (Inbox), later, shortlist, archive or feed
notestext- Your note on it
parent_idtext- For a highlight or note, the document it's in
reader_urltext- Its link in Reader
reading_progressnumber- How far through it you are, from 0 to 1
site_nametext- The website's name
summarytext- Its summary
tagslist- Its tags
titletext- Its title
updated_attext- When it last changed (ISO 8601)
urltext- The page it was saved from
word_countnumber- How many words it has
Example output
{
"author": "S\u00f6nke Ahrens",
"category": "article",
"created_at": "2026-10-28T09:00:00Z",
"id": "01gwfvp9pyaabcdgmx14f6ha0",
"location": "later",
"notes": "Read before Friday",
"parent_id": "",
"reader_url": "https://read.readwise.io/read/01gwfvp9pyaabcdgmx14f6ha0",
"reading_progress": 0.25,
"site_name": "Example",
"summary": "Why writing notes as you read pays off.",
"tags": [
"notes"
],
"title": "How to take smart notes",
"updated_at": "2026-10-28T09:05:00Z",
"url": "https://example.com/smart-notes",
"word_count": 2400
}List books
List the books, articles, tweets and podcasts your highlights come from.
Inputs
- Kind
categorytext - Only this kind. Leave empty for all.One of:
books,articles,tweets,podcasts,supplementals. - Changed after
updated_afterdate and time - Only books added or changed after this time.
- How many
limitnumber - How many books. Defaults to 25.From 1 to 1000.
Outputs
bookslist- The books and articles
countnumber- How many books
Example output
{
"books": [
{
"author": "S\u00f6nke Ahrens",
"category": "books",
"id": 2608,
"last_highlight_at": "2026-10-28T09:00:00Z",
"num_highlights": 42,
"source": "kindle",
"source_url": "",
"tags": [],
"title": "How to Take Smart Notes",
"updated": "2026-10-28T09:00:05Z"
}
],
"count": 1
}List highlights
List highlights, in every book or one, or only those added or changed after a time.
Inputs
- Book
booktext - Only this book or article's highlights.
- Changed after
updated_afterdate and time - Only highlights added or changed after this time.
- How many
limitnumber - How many highlights. Defaults to 25.From 1 to 1000.
Outputs
countnumber- How many highlights
highlightslist- The highlights
Example output
{
"count": 1,
"highlights": [
{
"book_id": 2608,
"color": "yellow",
"created_at": "2026-10-28T09:00:05Z",
"highlighted_at": "2026-10-28T09:00:00Z",
"id": 503017,
"note": "Use in Friday's talk",
"readwise_url": "https://readwise.io/open/503017",
"tags": [
"favorite"
],
"text": "Writing is not the outcome of thinking; it is the medium in which thinking takes place.",
"updated": "2026-10-28T09:00:05Z",
"url": ""
}
]
}List Reader documents
List Reader documents by location, kind or tag, or those changed after a time.
Inputs
- Location
locationtext - Only documents here. Leave empty for everywhere.One of:
new(Inbox),later,shortlist,archive,feed. - Kind
categorytext - Only this kind. Leave empty for every kind but highlights and notes.One of:
article,email,rss(RSS item),pdf,epub(EPUB book),tweet,video,highlight,note. - Tag
tagtext - Only documents with this tag.
- Changed after
updated_afterdate and time - Only documents added or changed after this time.
- How many
limitnumber - How many documents. Defaults to 25.From 1 to 1000.
Outputs
countnumber- How many documents
documentslist- The documents
Example output
{
"count": 1,
"documents": [
{
"author": "S\u00f6nke Ahrens",
"category": "article",
"created_at": "2026-10-28T09:00:00Z",
"id": "01gwfvp9pyaabcdgmx14f6ha0",
"location": "later",
"notes": "Read before Friday",
"parent_id": "",
"reader_url": "https://read.readwise.io/read/01gwfvp9pyaabcdgmx14f6ha0",
"reading_progress": 0.25,
"site_name": "Example",
"summary": "Why writing notes as you read pays off.",
"tags": [
"notes"
],
"title": "How to take smart notes",
"updated_at": "2026-10-28T09:05:00Z",
"url": "https://example.com/smart-notes",
"word_count": 2400
}
]
}Save to Reader
Save a link to Reader to read later. Reader fetches the page itself.
Inputs
- Link
urltextRequired - The page's address, starting with https://.
- Title
titletext - Its title. Leave empty to use the page's own.
- Author
authortext - Its author. Leave empty to use the page's own.
- Summary
summarytext - A short summary.
- Note
notestext - Your note on it.
- Tags
tagslist - Tags to add.
- Save to
locationtext - Where in Reader to put it. Defaults to the Inbox.One of:
new(Inbox),later,archive,feed. - Kind
categorytext - What it is. Leave empty for Reader to tell from the page.One of:
article,email,rss(RSS item),pdf,epub(EPUB book),tweet,video. - Published
published_datedate - When it was published. Leave empty to use the page's own date.
Outputs
already_savedtrue/false- True if the link was already in Reader
idtext- The document's ID
reader_urltext- Its link in Reader
Example output
{
"already_saved": false,
"id": "01gwfvp9pyaabcdgmx14f6ha0",
"reader_url": "https://read.readwise.io/read/01gwfvp9pyaabcdgmx14f6ha0"
}Tag highlight
Add a tag to a highlight.
Inputs
- Highlight
highlighttextRequired - The highlight's number, from 'Add highlight' or 'List highlights', or its readwise.io link.
- Tag
tagtextRequired - The tag to add, such as favorite.
Outputs
highlight_idnumber- The highlight
tagtext- The tag
tag_idnumber- The tag's number on it
Example output
{
"highlight_id": 503017,
"tag": "favorite",
"tag_id": 77
}