Connectors Reference

Instapaper

Instapaper is a tool for saving web pages to read later. You can create reading lists by organizing pages into folders which can then be accessed from any mobile or web client.

 

Status: Preview

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

ListBookmarksLiked ([Optional]ReadFilterEnum readFilter)

Get all liked bookmarks

ListBookmarksArchived ([Optional]ReadAndLikedFilterEnum filters)

Get all archived bookmarks

ListBookmarksInFolder (string folder_id, [advanced][Optional]string likedFilter, [advanced][Optional]string readFilter)

Get bookmarks in a folder

ListFolders ()

Get folders

ListHighlights (string bookmark_id)

List highlights

UnlikeBookmark (string bookmark_id)

Unlike a bookmark

LikeBookmark (string bookmark_id)

Like a bookmark

ArchiveBookmark (string bookmark_id)

Archive a bookmark

UnarchiveBookmark (string bookmark_id)

Unarchive a bookmark

DeleteBookmark (string bookmark_id)

Delete a bookmark permenantly (warning: can not be undone)

MarkReadBookmark (string bookmark_id)

Mark a bookmark read

MarkUnreadBookmark (string bookmark_id)

Mark a bookmark unread

AddHighlight (string bookmark_id, string text)

Add a highlight to a bookmark

CreateFolder (string title)

Create a folder

 

Triggers:

Name

Summary

OnBookmarkAdded (string folder_id)

When a bookmark is added to a folder

OnBookmarkRemoved (string folder_id)

When a bookmark is removed from a folder

OnBookmarkArchived ()

When a bookmark is archived

OnBookmarkLiked ()

When a bookmark is liked

OnFolderCreated ()

When a folder is created

OnBookmarkProgressUpdated (string folder_id)

When the read progress of a bookmark is updated

OnBookmarkProgressRead (string folder_id)

When a bookmark is marked read

OnHighlightAdded (string folder_id, string bookmark_id)

When a highlight is added to a bookmark

 

Objects:

Name

Summary

Bookmark

 

BookmarkResponse

 

BookmarksResponse

 

Folder

 

FolderResponse

 

FoldersResponse

 

HighlighstResponse

 

Highlight

 

HighlightResponse

 

Object

 

ReadAndLikedFilterEnum

 

ReadFilterEnum

 

 

Actions:

ListBookmarksLiked

Summary: Get all liked bookmarks

Description: Get all liked bookmarks

 

Syntax:

Instapaper.ListBookmarksLiked ([Optional]ReadFilterEnum readFilter)

 

Parameters:

Name

Type

Summary

Required

Related Action

readFilter

ReadFilterEnum

 

 

False

 

Returns:

          Type:BookmarksResponse

          Description: The response model for bookmark searches

 

ListBookmarksArchived

Summary: Get all archived bookmarks

Description: Get all archived bookmarks

 

Syntax:

Instapaper.ListBookmarksArchived ([Optional]ReadAndLikedFilterEnum filters)

 

Parameters:

Name

Type

Summary

Required

Related Action

filters

ReadAndLikedFilterEnum

 

 

False

 

Returns:

          Type:BookmarksResponse

          Description: The response model for bookmark searches

 

ListBookmarksInFolder

Summary: Get bookmarks in a folder

Description: Get bookmarks in a folder

 

Syntax:

Instapaper.ListBookmarksInFolder (string folder_id, [advanced][Optional]string likedFilter, [advanced][Optional]string readFilter)

 

Parameters:

Name

Type

Summary

Required

Related Action

folder_id

string

(Folder)

The folder id, or "unread" for the home folder

True

ListFolders

likedFilter

string

(Liked filter (default: all))Values: [Liked, Not liked]

Whether to filter on the "liked" feature of a bookmark

False

readFilter

string

(Read filter (default: all))Values: [Unread, Unread or partially read, Partially read, Partially read or read, Read]

Whether to filter on the read progress of a bookmark

False

 

Returns:

          Type:BookmarksResponse

          Description: The response model for bookmark searches

 

ListFolders

Summary: Get folders

Description: Get folders

 

Syntax:

Instapaper.ListFolders ()

 

Returns:

          Type:FoldersResponse

          Description: The resposne model for folder searches

 

ListHighlights

Summary: List highlights

Description: List the highlights from a specific bookmark.

 

Syntax:

