FreshRSS

App · 19 actions

Work with your feeds in FreshRSS: find, read, star, label and mark articles, subscribe to and organise feeds, manage categories and labels, and start a workflow when a new article arrives, or when one is starred or labelled.

Actions

ActionWhat it does
Add or remove a labelPut a label on one or more articles, or take it off.
Delete categoryDelete a category.
Delete labelDelete a label, taking it off every article that has it.
Export feeds as OPMLGet all your feeds and their categories as the text of an OPML file, the format feed readers exchange subscriptions in, such as for a backup.
Find articlesFind articles: all, unread or read, starred only, from one feed, category or label, newest or oldest first, since a time, with their content as text and HTML.
Get articlesGet one or more articles by ID, with their content as text and HTML, whether they're read, starred, and their labels.
Get unread countsGet how many articles are unread in all, and in each feed, category and label.
Import feeds from OPMLSubscribe to the feeds in an OPML file, in the categories it puts them in.
List categoriesList your categories, with how many feeds and unread articles each has.
List feedsList the feeds you're subscribed to, with their categories, unread counts and when their newest article arrived.
List labelsList the labels you put on articles, with how many unread articles each has.
Mark all as readMark every article in one feed, one category or one label as read, optionally only those received before a time.
Mark articles read or unreadMark one or more articles read or unread, such as the ones a workflow has just posted or summarised.
Rename categoryGive a category a new name.
Rename labelGive a label a new name.
Rename or move feedGive a feed a new name, move it to another category, or both.
Star or unstar articlesStar one or more articles to keep them among your favourites, or take their stars off.
Subscribe to feedSubscribe to a feed by its address, with a name and a category of your choice.
Unsubscribe from feedUnsubscribe from a feed.

Add or remove a label

Put a label on one or more articles, or take it off. A label that doesn't exist yet is made when it's added.

Inputs

ArticlesarticleslistRequired
The articles' IDs, such as the IDs from 'Find articles' or the ID from a trigger. Up to 500 at a time.
LabellabeltextRequired
The label's name. To add a new one, type its name.
Add or removechangetext
Whether to put the label on or take it off.One of: add, remove. Default: add.

Outputs

article_idslist
The IDs of the articles changed
countnumber
How many articles were changed
labeltext
The label's name
labelledtrue/false
True when the label was added, false when it was removed
not_foundlist
The IDs FreshRSS has no article for; empty when it has all
Example output
{
  "article_ids": [
    "1794876606233638"
  ],
  "count": 1,
  "label": "To share",
  "labelled": true,
  "not_found": []
}

Delete category

Delete a category. Its feeds are kept: FreshRSS moves them to Uncategorized.

Inputs

CategorycategorytextRequired
The category's name.

Outputs

deletedtrue/false
Always true
feeds_movednumber
How many feeds it had, now in Uncategorized
nametext
The category's name
Example output
{
  "deleted": true,
  "feeds_moved": 4,
  "name": "Tech"
}

Delete label

Delete a label, taking it off every article that has it. The articles are kept.

Inputs

LabellabeltextRequired
The label's name.

Outputs

deletedtrue/false
Always true
nametext
The label's name
Example output
{
  "deleted": true,
  "name": "To share"
}

Export feeds as OPML

Get all your feeds and their categories as the text of an OPML file, the format feed readers exchange subscriptions in, such as for a backup.

Inputs

None.

Outputs

feed_countnumber
How many feeds are in it
file_nametext
A name to save it under
opmltext
Your feeds and their categories as the text of an OPML file
Example output
{
  "feed_count": 1,
  "file_name": "freshrss-alice.opml.xml",
  "opml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<opml version=\"2.0\">\n  <head><title>FreshRSS</title></head>\n  <body>\n    <outline text=\"Tech\">\n      <outline text=\"Tech News\" type=\"rss\" xmlUrl=\"https://news.example.com/feed.xml\" htmlUrl=\"https://news.example.com/\"/>\n    </outline>\n  </body>\n</opml>\n"
}

Find articles

Find articles: all, unread or read, starred only, from one feed, category or label, newest or oldest first, since a time, with their content as text and HTML. Pass 'continuation' on to get the next ones.

Inputs

