Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TalentLMS User API

The User API from TalentLMS — 16 operation(s) for user.

TalentLMS User API is one of 12 APIs that TalentLMS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 20 operations across 16 paths, and defines 5 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://your-domain.talentlms.com.

20 operations 16 paths 5 schemas 2 DELETE13 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://{domain}.talentlms.com/api/v2
Authentication
API Key
Resource Areas
1

Authentication & Security 1

TalentLMS User API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (apikeyAuth). By default, every request must be authenticated.

Paths & Operations 20

Across 16 paths, the API surfaces 20 operations — 2 DELETE, 13 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

User 20
GET
/api/v2/users
Get users
getUsers 11 params → 200
POST
/api/v2/users
Create a user
2 params body → 200
GET
/api/v2/users/{id}
Get a user
getUserById 2 params → 200
PATCH
/api/v2/users/{id}
Update a user
2 params body → 200
DELETE
/api/v2/users/{id}
Delete a user
2 params → 200
GET
/api/v2/course-progress
Get user's course progress
4 params → 200
DELETE
/api/v2/course-progress
Reset user's course progress
3 params → 200
GET
/api/v2/user-fields
Get user custom fields
1 param → 200
GET
/api/v2/unit-progress
Get user's unit progress
3 params → 200
GET
/api/v2/users/:id/login
Login user
2 params → 200
POST
/api/v2/users/:id/logout
Logout user
2 params body → 200
GET
/api/v2/users/:id/online-status
Get user online status
1 param → 200
POST
/api/v2/password-reset
Reset user's password
3 params body → 200
POST
/api/v2/users/:email/username-recovery
Recover username
2 params body → 200
GET
/api/v2/users/{id}/groups
Get user groups
getUserGroups 2 params → 200
GET
/api/v2/users/{id}/branches
Get user branches
getUserBranches 2 params → 200
GET
/api/v2/users/{id}/courses
Get user courses
getUserCourses 2 params → 200
GET
/api/v2/users/{id}/resources
Get user resources
getUserResources 2 params → 200
GET
/api/v2/users/{id}/gamification
Get a user's gamification data
getUserGamification 2 params → 200404
GET
/api/v2/users/{id}/certificates
Get user certificates
getUserCertificates 2 params → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are UserListItem (14 properties), UserGamificationBadge (6 properties), PaginationLinks (5 properties), UserGamification (3 properties). Each schema is shown below with its type and property counts.

UserListItem
object
14 properties
PaginationMeta
object
1 property
UserGamificationBadge
object
6 properties 6 required
PaginationLinks
object
5 properties
UserGamification
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

talentlms-user-api-openapi.yml Raw ↑

Other APIs TalentLMS publishes across the network.

TalentLMS API
TalentLMS Batch Actions API
TalentLMS Branch API
TalentLMS Category API
TalentLMS Course API
TalentLMS Group API
TalentLMS Learning Paths API
TalentLMS Portal API
TalentLMS Task API
TalentLMS Timeline API
TalentLMS Unit API