Show/hide List Operations Expand Operations

Author

POST /api/author

Create an author.

GET /api/author/action/exclude/{id}

Set "exclude" action / Remove "exclude" action.

DELETE /api/author/{id}

Delete an author.

GET /api/author/{id}

Retrieve an author.

PUT /api/author/{id}

Update an author.

GET /api/authors

Retrieve all authors.

Documentation

Retrieve all authors.

Parameters

Parameter	Type	Required?	Format	Description
sortField	string	false	"title" or "date_created", default "title"
sortDirection	string	false	"ASC" or "DESC", default "DESC"
page	integer	false	default "1"	page number
perPage	integer	false	default "100"	authors per page
recent	integer	false	1 or 0	recent authors
excluded	integer	false	1 or 0	excluded authors
feed	integer	false	feed ID	authors by feed

Headers

Name	Required?	Description
X-CONNECTION-TOKEN	true

GET /api/authors/search

Search authors.

Documentation

Search authors.

Parameters

Parameter	Type	Required?	Format	Description
q	string	true		query
sortField	string	false	"score", "title" or "date", default "score"
sortDirection	string	false	"ASC" or "DESC", default "DESC"
page	integer	false	default "1"	page number
perPage	integer	false	default "20"	items per page

Headers

Name	Required?	Description
X-CONNECTION-TOKEN	true

Show/hide List Operations Expand Operations

Connection

POST /api/connection

Create a connection.

DELETE /api/connection/{id}

Delete a connection.

GET /api/connection/{id}

Retrieve a connection.

PUT /api/connection/{id}

Update a connection.

Show/hide List Operations Expand Operations

Feed

POST /api/feed

Create a feed.

Documentation

Create a feed.

Parameters

Parameter	Type	Required?
title	string	false
link	string	true
website	string	false

Headers

Name	Required?	Description
X-CONNECTION-TOKEN	true

GET /api/feed/action/subscribe/{id}

Set "subscribe" action / Remove "subscribe" action.

DELETE /api/feed/{id}

Delete a feed.

GET /api/feed/{id}

Retrieve a feed.

PUT /api/feed/{id}

Update a feed.

Documentation

Update a feed.

Requirements

Name	Requirement	Type	Description
id	\d+

Parameters

Parameter	Type	Required?
title	string	false
link	string	true
website	string	false

Headers

Name	Required?	Description
X-CONNECTION-TOKEN	true

GET /api/feeds

Retrieve all feeds.

Documentation

Retrieve all feeds.

Parameters

Parameter	Type	Required?	Format	Description
sortField	string	false	"title" or "date_created", default "title"
sortDirection	string	false	"ASC" or "DESC", default "ASC"
page	integer	false	default "1"	page number
perPage	integer	false	default "100"	items per page
recent	integer	false	1 or 0	recent feeds
subscribed	integer	false	1 or 0	subscribed feeds
unsubscribed	integer	false	1 or 0	unsubscribed feeds
witherrors	integer	false	1 or 0	feeds with errors
category	integer	false	category ID	feeds by category
author	integer	false	author ID	feeds by author

Headers

Name	Required?	Description
X-CONNECTION-TOKEN	true

POST /api/feeds/export

Export an opml file.

Parameter	Type	Required?	Format	Description
choice	string	true

POST /api/feeds/import

Import an opml file.

Parameter	Type	Required?	Format	Description
opml	file	true

GET /api/feeds/search

Search feeds.

Documentation

Search feeds.

Parameters

Parameter	Type	Required?	Format	Description
q	string	true		query
sortField	string	false	"score", "title" or "date", default "score"
sortDirection	string	false	"ASC" or "DESC", default "DESC"
page	integer	false	default "1"	page number
perPage	integer	false	default "20"	items per page

Headers

Name	Required?	Description
X-CONNECTION-TOKEN	true

Show/hide List Operations Expand Operations

Item

POST /api/item/action/email/{id}

Send item by email.

Documentation

Send item by email.

Requirements

Name	Requirement	Type	Description
id	\d+

Parameters

Parameter	Type	Required?	Format
subject	string	true	default "item title"
recipient	string	true	email
message	string	false
replyTo	string	false	email

Headers

