Share via


Readwise (Independent Publisher) (Preview)

Readwise helps thousands of readers get the most out of their digital highlights. Sync your highlights from Kindle, Instapaper, Pocket, iBooks, and more. Review the best parts easily through a daily email & app.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Connector Metadata
Publisher Troy Taylor
Website https://readwise.io/
Privacy policy https://readwise.io/privacy
Categories Lifestyle and Entertainment;Productivity

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Access Token (in the format 'Token YourAccessToken') securestring The Access Token (in the format 'Token YourAccessToken') for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Create a book's tag

Creates a new tag for a book.

Create a highlight

Saves a highlight to your Readwise account.

Create a highlight's tag

Create a new tag on a hightlight.

Delete a book's tag

Deletes a tag for a book.

Delete a highlight

Deletes a specific hightlight.

Delete a highlight's tag

Deletes a tag on a highlight.

Get a book

Retrieve the details for a specific book.

Get a book's tags

Retrieve a list of tags for a book.

Get books

Retrieve a list of saved books.

Get highlight's tags

Retrieve a list of a highlight's tags.

Get highlight details

Retrieves the details of a specific highlight

Get highlights

Export a list of highlights save to your Readwise account.

Get specific highlights

Export a specific list of highlights save to your Readwise account.

Update a book's tag

Updates a tag for a book.

Update a highlight

Update an existing highlight.

Update a highlight's tag

Updates a tag's name for a hightlight.

Create a book's tag

Creates a new tag for a book.

Parameters

Name Key Required Type Description
Book ID
book id True string

The book identifier.

Name
name True string

The name.

Returns

Name Path Type Description
ID
id integer

The identifier.

Name
name string

The name.

Create a highlight

Saves a highlight to your Readwise account.

Parameters

Name Key Required Type Description
Text
text True string

The text.

Title
title string

The title.

Author
author string

The author.

Source URL
source_url string

The source URL address.

Source Type
source_type string

The source type.

Category
category string

The category.

Note
note string

The note.

Location
location integer

The location.

Location Type
location_type string

The location type.

Highlighted At
highlighted_at string

The highlighted at time.

Highlight URL
highlight_url string

The highlight URL address.

Returns

Name Path Type Description
array of object
ID
id integer

The identifier.

Title
title string

The title.

Author
author string

The author.

Category
category string

The category.

Source
source string

The source.

Num Highlights
num_highlights integer

The number of highlights.

Last Highlight At
last_highlight_at string

When last highlighted at.

Updated
updated string

When updated.

Cover Image URL
cover_image_url string

The cover image URL address.

Highlights URL
highlights_url string

The highlights URL address.

Source URL
source_url string

The source URL address.

ASIN
asin string

The ASIN.

Tags
tags array of object
ID
tags.id integer

The identifier.

Name
tags.name string

The name.

Modified Highlights
modified_highlights array of integer

The modified highlights.

Create a highlight's tag

Create a new tag on a hightlight.

Parameters

Name Key Required Type Description
Highlight ID
highlight id True string

The highlight identifier.

Name
name True string

The name.

Returns

Name Path Type Description
ID
id integer

The identifier.

Name
name string

The name.

Delete a book's tag

Deletes a tag for a book.

Parameters

Name Key Required Type Description
Book ID
book id True string

The book identifier.

Tag ID
tag id True string

The tag identifier.

Returns

response
string

Delete a highlight

Deletes a specific hightlight.

Parameters

Name Key Required Type Description
Highlight ID
highlight id True string

The highlight identifier.

Returns

response
string

Delete a highlight's tag

Deletes a tag on a highlight.

Parameters

Name Key Required Type Description
Highlight ID
highlight id True string

The highlight identifier.

Tag ID
tag id True string

The tag identifier.

Returns

response
string

Get a book

Retrieve the details for a specific book.

Parameters

Name Key Required Type Description
Book ID
book id True string

The book identifier.

Returns

Name Path Type Description
ID
id integer

The identifier.

Title
title string

The title.

Author
author string

The author.

Category
category string

The category.

Source
source string

The source.

Num Highlights
num_highlights integer

The number of highlights.

Last Highlight At
last_highlight_at string

When last highlighted at.

Updated
updated string

When updated.

