For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Help CenterAPI KeysStatusSign In
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
  • Introduction
    • Getting started
  • Email API
  • Transactional SMS
  • Transactional WhatsApp
  • Marketing Campaigns
  • Contact Management
  • Events
    • GETGet events
    • POSTCreate an event
    • POSTCreate events in batch
  • Object Management
  • Accounts and Settings
      • GETGet all external feeds
      • POSTCreate external feed
      • GETGet external feed details
      • PUTUpdate external feed
      • DELDelete external feed
  • Sales CRM
  • Conversations
  • Ecommerce
  • Loyalty
LogoLogo
Help CenterAPI KeysStatusSign In
Accounts and SettingsExternal Feeds

Get external feed details

GET
https://api.brevo.com/v3/feeds/:uuid
GET
/v3/feeds/:uuid
1import { BrevoClient } from "@getbrevo/brevo";
2
3async function main() {
4    const client = new BrevoClient({
5        apiKey: "YOUR_API_KEY_HERE",
6    });
7    await client.externalFeeds.getExternalFeedByUuid("b1c2d3e4-f5a6-47b8-89c0-d1e2f3a4b5c6");
8}
9main();
1{
2  "id": "b1c2d3e4-f5a6-47b8-89c0-d1e2f3a4b5c6",
3  "name": "Product Catalog Feed",
4  "url": "https://api.example.com/products",
5  "authType": "token",
6  "maxRetries": 3,
7  "cache": true,
8  "createdAt": "2025-09-18T13:29:27.208Z",
9  "modifiedAt": "2025-09-18T13:29:27.208Z",
10  "token": "abc123token456",
11  "headers": null
12}
Retrieves details of a specific external feed by its UUID. **Use this to:** - Get complete configuration of an external feed - Check feed authentication settings - Review feed personalization options - Verify feed URL and parameters - Monitor feed modification history **Key information returned:** - Complete feed configuration and settings - Authentication credentials and headers - Personalization and fallback settings - Creation and modification timestamps - Cache and retry configurations **Important considerations:** - UUID must exist in your account - Provides complete feed information for troubleshooting - Essential before making modifications - Shows current feed health status - Useful for debugging feed issues
Was this page helpful?
Previous

Update external feed

Next
Built with

Retrieves details of a specific external feed by its UUID.

Use this to:

  • Get complete configuration of an external feed
  • Check feed authentication settings
  • Review feed personalization options
  • Verify feed URL and parameters
  • Monitor feed modification history

Key information returned:

  • Complete feed configuration and settings
  • Authentication credentials and headers
  • Personalization and fallback settings
  • Creation and modification timestamps
  • Cache and retry configurations

Important considerations:

  • UUID must exist in your account
  • Provides complete feed information for troubleshooting
  • Essential before making modifications
  • Shows current feed health status
  • Useful for debugging feed issues

Authentication

api-keystring

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

Path parameters

uuidstringRequiredformat: "uuidv4"
UUID of the feed to fetch

Response

External feed details retrieved successfully
idstringformat: "uuidv4"
Unique identifier of the feed
namestring
Name of the feed
urlstringformat: "url"
URL of the external data source
authTypeenum
Authentication type for accessing the feed
Allowed values:
maxRetriesinteger1-5
Maximum number of retry attempts for failed requests
cacheboolean
Whether to cache the feed response
createdAtdatetime
Feed creation timestamp
modifiedAtdatetime
Feed last modification timestamp
usernamestring or null
Username for basic authentication. Only returned when authType is 'basic'. Excluded from response when authType is 'token'.
passwordstring or null
Password for basic authentication. Only returned when authType is 'basic'. Excluded from response when authType is 'token'.
tokenstring or null

Token for token-based authentication. Only returned when authType is ‘token’. Excluded from response when authType is ‘basic’ or ‘noAuth’.

headerslist of objects or null
Custom HTTP headers for the feed request

Errors

400
Bad Request Error
404
Not Found Error