Read or unreadstatustext
Which articles to find.One of: all, unread, read. Default: all.
Starred onlystarredtrue/false
Only articles you've starred (your favourites).
Feedfeedtext
Only articles from this feed. Leave blank for every feed. Choose a feed, a category or a label, not two of them.
Categorycategorytext
Only articles from feeds in this category.
Labellabeltext
Only articles you've put this label on.
Sincesincedate and time
Only articles FreshRSS received, or saw their feed change, after this time.
Orderordertext
Which come first, by when FreshRSS received them.One of: newest (Newest first), oldest (Oldest first). Default: newest.
How manylimitnumber
The most to list, up to 100. Defaults to 25.From 1 to 100.
Continue aftercontinuationtext
The 'continuation' an earlier 'Find articles' step with the same choices returned, to get the articles after those.

Outputs

articleslist
The articles found
continuationtext
Pass this to another 'Find articles' step to get the ones after these; empty when these were the last. FreshRSS also gives one when it sent as many as asked for and no more follow: the next step then finds none
countnumber
How many articles are listed
Example output
{
  "articles": [
    {
      "author": "Jane Doe",
      "category": "Tech",
      "content": "The Kubernetes project shipped version 2.0.",
      "content_html": "<p>The <b>Kubernetes</b> project shipped version 2.0.</p>",
      "feed": "Tech News",
      "feed_id": 12,
      "feed_url": "https://news.example.com/feed.xml",
      "id": "1794876606233638",
      "labels": [
        "To share"
      ],
      "link": "https://rss.example.com/i/?a=normal&state=3&search=e:1794876606233638",
      "media": [],
      "published_at": "2026-11-02T10:00:00Z",
      "received_at": "2026-11-02T10:05:12Z",
      "site_url": "https://news.example.com/",
      "starred": false,
      "status": "unread",
      "tags": [
        "Cloud"
      ],
      "title": "Kubernetes 2.0 released",
      "url": "https://news.example.com/kubernetes-2"
    }
  ],
  "continuation": "",
  "count": 1
}

Get articles

Get one or more articles by ID, with their content as text and HTML, whether they're read, starred, and their labels.

Inputs

ArticlesarticleslistRequired
The articles' IDs, such as the IDs from 'Find articles' or the ID from a trigger. Up to 500 at a time.

Outputs

articleslist
The articles, in the order asked for
countnumber
How many articles are listed
not_foundlist
The IDs FreshRSS has no article for; empty when it has all
Example output
{
  "articles": [
    {
      "author": "Jane Doe",
      "category": "Tech",
      "content": "The Kubernetes project shipped version 2.0.",
      "content_html": "<p>The <b>Kubernetes</b> project shipped version 2.0.</p>",
      "feed": "Tech News",
      "feed_id": 12,
      "feed_url": "https://news.example.com/feed.xml",
      "id": "1794876606233638",
      "labels": [
        "To share"
      ],
      "link": "https://rss.example.com/i/?a=normal&state=3&search=e:1794876606233638",
      "media": [],
      "published_at": "2026-11-02T10:00:00Z",
      "received_at": "2026-11-02T10:05:12Z",
      "site_url": "https://news.example.com/",
      "starred": false,
      "status": "unread",
      "tags": [
        "Cloud"
      ],
      "title": "Kubernetes 2.0 released",
      "url": "https://news.example.com/kubernetes-2"
    }
  ],
  "count": 1,
  "not_found": []
}

Get unread counts

Get how many articles are unread in all, and in each feed, category and label.

Inputs

None.

Outputs

categorieslist
Each category's unread articles, most first
feedslist
Each feed's unread articles, most first
labelslist
Each label's unread articles, most first
totalnumber
How many articles are unread in all
Example output
{
  "categories": [
    {
      "name": "Tech",
      "unread_count": 17
    }
  ],
  "feeds": [
    {
      "category": "Tech",
      "id": 12,
      "title": "Tech News",
      "unread_count": 8
    }
  ],
  "labels": [
    {
      "name": "To share",
      "unread_count": 2
    }
  ],
  "total": 17
}

Import feeds from OPML

Subscribe to the feeds in an OPML file, in the categories it puts them in. Feeds already subscribed to are left as they are.

Inputs