Name	Required?	Description
X-CONNECTION-TOKEN	true

GET /api/item/action/read/{id}

Set "read" action / Remove "read" action.

GET /api/item/action/star/{id}

Set "star" action / Remove "star" action.

DELETE /api/item/{id}

Delete an item.

GET /api/item/{id}

Retrieve an item.

GET /api/items

Retrieve all items.

Documentation

Retrieve all items.

Parameters

Parameter	Type	Required?	Format	Description
sortField	string	false	"title" or "date", default "score"
sortDirection	string	false	"ASC" or "DESC", default "DESC"
page	integer	false	default "1"	page number
perPage	integer	false	default "20"	items per page
starred	integer	false	1 or 0	items with action "star"
unread	integer	false	1 or 0	items with no action "read"
geolocation	integer	false	1 or 0	items with geolocation
feed	integer	false	feed ID	items by feed
author	integer	false	author ID	items by author
category	integer	false	category ID	items by category
days	integer	false		Limit items to X days

Headers

Name	Required?	Description
X-CONNECTION-TOKEN	true

Status Codes

Status Code	Description
200	Returned when successful
403	Returned when the user is not authorized to say hello
404	Returned when the user is not found Returned when something else is not found

GET /api/items/markallasread

Mark all items as read.

Documentation

Mark all items as read.

Parameters

Parameter	Type	Required?	Format	Description
starred	integer	false	1 or 0	items with action "star"
feed	integer	false	feed ID	items by feed
author	integer	false	author ID	items by author
category	integer	false	category ID	items by category

Headers

Name	Required?	Description
X-CONNECTION-TOKEN	true

GET /api/items/search

Search items.

Documentation

Search items.

Parameters

Parameter	Type	Required?	Format	Description
q	string	true		query
sortField	string	false	"score", "title" or "date", default "score"
sortDirection	string	false	"ASC" or "DESC", default "DESC"
page	integer	false	default "1"	page number
perPage	integer	false	default "20"	items per page

Headers

Name	Required?	Description
X-CONNECTION-TOKEN	true

Show/hide List Operations Expand Operations

Member

POST /api/login

GET /api/logout

Logout.

POST /api/member

Create a member.

DELETE /api/member/{id}

Delete a member.

GET /api/member/{id}

Retrieve a member.

PUT /api/member/{id}

Update a member.

POST /api/notifier/set

Notifier.

GET /api/notifier/unread

Get unread.

POST /api/pinboard

Set Pinboard API token.

GET /api/profile

Profile.

GET /api/profile/connections

Profile connections.

PUT /api/profile/update

Profile update.

Documentation

Profile update.

Parameters

Parameter	Type	Required?	Format
email	string	true	email
password	string	false
passwordConfirm	string	false

Headers

Name	Required?	Description
X-CONNECTION-TOKEN	true

GET /api/status

Get status.

GET /api/test

Test.

Documentation auto-generated on Thu, 04 Mar 21 03:52:09 +0000

API documentation

Author

POST /api/author

Documentation

Headers

GET /api/author/action/exclude/{id}

Documentation

Requirements

Headers

DELETE /api/author/{id}

Documentation

Requirements

Headers

GET /api/author/{id}

Documentation

Requirements

Headers

PUT /api/author/{id}

Documentation

Requirements

Headers

GET /api/authors

Documentation

Parameters

Headers

GET /api/authors/search

Documentation

Parameters

Headers

Category

GET /api/categories

Documentation

Parameters

Headers

GET /api/categories/search

Documentation

Parameters

Headers

POST /api/category

Documentation

Headers

GET /api/category/action/exclude/{id}

Documentation

Requirements

Headers

DELETE /api/category/{id}

Documentation

Requirements

Headers

GET /api/category/{id}

Documentation

Requirements

Headers

PUT /api/category/{id}

Documentation

Requirements

Headers

Connection

POST /api/connection

Documentation

Parameters

DELETE /api/connection/{id}

Documentation

Requirements

Headers

GET /api/connection/{id}

Documentation

Requirements

Headers

PUT /api/connection/{id}

Documentation

Requirements

Headers

Feed

POST /api/feed

Documentation

Parameters

Headers

GET /api/feed/action/subscribe/{id}

Documentation