Miniflux
App · 11 actions
Read your feeds in Miniflux: find, read, star and mark entries, subscribe to feeds, manage categories, and start a workflow when a new entry arrives or one is starred.
Actions
| Action | What it does |
|---|---|
| Create category | Create a category to file feeds in. |
| Delete category | Delete a category with no feeds in it. |
| Find entries | Find entries by unread or read, starred, category, feed, words or when they were published, newest first, with their content as text and HTML. |
| Get entry | Get an entry with its content as text and HTML, or with the full original article fetched from its website, for a feed that sends only a summary. |
| List categories | List your categories, with how many feeds and unread entries each has. |
| List feeds | List the feeds you're subscribed to, with their categories, unread counts and any error reading them. |
| Mark entries read or unread | Mark one or more entries read or unread, such as the ones a workflow has just posted or summarised. |
| Refresh feed | Have Miniflux read a feed now rather than at its next scheduled check, and get how many new unread entries it brought. |
| Star or unstar entry | Star an entry to keep it, or take its star off. |
| Subscribe to feed | Subscribe to a feed by its address, or by a website's address and Miniflux finds its feed, in a category of your choice. |
| Unsubscribe from feed | Unsubscribe from a feed. |
Create category
Create a category to file feeds in. One of that name already there is answered as it is.
Inputs
- Name
titletextRequired - The category's name.
Outputs
already_existedtrue/false- Whether a category of that name was already there
feed_countnumber- How many feeds are in it
idnumber- The category's ID
linktext- A link to it in Miniflux
titletext- Its name
unread_countnumber- How many unread entries its feeds have
Example output
{
"already_existed": false,
"feed_count": 0,
"id": 3,
"link": "https://reader.miniflux.app/category/3/entries",
"title": "Tech",
"unread_count": 0
}Delete category
Delete a category with no feeds in it. One with feeds is refused, because Miniflux would unsubscribe from them too.
Inputs
- Category
categorytextRequired - The category to delete: its name or ID.
Outputs
deletedtrue/false- Always true
idnumber- The category's ID
titletext- Its name
Example output
{
"deleted": true,
"id": 3,
"title": "Tech"
}Find entries
Find entries by unread or read, starred, category, feed, words or when they were published, newest first, with their content as text and HTML.
Inputs
- Read or unread
statustext - Which entries to find.One of:
unread,read,any(Both). Default:unread. - Starred only
starredtrue/false - Only entries you've starred.
- Category
categorytext - Only entries from feeds in this category. Leave blank for every category.
- Feed
feedtext - Only entries from this feed. Leave blank for every feed.
- Words
searchtext - Only entries with these words in their title or content.
- Published after
published_afterdate and time - Only entries published after this time.
- Order
ordertext - Which come first.One of:
newest(Newest first),oldest(Oldest first). Default:newest. - How many
limitnumber - The most to list, up to 100. Defaults to 25.From 1 to 100.
Outputs
countnumber- How many entries are listed
entrieslist- The entries found
totalnumber- How many entries match, including any past the limit
Example output
{
"count": 1,
"entries": [
{
"author": "Jane Doe",
"category": "Tech",
"category_id": 3,
"comments_url": "",
"content": "The Kubernetes project shipped version 2.0.",
"content_html": "<p>The <b>Kubernetes</b> project shipped version 2.0.</p>",
"created_at": "2026-11-02T10:05:12Z",
"feed": "Tech News",
"feed_id": 12,
"feed_url": "https://news.example.com/feed.xml",
"id": 4211,
"link": "https://reader.miniflux.app/feed/12/entry/4211",
"media": [],
"published_at": "2026-11-02T10:00:00Z",
"reading_time": 1,
"site_url": "https://news.example.com/",
"starred": false,
"status": "unread",
"tags": [
"Cloud"
],
"title": "Kubernetes 2.0 released",
"url": "https://news.example.com/kubernetes-2"
}
],
"total": 1
}Get entry
Get an entry with its content as text and HTML, or with the full original article fetched from its website, for a feed that sends only a summary.
Inputs
- Entry
entrytextRequired - The entry's ID, such as one from 'Find entries' or a trigger, or its link in Miniflux (…/entry/42).
- Fetch the original article
fetch_originaltrue/false - Read the whole article from its website instead of what the feed sent. Miniflux keeps its own copy as it was.
Outputs
authortext- Its author, when the feed names one
categorytext- The feed's category
category_idnumber- The category's ID
comments_urltext- A link to its comments, when the feed has one
contenttext- Its content as plain text
content_htmltext- Its content as HTML
created_attext- When Miniflux first read it (ISO 8601)
feedtext- The feed it came from
feed_idnumber- The feed's ID
feed_urltext- The feed's address
fetched_originaltrue/false- Whether the content is the original article, fetched from its website
idnumber- The entry's ID in Miniflux
linktext- A link to it in Miniflux
medialist- Links to attached audio, video or pictures, such as a podcast episode
published_attext- When it was published (ISO 8601)
reading_timenumber- Minutes it takes to read, as Miniflux estimates
site_urltext- The address of the feed's website
starredtrue/false- Whether it's starred
statustext- unread or read
tagslist- Its tags, as the feed gives them
titletext- Its title
urltext- The link to the original article
Example output
{
"author": "Jane Doe",
"category": "Tech",
"category_id": 3,
"comments_url": "",
"content": "The Kubernetes project shipped version 2.0.",
"content_html": "<p>The <b>Kubernetes</b> project shipped version 2.0.</p>",
"created_at": "2026-11-02T10:05:12Z",
"feed": "Tech News",
"feed_id": 12,
"feed_url": "https://news.example.com/feed.xml",
"fetched_original": false,
"id": 4211,
"link": "https://reader.miniflux.app/feed/12/entry/4211",
"media": [],
"published_at": "2026-11-02T10:00:00Z",
"reading_time": 1,
"site_url": "https://news.example.com/",
"starred": false,
"status": "unread",
"tags": [
"Cloud"
],
"title": "Kubernetes 2.0 released",
"url": "https://news.example.com/kubernetes-2"
}List categories
List your categories, with how many feeds and unread entries each has.
Inputs
None.
Outputs
categorieslist- The categories, by name
countnumber- How many categories are listed
Example output
{
"categories": [
{
"feed_count": 4,
"id": 3,
"link": "https://reader.miniflux.app/category/3/entries",
"title": "Tech",
"unread_count": 17
}
],
"count": 1
}List feeds
List the feeds you're subscribed to, with their categories, unread counts and any error reading them.
Inputs
- Category
categorytext - Only feeds in this category. Leave blank for every feed.
Outputs
countnumber- How many feeds are listed
feedslist- The feeds, by title
Example output
{
"count": 1,
"feeds": [
{
"category": "Tech",
"category_id": 3,
"checked_at": "2026-11-06T08:00:00Z",
"disabled": false,
"error": "",
"error_count": 0,
"feed_url": "https://news.example.com/feed.xml",
"fetch_full_articles": false,
"id": 12,
"link": "https://reader.miniflux.app/feed/12/entries",
"read_count": 40,
"site_url": "https://news.example.com/",
"title": "Tech News",
"unread_count": 8
}
]
}Mark entries read or unread
Mark one or more entries read or unread, such as the ones a workflow has just posted or summarised.
Inputs
- Entries
entrieslistRequired - The entries' IDs, such as the IDs from 'Find entries'.
- Mark as
statustext - Read or unread.One of:
read,unread. Default:read.
Outputs
countnumber- How many entries were marked
entry_idslist- The IDs of the entries marked
statustext- What they were marked: read or unread
Example output
{
"count": 2,
"entry_ids": [
4211,
4212
],
"status": "read"
}Refresh feed
Have Miniflux read a feed now rather than at its next scheduled check, and get how many new unread entries it brought.
Inputs
- Feed
feedtextRequired - The feed: its name, ID or address.
Outputs
categorytext- Its category
category_idnumber- The category's ID
checked_attext- When Miniflux last read it (ISO 8601)
disabledtrue/false- Whether Miniflux has stopped reading it
errortext- Why Miniflux couldn't read it last time; empty when it could
error_countnumber- How many times in a row reading it failed
feed_urltext- The feed's address
fetch_full_articlestrue/false- Whether Miniflux fetches each new entry's full article from its website
idnumber- The feed's ID
linktext- A link to it in Miniflux
new_unreadnumber- How many more unread entries it has than before
read_countnumber- How many of its entries are read
site_urltext- The address of its website
titletext- Its title
unread_countnumber- How many of its entries are unread
Example output
{
"category": "Tech",
"category_id": 3,
"checked_at": "2026-11-06T08:00:00Z",
"disabled": false,
"error": "",
"error_count": 0,
"feed_url": "https://news.example.com/feed.xml",
"fetch_full_articles": false,
"id": 12,
"link": "https://reader.miniflux.app/feed/12/entries",
"new_unread": 2,
"read_count": 40,
"site_url": "https://news.example.com/",
"title": "Tech News",
"unread_count": 8
}Star or unstar entry
Star an entry to keep it, or take its star off. One already as asked is left as it is.
Inputs
- Entry
entrytextRequired - The entry's ID, such as one from 'Find entries' or a trigger, or its link in Miniflux (…/entry/42).
- Star or unstar
starredtext - Whether to star it or take its star off.One of:
star,unstar. Default:star.
Outputs
authortext- Its author, when the feed names one
categorytext- The feed's category
category_idnumber- The category's ID
comments_urltext- A link to its comments, when the feed has one
contenttext- Its content as plain text
content_htmltext- Its content as HTML
created_attext- When Miniflux first read it (ISO 8601)
feedtext- The feed it came from
feed_idnumber- The feed's ID
feed_urltext- The feed's address
idnumber- The entry's ID in Miniflux
linktext- A link to it in Miniflux
medialist- Links to attached audio, video or pictures, such as a podcast episode
published_attext- When it was published (ISO 8601)
reading_timenumber- Minutes it takes to read, as Miniflux estimates
site_urltext- The address of the feed's website
starredtrue/false- Whether it's starred
statustext- unread or read
tagslist- Its tags, as the feed gives them
titletext- Its title
urltext- The link to the original article
Example output
{
"author": "Jane Doe",
"category": "Tech",
"category_id": 3,
"comments_url": "",
"content": "The Kubernetes project shipped version 2.0.",
"content_html": "<p>The <b>Kubernetes</b> project shipped version 2.0.</p>",
"created_at": "2026-11-02T10:05:12Z",
"feed": "Tech News",
"feed_id": 12,
"feed_url": "https://news.example.com/feed.xml",
"id": 4211,
"link": "https://reader.miniflux.app/feed/12/entry/4211",
"media": [],
"published_at": "2026-11-02T10:00:00Z",
"reading_time": 1,
"site_url": "https://news.example.com/",
"starred": true,
"status": "unread",
"tags": [
"Cloud"
],
"title": "Kubernetes 2.0 released",
"url": "https://news.example.com/kubernetes-2"
}Subscribe to feed
Subscribe to a feed by its address, or by a website's address and Miniflux finds its feed, in a category of your choice. A feed already subscribed to is left as it is.
Inputs
- Feed or website address
urltextRequired - The feed's address, or the address of a website that has one, such as https://example.com/blog.
- Category
categorytext - The category to put it in. One that doesn't exist yet is made. Leave blank for your first category.
- Fetch full articles
fetch_full_articlestrue/false - For a feed that sends only summaries: Miniflux fetches each new entry's whole article from its website.
Outputs
already_subscribedtrue/false- Whether the feed was already there
categorytext- Its category
category_idnumber- The category's ID
checked_attext- When Miniflux last read it (ISO 8601)
disabledtrue/false- Whether Miniflux has stopped reading it
errortext- Why Miniflux couldn't read it last time; empty when it could
error_countnumber- How many times in a row reading it failed
feed_urltext- The feed's address
fetch_full_articlestrue/false- Whether Miniflux fetches each new entry's full article from its website
idnumber- The feed's ID
linktext- A link to it in Miniflux
read_countnumber- How many of its entries are read
site_urltext- The address of its website
titletext- Its title
unread_countnumber- How many of its entries are unread
Example output
{
"already_subscribed": false,
"category": "Tech",
"category_id": 3,
"checked_at": "2026-11-06T08:00:00Z",
"disabled": false,
"error": "",
"error_count": 0,
"feed_url": "https://news.example.com/feed.xml",
"fetch_full_articles": false,
"id": 12,
"link": "https://reader.miniflux.app/feed/12/entries",
"read_count": 40,
"site_url": "https://news.example.com/",
"title": "Tech News",
"unread_count": 8
}Unsubscribe from feed
Unsubscribe from a feed. Miniflux deletes its entries too, starred ones included.
Inputs
- Feed
feedtextRequired - The feed: its name, ID or address.
Outputs
feed_urltext- Its address
idnumber- The feed's ID
titletext- Its title
unsubscribedtrue/false- Always true
Example output
{
"feed_url": "https://news.example.com/feed.xml",
"id": 12,
"title": "Tech News",
"unsubscribed": true
}