API Overview

Welcome to the LearnFlow REST API. This documentation provides everything you need to integrate our learning management system into your applications. Our API follows RESTful conventions, uses standard HTTP status codes, and returns JSON-encoded responses.

Authentication

All API requests must include an Authorization header with your API key. LearnFlow uses Bearer token authentication.

Authorization: Bearer YOUR_API_KEY

API keys can be generated from your Developer Dashboard. Keep your keys secure and never expose them in client-side code. Use environment variables for server-side applications.

Base URL & Format

All requests should be made to our production endpoint:

https://api.learnflow.com/v1

All requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Endpoints

Below are the core resources available through the LearnFlow API. Each endpoint supports standard filtering, sorting, and pagination parameters.

Courses

{
  "data": [
    {
      "id": "course_8x2k9d",
      "title": "Advanced React Patterns",
      "category": "Frontend",
      "level": "advanced",
      "duration_hours": 24,
      "price": { "amount": 4900, "currency": "USD" }
    }
  ],
  "meta": { "total": 142, "page": 1, "limit": 20 }
}

Students

{
  "email": "user@example.com",
  "name": "Alex Rivera",
  "role": "learner",
  "metadata": { "organization": "Acme Corp" }
}

Enrollments

Analytics

{
  "total_enrollments": 1248,
  "completion_rate": 0.78,
  "avg_time_on_platform": "4h 22m",
  "trending_courses": [
    { "id": "course_9s3k1", "enrollments_week": 142 }
  ]
}

Error Handling

LearnFlow uses conventional HTTP status codes to indicate the success or failure of a request. Codes in the 2xx range indicate success, 4xx indicate client errors, and 5xx indicate server errors.

Errors are returned as JSON with the following structure:

{
  "error": {
    "code": "invalid_request",
    "message": "Missing required parameter: student_id",
    "documentation_url": "https://docs.learnflow.com/errors#invalid_request"
  }
}

Common Error Codes

Rate Limits

To ensure platform stability, LearnFlow implements rate limiting on all API endpoints. Limits are applied per API key and reset on a rolling basis.

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 942
X-RateLimit-Reset: 1698765432 (Unix timestamp)

If you exceed the limit, you'll receive a 429 Too Many Requests response. Implement exponential backoff in your client to handle retries gracefully.

SDKs & Tools

Official and community-maintained libraries to accelerate your integration:

No official SDK for your language? The API is fully documented and RESTful, making it easy to integrate with any HTTP client. Consider contributing a community SDK!