Cover Image URL
cover_image_url string

The cover image URL address.

Highlights URL
highlights_url string

The highlights URL address.

Source URL
source_url string

The source URL address.

ASIN
asin string

The ASIN.

Tags
tags array of object
ID
tags.id integer

The identifier.

Name
tags.name string

The name.

Get a book's tags

Retrieve a list of tags for a book.

Parameters

Name Key Required Type Description
Book ID
book id True string

The book identifier.

Page Size
page_size integer

The page size.

Page
page string

The page.

Returns

Name Path Type Description
Count
count integer

The count.

Next
next string

The next page address.

Previous
previous string

The previous page address.

Results
results array of object
ID
results.id integer

The identifier.

Name
results.name string

The name.

Get books

Retrieve a list of saved books.

Parameters

Name Key Required Type Description
Page Size
page_size integer

The page size.

Page
page string

The page.

Category
category string

The category.

Source
source string

The source.

Num Highlights
num_highlights integer

The number of highlights.

Num Highlights Less Than
num_highlights__lt integer

The number of highlights less than.

Num Highlights Greater Than
num_highlights__gt integer

The number of highlights greater than.

Updated Less Than
updated__lt string

The updated before time.

Updated Greater Than
updated__gt string

The updated after time.

Last Highlight At Less Than
last_highlight_at__lt string

The last highlight at before time.

Last Highlight At Greater Than
last_highlight_gt string

The last highlight high after time.

Returns

Name Path Type Description
Count
count integer

The count.

Next
next string

The next page address.

Previous
previous string

The previous page address.

Results
results array of object
ID
results.id integer

The identifier.

Title
results.title string

The title.

Author
results.author string

The author.

Category
results.category string

The category.

Source
results.source string

The source.

Num Highlights
results.num_highlights integer

The number of highlights.

Last Highlight At
results.last_highlight_at string

When last highlighted at.

Updated
results.updated string

When updated.

Cover Image URL
results.cover_image_url string

The cover image URL address.

Highlights URL
results.highlights_url string

The highlights URL address.

Source URL
results.source_url string

The source URL address.

ASIN
results.asin string

The ASIN.

Tags
results.tags array of object
ID
results.tags.id integer

The identifier.

Name
results.tags.name string

The name.

Get highlight's tags

Retrieve a list of a highlight's tags.

Parameters

Name Key Required Type Description
Highlight ID
highlight id True string

The highlight identifier.

Page Size
page_size integer

The page size.

Page
page string

The page.

Returns

Name Path Type Description
Count
count integer

The count.

Next
next string

The next page address.

Previous
previous string

The previous page address.

Results
results array of object
ID
results.id integer

The identifier.

Name
results.name string

The name.

Get highlight details

Retrieves the details of a specific highlight

Parameters

Name Key Required Type Description
Highlight ID
highlight id True string

The highlight identifier.

Returns

Name Path Type Description
ID
id integer

The identifier.

Text
text string

The text.

Location
location integer

The location.

Location Type
location_type string

The location type.

Note
note string

The note.

Color
color string

The color.

Highlighted At
highlighted_at string

When highlighted at.

Created At
created_at string

When created at.

Updated At
updated_at string

When updated at.

External ID
external_id string

The external identifier.

End Location
end_location string

The end location.

URL
url string

The URL address.

Book ID
book_id integer

The book identifier.

Tags
tags array of object
ID
tags.id integer

The identifier.

Name
tags.name string

The name.

Is Favorite
is_favorite boolean

Whether is favorite.

Is Discard
is_discard boolean

Whether is discarded.

Readwise URL
readwise_url string

The Readwise URL address.

Get highlights

Export a list of highlights save to your Readwise account.

Parameters

Name Key Required Type Description
Updated After
updatedAfter string

The updated after time.

IDs
ids string

The identifiers.

Page Cursor
pageCursor string

The page cursor.

Returns

Name Path Type Description
Count
count integer

The count.

Next Page Cursor
nextPageCursor string

The next page cursor.

Results
results array of object
User Book ID
results.user_book_id integer

The user book identifier.

Title
results.title string

The title.

Author
results.author string

The author.

Readable Title
results.readable_title string

The readable title.

Source
results.source string

The source.

