Scholé Integration API · v1.0.0
Build on Scholé
A single REST API for machine-to-machine integrations, HR tooling, and BI dashboards. Provision users, manage teams, assign learning, and pull analytics — all documented in OpenAPI 3.1 and ready to generate typed clients in minutes.
60-Second Quick Start
Obtain a JWT Bearer token and list your company's users in two requests.
bash
# ① Obtain a JWT token
TOKEN=$(curl -sX POST https://app.schole.ai/auth/jwt/create/ \
-H "Content-Type: application/json" \
-d '{"email":"service@yourcompany.com","password":"••••••"}' \
| python3 -c "import sys,json; print(json.load(sys.stdin)['access'])")
# ② List users in your company
curl -sX GET https://app.schole.ai/api/v1/users/ \
-H "Authorization: Bearer $TOKEN" | python3 -m json.tool
For production M2M integrations, prefer OAuth2 Client Credentials — no human password needed.
Documentation
Getting Started
Authentication (JWT & OAuth2), base URLs, pagination, request conventions, and error handling.
Read guide
Interactive API Reference
OpenAPI 3.1 specification covering all 44 endpoints. Try calls directly from the browser with Swagger UI, or explore with ReDoc.
Open Swagger UI
SDK Generation
Auto-generate a fully typed client library in Python, Java, .NET, or JavaScript/TypeScript directly from the OpenAPI spec — no manual coding.
Generate stubs
Versioning & Lifecycle
URL versioning policy, deprecation timeline, decommission process, and how Scholé notifies you of breaking changes.
Read policy
Reseller Integration
End-to-end recipe for reselling Scholé courses inside your own LMS or marketplace — catalogue sync, SSO lesson launch, and completion tracking.
Follow guide
Base URLs
| Environment | Base URL | Notes |
|---|---|---|
| Production | https://app.schole.ai/api/v1/ |
OAuth2 enforced · TLS required |
API Coverage
Users
4 endpoints — provisioning, profiles, deactivation, bulk import
Teams
4 endpoints — CRUD, membership management
Skills
3 endpoints — catalog, assignment, user profiles
Curricula
4 endpoints — templates, user curricula
Assignments
4 endpoints — assign lessons, track progress
Analytics
7 endpoints — user & team learning metrics
Subscriptions
2 endpoints — status, access grants
Documents
3 endpoints — upload, list, detail
Surveys
4 endpoints — templates, sessions, results
HR
7 endpoints — employees, KPIs, audit logs