6.2.1 Developer Guide — APIs — CMS Public API — Content Delivery

The CMS Public API provides a stable, read-optimized interface for delivering published content to external consumers such as websites, applications, and services. The API is designed for performance, cacheability, and strict isolation while preserving localization and structured relations.

API Scope and Guarantees

The Public API is read-only and exposes only published, publicly accessible content.

Guarantees:

No write operations

Deterministic responses

Backward-compatible versions

Unauthorized or draft data is never exposed.

Endpoint Structure

Endpoints are resource-oriented and predictable. Versioning is explicit to prevent breaking changes.

Typical structure:

/api/v1/content-types

/api/v1/entries/{type}

/api/v1/entries/{type}/{id}

Filtering and Querying

The API supports structured filtering using array-style query parameters to enable precise selection without custom endpoints.

Supported filters:

Field equality and inclusion

Date ranges

Relation presencenExample request:

GET /api/v1/entries/articles?filter[status]=published&filter[category][]=news

Localization and Language Handling

Localization is first-class. Clients may request content in a specific locale with predictable fallback behavior.

Localization behavior:

Explicit locale parameter

Fallback to default language when allowed

Locale-aware relations

Example localized request:

GET /api/v1/entries/articles?locale=nl

Pagination and Limits

Responses are paginated to protect performance and ensure consistent payload sizes.

Pagination rules:

Cursor or page-based pagination

Configurable page size caps

Stable ordering

Example pagination:

GET /api/v1/entries/articles?page=2&per_page=20

Relationships and Includes

Related entities may be included explicitly to reduce round-trips.

Include behavior:

Explicit opt-in via include parameter

Depth-limited expansion

Locale-consistent relations

Example include:

GET /api/v1/entries/articles?include=author,media

Caching and Performance

Responses are cache-friendly and may include cache headers suitable for CDN usage.

Performance features:

ETag support

Conditional requests

Deterministic response shapes

Error Handling

Errors are returned with consistent structures and HTTP status codes.

Error guarantees:

No internal details leaked

Stable error codes

Machine-readable responses

Security and Isolation

Public API access is tenant-scoped and rate-limited. Even public data is resolved within tenant context and cannot cross boundaries.