Cover Image URL
results.cover_image_url string

The cover image URL address.

Unique URL
results.unique_url string

The unique URL address.

Book Tags
results.book_tags array of string

The book tags.

Category
results.category string

The category.

Readwise URL
results.readwise_url string

The Readwise URL address.

Source URL
results.source_url string

The source URL address.

ASIN
results.asin string

The ASIN.

Highlights
results.highlights array of object
ID
results.highlights.id integer

The identifier.

Text
results.highlights.text string

The text.

Location
results.highlights.location integer

The location.

Location Type
results.highlights.location_type string

The location type.

Note
results.highlights.note string

The note.

Color
results.highlights.color string

The color.

Highlighted At
results.highlights.highlighted_at string

When highlighted at.

Created At
results.highlights.created_at string

When created at.

Updated At
results.highlights.updated_at string

When updated at.

External ID
results.highlights.external_id string

The external identifier.

End Location
results.highlights.end_location string

The end location.

URL
results.highlights.url string

The URL address.

Book ID
results.highlights.book_id integer

The book identifier.

tags
results.highlights.tags array of string

The tags.

Is Favorite
results.highlights.is_favorite boolean

Whether is favorite.

Is Discard
results.highlights.is_discard boolean

Whether is discarded.

Readwise URL
results.highlights.readwise_url string

The Readwise URL address.

Get specific highlights

Export a specific list of highlights save to your Readwise account.

Parameters

Name Key Required Type Description
Page Size
page_size integer

The page size.

Page
page integer

The page.

Book ID
book_id integer

The book identifier.

Updated Less Than
updated__lt string

The updated before time.

Updated Greater Than
updated__gt string

The updated after time.

Highlighted Less Than
hightlighted_at__lt string

The highlighted before time.

Highlighted Greater Than
highlighted_at__gt string

The highlighted after time.

Returns

Name Path Type Description
Count
count integer

The count.

Next
next string

The next page address.

Previous
previous string

The previous page address.

Results
results array of object
ID
results.id integer

The identifier.

Text
results.text string

The text.

Note
results.note string

The note.

Location
results.location integer

The location.

Location Type
results.location_type string

The location type.

Highlighted At
results.highlighted_at string

The highlighted at time.

URL
results.url string

The URL address.

Color
results.color string

The tag color.

Updated
results.updated string

When updated.

Book ID
results.book_id integer

The book identifier.

Tags
results.tags array of object
ID
results.tags.id integer

The identifier.

Name
results.tags.name string

The name.

Update a book's tag

Updates a tag for a book.

Parameters

Name Key Required Type Description
Book ID
book id True string

The book identifier.

Tag ID
tag id True string

The tag identifier.

Name
name True string

The name.

Returns

Name Path Type Description
ID
id integer

The identifier.

Name
name string

The name.

Update a highlight

Update an existing highlight.

Parameters

Name Key Required Type Description
Highlight ID
highlight id True string

The highlight identifier.

Text
text string

The text.

Note
note string

The note.

Location
location integer

The location.

URL
url string

The URL address.

Color
color string

The color.

Returns

Name Path Type Description
ID
id integer

The identifier.

Text
text string

The text.

Location
location integer

The location.

Location Type
location_type string

The location type.

Note
note string

The note.

Color
color string

The color.

Highlighted At
highlighted_at string

When highlighted at.

Created At
created_at string

When created at.

Updated At
updated_at string

When updated at.

External ID
external_id string

The external identifier.

End Location
end_location string

The end location.

URL
url string

The URL address.

Book ID
book_id integer

The book identifier.

Tags
tags array of object
ID
tags.id integer

The identifier.

Name
tags.name string

The name.

Is Favorite
is_favorite boolean

Whether is favorite.

Is Discard
is_discard boolean

Whether is discarded.

Readwise URL
readwise_url string

The Readwise URL address.

Update a highlight's tag

Updates a tag's name for a hightlight.

Parameters

Name Key Required Type Description
Highlight ID
highlight id True string

The highlight identifier.

Tag ID
tag id True string

The tag identifier.

Name
name True string

The name.

Returns

Name Path Type Description
ID
id integer

The identifier.

Name
name string

The name.

Definitions

string

This is the basic data type 'string'.