OPMLopmltextRequired
The text of an OPML file, such as one exported from another feed reader or by 'Export feeds as OPML'.

Outputs

countnumber
How many feeds were newly subscribed to
feedslist
The feeds newly subscribed to
feeds_in_filenumber
How many feeds the file lists
Example output
{
  "count": 1,
  "feeds": [
    {
      "category": "Tech",
      "feed_url": "https://news.example.com/feed.xml",
      "icon_url": "https://rss.example.com/f.php?h=80df645c",
      "id": 12,
      "link": "https://rss.example.com/i/?get=f_12",
      "newest_article_at": "2026-11-02T10:05:12Z",
      "site_url": "https://news.example.com/",
      "title": "Tech News",
      "unread_count": 8
    }
  ],
  "feeds_in_file": 3
}

List categories

List your categories, with how many feeds and unread articles each has.

Inputs

None.

Outputs

categorieslist
The categories, by name
countnumber
How many categories are listed
Example output
{
  "categories": [
    {
      "feed_count": 4,
      "name": "Tech",
      "newest_article_at": "2026-11-02T10:05:12Z",
      "unread_count": 17
    }
  ],
  "count": 1
}

List feeds

List the feeds you're subscribed to, with their categories, unread counts and when their newest article arrived.

Inputs

Categorycategorytext
Only feeds in this category. Leave blank for every feed.

Outputs

countnumber
How many feeds are listed
feedslist
The feeds, by name
Example output
{
  "count": 1,
  "feeds": [
    {
      "category": "Tech",
      "feed_url": "https://news.example.com/feed.xml",
      "icon_url": "https://rss.example.com/f.php?h=80df645c",
      "id": 12,
      "link": "https://rss.example.com/i/?get=f_12",
      "newest_article_at": "2026-11-02T10:05:12Z",
      "site_url": "https://news.example.com/",
      "title": "Tech News",
      "unread_count": 8
    }
  ]
}

List labels

List the labels you put on articles, with how many unread articles each has.

Inputs

None.

Outputs

countnumber
How many labels are listed
labelslist
The labels, by name
Example output
{
  "count": 1,
  "labels": [
    {
      "name": "To share",
      "newest_article_at": "2026-11-02T10:05:12Z",
      "unread_count": 2
    }
  ]
}

Mark all as read

Mark every article in one feed, one category or one label as read, optionally only those received before a time.

Inputs

Feedfeedtext
The feed to mark as read. Choose a feed, a category or a label.
Categorycategorytext
The category whose feeds to mark as read.
Labellabeltext
The label whose articles to mark as read.
Received beforereceived_beforedate and time
Only articles FreshRSS received before this time, so ones that arrive while a workflow runs stay unread. Leave blank for all of them.

Outputs

marked_readnumber
How many unread articles were marked read
nametext
Its name
scopetext
What was marked: feed, category or label
unread_countnumber
How many of its articles are still unread
Example output
{
  "marked_read": 8,
  "name": "Tech News",
  "scope": "feed",
  "unread_count": 0
}

Mark articles read or unread

Mark one or more articles read or unread, such as the ones a workflow has just posted or summarised.

Inputs

ArticlesarticleslistRequired
The articles' IDs, such as the IDs from 'Find articles' or the ID from a trigger. Up to 500 at a time.
Mark asstatustext
Read or unread.One of: read, unread. Default: read.

Outputs

article_idslist
The IDs of the articles changed
countnumber
How many articles were marked
not_foundlist
The IDs FreshRSS has no article for; empty when it has all
statustext
What they were marked: read or unread
Example output
{
  "article_ids": [
    "1794876606233638",
    "1794876606233639"
  ],
  "count": 2,
  "not_found": [],
  "status": "read"
}

Rename category

Give a category a new name. Its feeds stay in it.

Inputs

CategorycategorytextRequired
The category's name.
New namenew_nametextRequired
The category's new name. No other category or label may have it.

Outputs

feed_countnumber
How many feeds are in it
nametext
The category's name
newest_article_attext
When FreshRSS received its newest article (ISO 8601); empty when it has none
previous_nametext
The name it had before
unread_countnumber
How many unread articles its feeds have
Example output
{
  "feed_count": 4,
  "name": "Technology",
  "newest_article_at": "2026-11-02T10:05:12Z",
  "previous_name": "Tech",
  "unread_count": 17
}

