Retrieve all entries. It could be filtered by many options.
Documentation
Retrieve all entries. It could be filtered by many options.
Requirements
Name
Requirement
Type
Description
_format
xml|json|txt|csv|pdf|epub|mobi|html
Parameters
Parameter
Type
Required?
Format
Description
archive
integer
false
1 or 0, all entries by default
filter by archived status.
starred
integer
false
1 or 0, all entries by default
filter by starred status.
sort
string
false
'created' or 'updated', default 'created'
sort entries by date.
order
string
false
'asc' or 'desc', default 'desc'
order of sort.
page
integer
false
default '1'
what page you want.
perPage
integer
false
default'30'
results per page.
tags
string
false
api,rest
a list of tags url encoded. Will returns entries that matches ALL tags.
since
integer
false
default '0'
The timestamp since when you want entries updated.
POST
/api/entries.{_format}
Create an entry.
Documentation
Create an entry.
Requirements
Name
Requirement
Type
Description
_format
xml|json|txt|csv|pdf|epub|mobi|html
Parameters
Parameter
Type
Required?
Format
Description
url
string
true
http://www.test.com/article.html
Url for the entry.
title
string
false
Optional, we'll get the title from the page.
tags
string
false
tag1,tag2,tag3
a comma-separated list of tags.
starred
integer
false
1 or 0
entry already starred
archive
integer
false
1 or 0
entry already archived
GET
/api/entries/exists.{_format}
Check if an entry exist by url.
Documentation
Check if an entry exist by url.
Requirements
Name
Requirement
Type
Description
_format
xml|json|txt|csv|pdf|epub|mobi|html
Parameters
Parameter
Type
Required?
Format
Description
url
string
true
An url
Url to check if it exists
urls
string
false
An array of urls (?urls[]=http...&urls[]=http...)
Urls (as an array) to check if it exists
DELETE
/api/entries/{entry}.{_format}
Delete permanently an entry.
Documentation
Delete permanently an entry.
Requirements
Name
Requirement
Type
Description
entry
\w+
integer
The entry ID
_format
xml|json|txt|csv|pdf|epub|mobi|html
GET
/api/entries/{entry}.{_format}
Retrieve a single entry.
Documentation
Retrieve a single entry.
Requirements
Name
Requirement
Type
Description
entry
\w+
integer
The entry ID
_format
xml|json|txt|csv|pdf|epub|mobi|html
PATCH
/api/entries/{entry}.{_format}
Change several properties of an entry.
Documentation
Change several properties of an entry.
Requirements
Name
Requirement
Type
Description
entry
\w+
integer
The entry ID
_format
xml|json|txt|csv|pdf|epub|mobi|html
Parameters
Parameter
Type
Required?
Format
Description
title
string
false
tags
string
false
tag1,tag2,tag3
a comma-separated list of tags.
archive
integer
false
1 or 0
archived the entry.
starred
integer
false
1 or 0
starred the entry.
GET
/api/entries/{entry}/export.{_format}
Retrieve a single entry as a predefined format.
Documentation
Retrieve a single entry as a predefined format.
Requirements
Name
Requirement
Type
Description
entry
\w+
integer
The entry ID
_format
xml|json|txt|csv|pdf|epub|mobi|html
PATCH
/api/entries/{entry}/reload.{_format}
Reload an entry.
Documentation
Reload an entry.
An empty response with HTTP Status 304 will be send if we weren't able to update the content (because it hasn't changed or we got an error).
Requirements
Name
Requirement
Type
Description
entry
\w+
integer
The entry ID
_format
xml|json|txt|csv|pdf|epub|mobi|html
GET
/api/entries/{entry}/tags.{_format}
Retrieve all tags for an entry.
Documentation
Retrieve all tags for an entry.
Requirements
Name
Requirement
Type
Description
entry
\w+
integer
The entry ID
_format
xml|json|txt|csv|pdf|epub|mobi|html
POST
/api/entries/{entry}/tags.{_format}
Add one or more tags to an entry.
Documentation
Add one or more tags to an entry.
Requirements
Name
Requirement
Type
Description
entry
\w+
integer
The entry ID
_format
xml|json|txt|csv|pdf|epub|mobi|html
Parameters
Parameter
Type
Required?
Format
Description
tags
string
false
tag1,tag2,tag3
a comma-separated list of tags.
DELETE
/api/entries/{entry}/tags/{tag}.{_format}
Permanently remove one tag for an entry.
Documentation
Permanently remove one tag for an entry.
Requirements
Name
Requirement
Type
Description
tag
\w+
integer
The tag ID
entry
\w+
integer
The entry ID
_format
xml|json|txt|csv|pdf|epub|mobi|html
DELETE
/api/tag/label.{_format}
Permanently remove one tag from every entry.
Documentation
Permanently remove one tag from every entry.
Requirements
Name
Requirement
Type
Description
tag
\w+
string
Tag as a string
_format
xml|json|txt|csv|pdf|epub|mobi|html
GET
/api/tags.{_format}
Retrieve all tags.
Documentation
Retrieve all tags.
Requirements
Name
Requirement
Type
Description
_format
xml|json|txt|csv|pdf|epub|mobi|html
DELETE
/api/tags/label.{_format}
Permanently remove some tags from every entry.
Documentation
Permanently remove some tags from every entry.
Requirements
Name
Requirement
Type
Description
tags
string
Tags as strings (comma splitted)
_format
xml|json|txt|csv|pdf|epub|mobi|html
DELETE
/api/tags/{tag}.{_format}
Permanently remove one tag from every entry.
Documentation
Permanently remove one tag from every entry.
Requirements
Name
Requirement
Type
Description
tag
\w+
integer
The tag
_format
xml|json|txt|csv|pdf|epub|mobi|html
GET
/api/version.{_format}
Retrieve version number.
Documentation
Retrieve version number.
Requirements
Name
Requirement
Type
Description
_format
xml|json|txt|csv|pdf|epub|mobi|html
Documentation auto-generated on Mon, 18 Feb 19 18:13:06 +0100