Developer Overview
The CurryCMS API provides programmatic access to curriculum content, enabling you to integrate structured educational materials into your learning management systems, mobile apps, or custom platforms.
What You Can Do
With the CurryCMS API, you can:
- List curricula available to your organization
- Retrieve curriculum structures with their full content hierarchy
- Access content nodes with lazy-loading for efficient tree traversal
- Get resolved content that merges inherited and variant-specific data
API Design
The API follows RESTful conventions with consistent response formatting:
| Aspect | Implementation |
|---|---|
| Format | JSON with consistent envelope structure |
| Authentication | Bearer token via Authorization header |
| Versioning | URL-based (/api/v1/...) |
| Pagination | Cursor-based for large collections |
| Caching | ETag support with 304 responses |
Response Format
All API responses follow this structure:
{
"status": "ok",
"data": { ... },
"meta": {
"children_count": 5,
"ancestry_depth": 2
},
"errors": []
}
Error responses use the same envelope with status: "error" and populated errors array.
Getting Started
- Create an API token in your account settings
- Follow the Quick Start guide to make your first API call
- Explore the full API Reference for all available endpoints
Rate Limits
API requests are rate-limited to ensure fair usage:
| Limit | Value |
|---|---|
| Requests per hour | 1,000 |
| Per token | Yes |
Rate limit status is returned in response headers. See Authentication for details.