Rename label

Give a label a new name. The articles that have it keep it.

Inputs

LabellabeltextRequired
The label's name.
New namenew_nametextRequired
The label's new name. No other label or category may have it.

Outputs

nametext
The label's name
newest_article_attext
When FreshRSS received the newest article with it (ISO 8601); empty when no article has it
previous_nametext
The name it had before
unread_countnumber
How many unread articles have it
Example output
{
  "name": "Shared",
  "newest_article_at": "2026-11-02T10:05:12Z",
  "previous_name": "To share",
  "unread_count": 2
}

Rename or move feed

Give a feed a new name, move it to another category, or both.

Inputs

FeedfeedtextRequired
The feed: its name, ID or address.
New nametitletext
What to call the feed. Leave blank to keep its name.
Move to categorycategorytext
The category to move it to. One that doesn't exist yet is made. Leave blank to leave it where it is.

Outputs

categorytext
Its category
feed_urltext
The feed's address
icon_urltext
The address of its icon
idnumber
The feed's ID
linktext
A link to it in FreshRSS
newest_article_attext
When FreshRSS received its newest article (ISO 8601); empty when it has none
site_urltext
The address of its website
titletext
Its name
unread_countnumber
How many of its articles are unread
Example output
{
  "category": "Tech",
  "feed_url": "https://news.example.com/feed.xml",
  "icon_url": "https://rss.example.com/f.php?h=80df645c",
  "id": 12,
  "link": "https://rss.example.com/i/?get=f_12",
  "newest_article_at": "2026-11-02T10:05:12Z",
  "site_url": "https://news.example.com/",
  "title": "Tech News",
  "unread_count": 8
}

Star or unstar articles

Star one or more articles to keep them among your favourites, or take their stars off. One already as asked is left as it is.

Inputs

ArticlesarticleslistRequired
The articles' IDs, such as the IDs from 'Find articles' or the ID from a trigger. Up to 500 at a time.
Star or unstarstarredtext
Whether to star them or take their stars off.One of: star, unstar. Default: star.

Outputs

article_idslist
The IDs of the articles changed
countnumber
How many articles were changed
not_foundlist
The IDs FreshRSS has no article for; empty when it has all
starredtrue/false
Whether they are now starred
Example output
{
  "article_ids": [
    "1794876606233638"
  ],
  "count": 1,
  "not_found": [],
  "starred": true
}

Subscribe to feed

Subscribe to a feed by its address, with a name and a category of your choice. A feed already subscribed to is left as it is.

Inputs

Feed addressurltextRequired
The feed's address, such as https://example.com/feed.xml.
Nametitletext
What to call the feed. Leave blank for the feed's own title.
Categorycategorytext
The category to put it in. One that doesn't exist yet is made. Leave blank for Uncategorized.

Outputs

already_subscribedtrue/false
Whether the feed was already there
categorytext
Its category
feed_urltext
The feed's address
icon_urltext
The address of its icon
idnumber
The feed's ID
linktext
A link to it in FreshRSS
newest_article_attext
When FreshRSS received its newest article (ISO 8601); empty when it has none
site_urltext
The address of its website
titletext
Its name
unread_countnumber
How many of its articles are unread
Example output
{
  "already_subscribed": false,
  "category": "Tech",
  "feed_url": "https://news.example.com/feed.xml",
  "icon_url": "https://rss.example.com/f.php?h=80df645c",
  "id": 12,
  "link": "https://rss.example.com/i/?get=f_12",
  "newest_article_at": "2026-11-02T10:05:12Z",
  "site_url": "https://news.example.com/",
  "title": "Tech News",
  "unread_count": 8
}

Unsubscribe from feed

Unsubscribe from a feed. FreshRSS deletes its articles too, starred ones included.

Inputs

FeedfeedtextRequired
The feed: its name, ID or address.

Outputs

feed_urltext
Its address
idnumber
The feed's ID
titletext
Its name
unsubscribedtrue/false
Always true
Example output
{
  "feed_url": "https://news.example.com/feed.xml",
  "id": 12,
  "title": "Tech News",
  "unsubscribed": true
}

On this page