RECENT UPDATES:
18-Nov-2026 | v7.13.1 | All new article.

Change Log

  • 18-Nov-2026 | v7.13.1 | All new article.

Contributors:

{
  "id": 2418,
  "name": "Adam Wilson",
  "url": "/adam-wilson"
}
Adam Wilson - Logo Pogo

RSS Feeds API

Create, Retrieve, Update and Delete internal and external RSS Feeds via the public API endpoint, with filtering by feed type and name.

The same validations and plan limits apply as in the admin, and responses include each feed's build status and last error details.

For details on how feeds work and what each setting does, see the RSS Feeds article.

GET RSS Feeds List

Retrieves a list of RSS Feeds as a JSON response based on your provided query parameters.

Omit the Type parameter to return both internal and external feeds. The Query parameter matches any part of the feed name and is not case-sensitive.

/api/v2/admin/rss-feeds

Parameters

Parameter
Values
Required
Type
External
Internal
Query
<search query>
Offset
<integer>
Limit
<integer>

Data / Response:

N/A
{
  "Items": [
    {
      "Id": 0,
      "Name": "string",
      "Type": "Internal",
      "Enabled": true,
      "FilePath": "string",
      "SourceUrl": "string",
      "ModuleId": 0,
      "LayoutName": "string",
      "ItemLimit": 0,
      "Frequency": "ManyTimesADay",
      "Description": "string",
      "Link": "string",
      "Status": "NotBuilt",
      "LastError": "string",
      "ShortError": "string",
      "LastUpdated": "2026-11-18T03:46:26.397Z",
      "LastBuildAt": "2026-11-18T03:46:26.397Z",
      "LiquidAlias": "string"
    }
  ],
  "TotalItemsCount": 0
}

POST RSS Feed Create

Creates a new RSS Feed based on the provided data.

The Type field sets whether the feed is Internal or External, and determines which other fields are used:

  • Internal - FilePath is the feed URL on your site and ModuleId is the ID of the source module. ItemLimit defaults to 100, and 0 removes the limit.
  • External - SourceUrl is the URL of the third-party feed and FilePath is the location the fetched feed is saved to in the File Manager. External feeds store a maximum of 500 entries.

The feed Name must be unique, and FilePath must end in .rss or .xml. The request is rejected if it would exceed the number of feeds allowed on the site's plan.

/api/v2/admin/rss-feeds

Data / Response:

{
  "Name": "string",
  "Type": "Internal",
  "Enabled": true,
  "FilePath": "string",
  "SourceUrl": "string",
  "ModuleId": 0,
  "LayoutName": "string",
  "ItemLimit": 100,
  "Frequency": "ManyTimesADay",
  "Description": "string",
  "Link": "string"
}
{
  "Id": 0,
  "Name": "string",
  "Type": "Internal",
  "Enabled": true,
  "FilePath": "string",
  "SourceUrl": "string",
  "ModuleId": 0,
  "LayoutName": "string",
  "ItemLimit": 0,
  "Frequency": "ManyTimesADay",
  "Description": "string",
  "Link": "string",
  "Status": "NotBuilt",
  "LastError": "string",
  "ShortError": "string",
  "LastUpdated": "2026-11-18T03:46:26.399Z",
  "LastBuildAt": "2026-11-18T03:46:26.399Z",
  "LiquidAlias": "string"
}

GET RSS Feed Item

Retrieves a single RSS Feed based on the ID passed in the endpoint URL.

Use the Status, LastBuildAt, ShortError and LastError fields to check whether the feed's most recent build or fetch was successful.

/api/v2/admin/rss-feeds/{id}

Data / Response:

N/A
{
  "Id": 0,
  "Name": "string",
  "Type": "Internal",
  "Enabled": true,
  "FilePath": "string",
  "SourceUrl": "string",
  "ModuleId": 0,
  "LayoutName": "string",
  "ItemLimit": 0,
  "Frequency": "ManyTimesADay",
  "Description": "string",
  "Link": "string",
  "Status": "NotBuilt",
  "LastError": "string",
  "ShortError": "string",
  "LastUpdated": "2026-11-18T03:46:26.401Z",
  "LastBuildAt": "2026-11-18T03:46:26.401Z",
  "LiquidAlias": "string"
}

PUT RSS Feed Update

Updates a single RSS Feed based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/rss-feeds/{id}

Data / Response:

{
  "Name": "string",
  "Type": "Internal",
  "Enabled": true,
  "FilePath": "string",
  "SourceUrl": "string",
  "ModuleId": 0,
  "LayoutName": "string",
  "ItemLimit": 100,
  "Frequency": "ManyTimesADay",
  "Description": "string",
  "Link": "string"
}
{
  "Id": 0,
  "Name": "string",
  "Type": "Internal",
  "Enabled": true,
  "FilePath": "string",
  "SourceUrl": "string",
  "ModuleId": 0,
  "LayoutName": "string",
  "ItemLimit": 0,
  "Frequency": "ManyTimesADay",
  "Description": "string",
  "Link": "string",
  "Status": "NotBuilt",
  "LastError": "string",
  "ShortError": "string",
  "LastUpdated": "2026-11-18T03:46:26.402Z",
  "LastBuildAt": "2026-11-18T03:46:26.402Z",
  "LiquidAlias": "string"
}

DELETE RSS Feed Delete

Deletes a single RSS Feed based on the ID passed in the endpoint URL.

/api/v2/admin/rss-feeds/{id}

Data / Response:

N/A
Status 204