Feed API Documentation

Public API for accessing published content

Overview

The Feed API provides read-only access to published resources from any FlareBuilder organization. This public API requires no authentication and supports CORS for client-side access.

Base URL

https://{tenant-slug}.flarebuilder.com/api/feed

Query Parameters

Parameter Type Description Example
limit integer Number of resources to return (default: 10, max: 100) ?limit=25
offset integer Number of resources to skip (default: 0) ?offset=20
tags string Comma-separated list of tag names (OR logic) ?tags=news,events
types string Comma-separated list of template names ?types=article,announcement
status string Filter by status: active, scheduled, expired ?status=active

Response Format

{ "title": "Organization Name Feed", "feed_url": "https://tenant.flarebuilder.com/api/feed", "home_page_url": "https://tenant.flarebuilder.com", "resources": [ { "id": "resource-123", "title": "Getting Started with FlareBuilder", "content": "<p>Welcome to FlareBuilder...</p>", "description": "Learn the basics", "image": "https://assets.flarebuilder.com/...", "date_published": "2024-01-15T10:00:00Z", "date_created": "2024-01-14T15:30:00Z", "date_modified": "2024-01-15T09:45:00Z", "template": { "name": "Article", "icon": "mdi-file-document" }, "tags": ["getting-started", "tutorial"], "author": { "name": "John Doe", "email": "john@example.com" } } ], "meta": { "total": 150, "limit": 10, "offset": 0, "generated_at": "2024-01-15T12:00:00Z" } }

JavaScript Example

// Fetch recent articles fetch('https://your-org.flarebuilder.com/api/feed?tags=articles&limit=5') .then(response => response.json()) .then(data => { data.resources.forEach(resource => { console.log(resource.title, resource.date_published); }); }) .catch(error => console.error('Error:', error));

Best Practices

  • Caching: Responses are cached for 5 minutes. Use ETag headers for conditional requests.
  • Rate Limiting: No rate limits currently, but please be respectful with request frequency.
  • Pagination: Use limit and offset for large datasets rather than fetching all resources.
  • Error Handling: Always check response status and handle network errors gracefully.