Get all external feeds

GET

https://api.brevo.com/v3/feeds

GET

/v3/feeds

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.externalFeeds.getAllExternalFeeds({
        endDate: "2024-01-31",
        limit: 50,
        offset: 0,
        search: "product",
        startDate: "2024-01-01",
    });
}
main();

{
  "count": 18,
  "feeds": [
    {
      "id": "b1c2d3e4-f5a6-47b8-89c0-d1e2f3a4b5c6",
      "name": "Product Catalog Feed",
      "url": "https://api.example.com/products",
      "authType": "noAuth",
      "maxRetries": 3,
      "cache": true,
      "createdAt": "2025-09-18T13:29:27.208Z",
      "modifiedAt": "2025-09-18T13:29:27.208Z"
    },
    {
      "id": "c2d3e4f5-a6b7-48c9-90d1-e2f3a4b5c6d7",
      "name": "Blog News Feed",
      "url": "https://blog.example.com/api/posts",
      "authType": "token",
      "maxRetries": 3,
      "cache": true,
      "createdAt": "2025-09-17T16:03:25.826Z",
      "modifiedAt": "2025-09-17T16:03:25.826Z",
      "token": "abc123token456"
    },
    {
      "id": "d3e4f5a6-b7c8-49d0-91e2-f3a4b5c6d7e8",
      "name": "Public Data Feed",
      "url": "https://jsonplaceholder.typicode.com/posts",
      "authType": "basic",
      "maxRetries": 3,
      "cache": true,
      "createdAt": "2025-09-05T09:06:42.848Z",
      "modifiedAt": "2025-09-05T09:06:42.848Z",
      "username": "apiuser",
      "password": "apipass"
    }
  ]
}

Retrieves all external feeds from your Brevo account with filtering and pagination.

Use this to:

Get an overview of all external data feeds
Find feeds by name using search functionality
Filter feeds by creation date range
Browse feeds by authentication type
Monitor feed library organization and usage

Key information returned:

Feed details (UUID, name, URL, authentication type)
Feed configuration and settings
Creation and modification timestamps
Feed status and error information
Authentication and header configurations

Important considerations:

External feeds enable dynamic content in email campaigns
Feeds must be accessible from Brevo servers
Authentication credentials are securely stored
Feed performance affects campaign delivery
Use pagination for accounts with many feeds
Date range filtering limited to 30 days maximum
Search functionality works on feed name matching
Internal feeds are system-managed and cannot be modified

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app's client_id/client_secret for a short-lived Bearer token.

Query parameters

searchstringOptional

Can be used to filter records by search keyword on feed name

startDatedateOptional

Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than current date.

endDatedateOptional

Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.

sortenumOptionalDefaults to desc

Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed.

Allowed values:

authTypeenumOptional

Filter the records by authType of the feed.

Allowed values:

limitlongOptional1-500Defaults to 50

Number of documents returned per page.

offsetlongOptionalDefaults to 0

Index of the first document on the page.

Response

External feeds retrieved successfully

countinteger

Total number of feeds

feedslist of objects

List of external feeds

Errors

400

Bad Request Error

404

Not Found Error