About
This documentation describes the KC api (Version: v2 and v3). It provides details on the available endpoints for integrating with the KnowledgeCity platform.
Versioning
- Major version is set in the URL path, e.g.,
/integration/v1/.... - Minor version can be set via the request header
x-api-version: 2:- If the header is not set, the API returns the latest minor version.
- If the requested minor version is higher than the latest available, the API also returns the latest minor version.
- You should specify the minor version number for production code so the API endpoints will not change without notice.
- The minor version increments when any endpoint changes; other endpoints can change without notice.
Getting Started
Before using the API, please review the Authentication guide.
API Reference Sections
The API is organized into the following sections:
- Assignments (6)
- Categories (8)
- Certificates (1)
- Classes (3)
- Content providers (5)
- Courses (6)
- Groups (8)
- Learning paths (4)
- OAuth 2 (5)
- OpenAPI (1)
- Portal languages (1)
- Progress (2)
- Reports (11)
- Skills (2)
- Subscriptions (1)
- Users (13)
You can navigate these sections using the sidebar or the links above.