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 Branch API

The Branch API from TalentLMS — 5 operation(s) for branch.

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

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

This API exposes 9 operations across 5 paths. 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.

9 operations 5 paths 0 schemas 3 DELETE2 GET3 POST1 PUT

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 Branch 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 9

Across 5 paths, the API surfaces 9 operations — 3 DELETE, 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Branch 9
GET
/api/v2/branches
List all branches
1 param → 200
POST
/api/v2/branches
Create a branch
2 params body → 200
GET
/api/v2/branches/:id
Get a branch
1 param → 200
DELETE
/api/v2/branches/:id
Delete a branch
1 param → 200
POST
/api/v2/branch-users
Add user to branch
2 params body → 200
DELETE
/api/v2/branch-users
Remove user from branch
2 params → 200
POST
/api/v2/branch-courses
Add course to branch
2 params body → 200
DELETE
/api/v2/branch-courses
Remove course from branch
1 param → 200
PUT
/api/v2/branches/{id}/status
Change branch status
updateBranchStatus 3 params body → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

talentlms-branch-api-openapi.yml Raw ↑

Other APIs TalentLMS publishes across the network.

TalentLMS API
TalentLMS Batch Actions 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
TalentLMS User API