D
DeepLMS/API Documentation
Back to App

API Reference

The DeepLMS REST API lets you integrate your institution's LMS data with external systems. Available on Professional and Enterprise plans. All requests require authentication via API key.

Quick Start

Generate your API key in Settings → API Keys, then include it in your requests:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://your-school.deeplms.ai/api/v1/users
Base URL: https://{slug}.deeplms.ai/api/v1Rate limit: 100 req/minFormat: JSON
OpenAPI JSONTypeScript SDK
POST/api/v1/auth/token

Exchange API key for a JWT bearer token (valid 1 hour).

Parameters

api_keystringrequiredYour institution API key

Response

{ "token": "eyJ...", "expires_at": "2026-03-25T14:00:00Z" }

HTTP Status Codes

200 Success
201 Created
400 Bad Request
401 Unauthorized
403 Forbidden (plan restriction)
404 Not Found
429 Rate Limited
500 Server Error

TypeScript SDK

The first-party TypeScript client is exported from src/lib/sdk/deeplms-client.ts for server-side integrations and internal tools.

import { DeepLmsClient } from "@/lib/sdk/deeplms-client";

const client = new DeepLmsClient({
  baseUrl: "https://your-school.deeplms.ai",
  apiKey: process.env.DEEPLMS_API_KEY!,
});

const courses = await client.listCourses({ limit: 20 });