Instapaper.ListHighlights (string bookmark_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

bookmark_id

string

(Bookmark Id)

The id of the bookmark

True

 

Returns:

          Type:HighlighstResponse

          Description: The response model for highlights actions

 

UnlikeBookmark

Summary: Unlike a bookmark

Description: Unlike a bookmark

 

Syntax:

Instapaper.UnlikeBookmark (string bookmark_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

bookmark_id

string

(Bookmark Id)

The id of the bookmark

True

 

Returns:

          Type:BookmarkResponse

          Description: The response model for bookark actions

 

LikeBookmark

Summary: Like a bookmark

Description: Like a bookmark

 

Syntax:

Instapaper.LikeBookmark (string bookmark_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

bookmark_id

string

(Bookmark Id)

The id of the bookmark

True

 

Returns:

          Type:BookmarkResponse

          Description: The response model for bookark actions

 

ArchiveBookmark

Summary: Archive a bookmark

Description: Archive a bookmark

 

Syntax:

Instapaper.ArchiveBookmark (string bookmark_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

bookmark_id

string

(Bookmark Id)

The id of the bookmark

True

 

Returns:

          Type:BookmarkResponse

          Description: The response model for bookark actions

 

UnarchiveBookmark

Summary: Unarchive a bookmark

Description: Unarchive a bookmark

 

Syntax:

Instapaper.UnarchiveBookmark (string bookmark_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

bookmark_id

string

(Bookmark Id)

The id of the bookmark

True

 

Returns:

          Type:BookmarkResponse

          Description: The response model for bookark actions

 

DeleteBookmark

Summary: Delete a bookmark permenantly (warning: can not be undone)

Description: Delete a bookmark permenantly (warning: can not be undone)

 

Syntax:

Instapaper.DeleteBookmark (string bookmark_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

bookmark_id

string

(Bookmark Id)

The id of the bookmark

True

 

Returns:

          Type:Object

 

MarkReadBookmark

Summary: Mark a bookmark read

Description: Mark a bookmark read

 

Syntax:

Instapaper.MarkReadBookmark (string bookmark_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

bookmark_id

string

(Bookmark Id)

The id of the bookmark

True

 

Returns:

          Type:Object

 

MarkUnreadBookmark

Summary: Mark a bookmark unread

Description: Mark a bookmark unread

 

Syntax:

Instapaper.MarkUnreadBookmark (string bookmark_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

bookmark_id

string

(Bookmark Id)

The id of the bookmark

True

 

Returns:

          Type:Object

 

AddHighlight

Summary: Add a highlight to a bookmark

Description: Add a highlight to a bookmark

 

Syntax:

Instapaper.AddHighlight (string bookmark_id, string text)

 

Parameters:

Name

Type

Summary

Required

Related Action

bookmark_id

string

(Bookmark Id)

The id of the bookmark

True

text

string

(Text)

The text to highlight

True

 

Returns:

          Type:HighlightResponse

          Description: The response model for highlight actions

 

CreateFolder

Summary: Create a folder

Description: Create a folder

 

Syntax:

Instapaper.CreateFolder (string title)

 

Parameters:

Name

Type

Summary

Required

Related Action

title

string

(Name)

The name of the new folder, must be unique

True

 

Returns:

          Type:FolderResponse

          Description: The resposne model for folder searches

 

Triggers:

Trigger OnBookmarkAdded

Summary: When a bookmark is added to a folder

Description: When a bookmark is added to a folder

 

Syntax:

Instapaper.OnBookmarkAdded (string folder_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

folder_id

string

(Folder)

The folder id, or "unread" for the home folder

True

ListFolders

 

Returns:

          Type:BookmarksResponse

          Description: The response model for bookmark searches

 

Trigger OnBookmarkRemoved

Summary: When a bookmark is removed from a folder

Description: When a bookmark is removed from a folder

 

Syntax:

Instapaper.OnBookmarkRemoved (string folder_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

folder_id

string

(Folder)

The folder id, or "unread" for the home folder

True

ListFolders

 

Returns:

          Type:array of (integer(int32))

 

Trigger OnBookmarkArchived

Summary: When a bookmark is archived

Description: When a bookmark is archived

 

Syntax:

Instapaper.OnBookmarkArchived ()

 

Returns:

          Type:BookmarksResponse

          Description: The response model for bookmark searches

 

Trigger OnBookmarkLiked

Summary: When a bookmark is liked

Description: When a bookmark is liked

 

Syntax:

Instapaper.OnBookmarkLiked ()

 

Returns:

          Type:BookmarksResponse

          Description: The response model for bookmark searches

 

Trigger OnFolderCreated

Summary: When a folder is created

Description: When a folder is created

 

Syntax:

Instapaper.OnFolderCreated ()

 

Returns:

          Type:FoldersResponse

          Description: The resposne model for folder searches

 

Trigger OnBookmarkProgressUpdated

Summary: When the read progress of a bookmark is updated

Description: When the read progress of a bookmark is updated

 

Syntax:

Instapaper.OnBookmarkProgressUpdated (string folder_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

folder_id

string

(Folder)

The folder id, or "unread" for the home folder

True

ListFolders

 

Returns:

          Type:BookmarksResponse

          Description: The response model for bookmark searches

 

Trigger OnBookmarkProgressRead

Summary: When a bookmark is marked read

Description: When a bookmark is marked read

 

Syntax:

Instapaper.OnBookmarkProgressRead (string folder_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

folder_id

string

(Folder)

The folder id, or "unread" for the home folder

True

ListFolders

 

Returns:

          Type:BookmarksResponse

          Description: The response model for bookmark searches

 

Trigger OnHighlightAdded

Summary: When a highlight is added to a bookmark

Description: When a highlight is added to a bookmark

 

Syntax:

Instapaper.OnHighlightAdded (string folder_id, string bookmark_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

folder_id

string

(Folder)

The folder to look a bookmark up in

True

ListFolders

bookmark_id

string

(Bookmark)

The bookmark to check for highlights

True

ListBookmarksInFolder

 

Returns:

          Type:HighlighstResponse

          Description: The response model for highlights actions

 


 

Bookmark

Summary:

Description: A user

 

          Properties:

Name

Type

Summary

bookmark_id

integer(int32)

Bookmark Id

Identifier of the bookmark

title

string

Title

Title of the bookmark

description

string

Description

 

url

string

Url

The original url of the bookmarked item

starred

boolean

Liked

Indicates whether the bookmark has been liked or not

time

string(date-time)

Creation time

The time the bookmark was created

progress

number(double)

Read progress

The percentage of the bookmark that has been read


 

BookmarkResponse

Summary:

Description: The response model for bookark actions

 

          Properties:

Name

Type

Summary

Bookmark

Bookmark

 

A user


 

BookmarksResponse

Summary:

Description: The response model for bookmark searches

 

          Properties:

Name

Type

Summary

Bookmarks

array of (Bookmark)

 

A list of bookmarks returned by the action


 

Folder

Summary:

Description: A user

 

          Properties:

Name

Type

Summary

folder_id

integer(int32)

Folder Id

Identifier of the folder

title

string

Title

 

display_title

string

Display title

 

sync_to_mobile

boolean

Sync to mobile

indicates whether this folder is synced to mobile app

position

integer(int32)

Position

Ordinal position of the folder


 

FolderResponse

Summary:

Description: The resposne model for folder searches

 

          Properties:

Name

Type

Summary

Folders

Folder

 

A user


 

FoldersResponse

Summary:

Description: The resposne model for folder searches

 

          Properties:

Name

Type

Summary

Folders

array of (Folder)

 

A list of folders returned by the action


 

HighlighstResponse

Summary:

Description: The response model for highlights actions

 

          Properties:

Name

Type

Summary

Highlights

array of (Highlight)

 

The highlights


 

Highlight

Summary:

Description: A user

 

          Properties:

Name

Type

Summary

highlight_id

integer(int32)

Highlight Id

 

text

string

Text

The text to highlight

position

integer(int32)

Position

Position where to start searching for the text

time

integer(int32)

Creation time

Time the highlight was created


 

HighlightResponse

Summary:

Description: The response model for highlight actions

 

          Properties:

Name

Type

Summary

Highlight

Highlight

 

A user


 

Object

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

ReadAndLikedFilterEnum

Summary:

Description:

 

          Properties:

Name

Type

Summary

likedFilter

string

Liked filter (default: all)

Whether to filter on the "liked" feature of a bookmark  Values: [Liked, Not liked]

readFilter

string

Read filter (default: all)

Whether to filter on the read progress of a bookmark  Values: [Unread, Unread or partially read, Partially read, Partially read or read, Read]


 

ReadFilterEnum

Summary:

Description:

 

          Properties:

Name

Type

Summary

readFilter

string