Learn LMS API v2 - Catalog API
Please read the following article to understand the 2 API methods available within the HR Learn that will enable you to search catalogs and get a catalog.
Please read the following article to understand the 2 API methods available within the HR Learn that will enable you to search catalogs and get a catalog. The Catalog API performs actions related to catalogs in the HR Learn LMS. The following methods are available via this API:
- Search catalogs
- Get catalog details
- Get Children
Search catalogs
|
HTTP Action |
POST |
|||||||||
|
Base URL |
https://[Your HR Learn LMS Portal URL] |
|||||||||
|
Endpoint URL |
/api/catalog/v2/search |
|||||||||
|
Request Parameters |
Example: { "Type": "name", "SearchParam": "My Catalog" }
|
|||||||||
|
Response |
An array of catalog objects matching the search criteria. Example: [ { "IdCatalog": 3, "IdSite": 2, "IdParent": null, "Title": "My Catalog", "Order": null, "ShortDescription": "My Catalog", "LongDescription": null, "IsPublished": null, "IsPrivate": false, "CalculatedCost": 0.0, "IsClosed": false, "DtCreated": "2021-05-04T20:31:06.847Z", "DtModified": "2021-05-04T20:31:06.847Z", "SearchTags": null, "NumberEnrollableCourses": 1, "NumberEnrollableLearningPaths": 0, "LanguageSpecificProperties": [ { "LangString": "en-US", "Title": "My Catalog", "ShortDescription": "My Catalog", "LongDescription": "", "SearchTags": "" } ], "Avatar": null, "Shortcode": null } ]
|
Get catalog details
|
HTTP Action |
GET |
|
Base URL |
https://[Your HR Learn LMS Portal URL] |
|
Endpoint URL |
/api/catalog/v2/{id} |
|
Request Parameters |
NONE |
|
Response |
A catalog object matching the {id} of the catalog. Example: { "IdCatalog": 3, "IdSite": 2, "IdParent": null, "Title": "My Catalog", "Order": null, "ShortDescription": "My Catalog", "LongDescription": null, "IsPublished": null, "IsPrivate": false, "CalculatedCost": 0.0, "IsClosed": false, "DtCreated": "2021-05-04T20:30:15.57Z", "DtModified": "2021-05-04T20:30:15.57Z", "SearchTags": null, "NumberEnrollableCourses": 1, "NumberEnrollableLearningPaths": 0, "LanguageSpecificProperties": [ { "LangString": "en-US", "Title": "My Catalog", "ShortDescription": "My Catalog", "LongDescription": "", "SearchTags": "" } ], "Avatar": null, "Shortcode": null }
|
Get Children
| HTTP Action | GET |
| Base URL | https://[Your HRLearnLMS Portal URL] |
| Endpoint URL | /api/catalog/v2/{id}/getchildren |
| Request Parameters | NONE |
| Response |
A list of courses, learning paths, and catalogs within the specified catalog. { "catalogs": [ { "IdCatalog": 6, "IdSite": 2, "IdParent": 2, "ParentObjectType": null, "Title": "Children Catalog", "Order": null, "ShortDescription": "Children Catalog", "LongDescription": "<p>Children Catalog</p>\n", "IsPublished": null, "IsPrivate": false, "CalculatedCost": 0.0, "IsClosed": false, "DtCreated": "2026-03-16T10:58:07.92Z", "DtModified": "2026-03-16T10:58:07.92Z", "SearchTags": "", "NumberEnrollableCourses": 0, "NumberEnrollableLearningPaths": 0, "LanguageSpecificProperties": [ { "LangString": "en-US", "Title": "Children Catalog", "ShortDescription": "Children Catalog", "LongDescription": "<p>Children Catalog</p>\n", "SearchTags": "" } ], "Avatar": null, "Shortcode": "Children C", "Type": null, "IdObject": 0, "NumberEnrollableCatalog": 1, "IsAccessible": false, "IsLocked": false, "Rating": 0, "Credits": 0, "IsCallerEnrolled": false, "IsMultipleSelfEnrollmentEligible": false } ], "courses": [ { "Id": 6, "IdSite": 2, "Title": ".NET Quick Refresh – Key Updates", "CourseCode": "CRS-DOTNET-REFRESH-101", "RevCode": "6MLDE79F867LM5M56FI69CH6E88EAI69", "Avatar": "avatar.jpg", "Cost": null, "MaximumQuantity": null, "Credits": 0.25, "EstimatedLengthInMinutes": 10, "ShortDescription": "A quick 10-minute refresher covering key .NET updates, best practices, and essential concepts.", "LongDescription": "<p>This short course provides a fast refresher on essential .NET concepts and recent updates. Designed for busy learners, it highlights important changes, best practices, and reminders to keep skills current in just 10 minutes.</p>\n", "Objectives": "<p>Review key .NET concepts quickly</p>\n\n<p>Understand recent .NET updates</p>\n\n<p>Refresh best practices</p>\n\n<p>Stay current with minimal time investment</p>\n", "IsPublished": true, "IsClosed": false, "IsLocked": false, "IsPrerequisiteAny": false, "IsFeedActive": true, "IsFeedModerated": false, "IsFeedOpenSubscription": false, "DtCreated": "2026-02-16T10:29:24.803Z", "DtModified": "2026-03-24T12:17:19.817Z", "IsDeleted": false, "DtDeleted": null, "Order": 3, "DisallowRating": false, "Rating": null, "Votes": null, "ForceLessonCompletionInOrder": false, "RequireFirstLessonToBeCompletedBeforeOthers": false, "LockLastLessonUntilOthersCompleted": false, "SelfEnrollmentIsOneTimeOnly": false, "SelfEnrollmentDueInterval": null, "SelfEnrollmentDueTimeframe": null, "SelfEnrollmentExpiresFromStartInterval": null, "SelfEnrollmentExpiresFromStartTimeframe": null, "SelfEnrollmentExpiresFromFirstLaunchInterval": null, "SelfEnrollmentExpiresFromFirstLaunchTimeframe": null, "SearchTags": ".net, dotnet, c#, quick refresh, microlearning, short course, developer", "IsCallingUserEnrolled": false, "IsMultipleSelfEnrollmentEligible": true, "LanguageSpecificProperties": [ { "LangString": "en-US", "Title": ".NET Quick Refresh – Key Updates", "ShortDescription": "A quick 10-minute refresher covering key .NET updates, best practices, and essential concepts.", "LongDescription": "<p>This short course provides a fast refresher on essential .NET concepts and recent updates. Designed for busy learners, it highlights important changes, best practices, and reminders to keep skills current in just 10 minutes.</p>\n", "Objectives": "<p>Review key .NET concepts quickly</p>\n\n<p>Understand recent .NET updates</p>\n\n<p>Refresh best practices</p>\n\n<p>Stay current with minimal time investment</p>\n", "SearchTags": ".net, dotnet, c#, quick refresh, microlearning, short course, developer" } ], "SocialMediaProperties": [], "IsSelfEnrollmentApprovalRequired": false, "IsApprovalAllowedByCourseExperts": false, "IsApprovalAllowedByUserSupervisor": false, "Shortcode": "DOTNET-QR-", "IsSelfEnrollmentLockedByPrerequisites": false, "IsSelfEnrollmentDrop": false, "IdParent": null, "CourseSharedScope": [], "AllowCopy": true, "AdvancedPrerequisitePattern": null }, { "Id": 3, "IdSite": 2, "Title": "Introduction to .NET Development", "CourseCode": "CRS-DOTNET-101", "RevCode": "A66B8LDLH676766J6H698A8K68KJ8K7F", "Avatar": "avatar.jpg", "Cost": null, "MaximumQuantity": null, "Credits": 3.0, "EstimatedLengthInMinutes": 10, "ShortDescription": "This course introduces the fundamentals of .NET development, covering core concepts, C# basics, and application structure.", "LongDescription": "<p>The Introduction to .NET Development course is designed for beginners who want to build applications using the .NET framework. The course covers C# fundamentals, .NET architecture, project structure, and basic application development. Learners will gain hands-on experience creating simple console and web applications using best practices.</p>\n", "Objectives": "<ul>\n\t<li data-end=\"1155\" data-start=\"1118\">\n\t<p data-end=\"1155\" data-start=\"1120\"><code data-end=\"1155\" data-start=\"1120\">Understand .NET and its ecosystem</code></p>\n\t</li>\n\t<li data-end=\"1193\" data-start=\"1156\">\n\t<p data-end=\"1193\" data-start=\"1158\"><code data-end=\"1193\" data-start=\"1158\">Learn C# programming fundamentals</code></p>\n\t</li>\n\t<li data-end=\"1228\" data-start=\"1194\">\n\t<p data-end=\"1228\" data-start=\"1196\"><code data-end=\"1228\" data-start=\"1196\">Build simple .NET applications</code></p>\n\t</li>\n\t<li data-end=\"1275\" data-start=\"1229\">\n\t<p data-end=\"1275\" data-start=\"1231\"><code data-end=\"1275\" data-start=\"1231\">Understand project structure and libraries</code></p>\n\t</li>\n\t<li data-end=\"1312\" data-start=\"1276\">\n\t<p data-end=\"1312\" data-start=\"1278\"><code data-end=\"1312\" data-start=\"1278\">Apply basic debugging techniques</code></p>\n\t</li>\n</ul>\n", "IsPublished": true, "IsClosed": false, "IsLocked": false, "IsPrerequisiteAny": false, "IsFeedActive": true, "IsFeedModerated": false, "IsFeedOpenSubscription": false, "DtCreated": "2026-02-16T05:20:29.503Z", "DtModified": "2026-02-19T10:15:35.253Z", "IsDeleted": false, "DtDeleted": null, "Order": 1, "DisallowRating": false, "Rating": null, "Votes": null, "ForceLessonCompletionInOrder": false, "RequireFirstLessonToBeCompletedBeforeOthers": false, "LockLastLessonUntilOthersCompleted": false, "SelfEnrollmentIsOneTimeOnly": false, "SelfEnrollmentDueInterval": null, "SelfEnrollmentDueTimeframe": null, "SelfEnrollmentExpiresFromStartInterval": null, "SelfEnrollmentExpiresFromStartTimeframe": null, "SelfEnrollmentExpiresFromFirstLaunchInterval": null, "SelfEnrollmentExpiresFromFirstLaunchTimeframe": null, "SearchTags": ".net, dotnet, c#, programming, backend, software development", "IsCallingUserEnrolled": false, "IsMultipleSelfEnrollmentEligible": true, "LanguageSpecificProperties": [ { "LangString": "en-US", "Title": "Introduction to .NET Development", "ShortDescription": "This course introduces the fundamentals of .NET development, covering core concepts, C# basics, and application structure.", "LongDescription": "<p>The Introduction to .NET Development course is designed for beginners who want to build applications using the .NET framework. The course covers C# fundamentals, .NET architecture, project structure, and basic application development. Learners will gain hands-on experience creating simple console and web applications using best practices.</p>\n", "Objectives": "<ul>\n\t<li data-end=\"1155\" data-start=\"1118\">\n\t<p data-end=\"1155\" data-start=\"1120\"><code data-end=\"1155\" data-start=\"1120\">Understand .NET and its ecosystem</code></p>\n\t</li>\n\t<li data-end=\"1193\" data-start=\"1156\">\n\t<p data-end=\"1193\" data-start=\"1158\"><code data-end=\"1193\" data-start=\"1158\">Learn C# programming fundamentals</code></p>\n\t</li>\n\t<li data-end=\"1228\" data-start=\"1194\">\n\t<p data-end=\"1228\" data-start=\"1196\"><code data-end=\"1228\" data-start=\"1196\">Build simple .NET applications</code></p>\n\t</li>\n\t<li data-end=\"1275\" data-start=\"1229\">\n\t<p data-end=\"1275\" data-start=\"1231\"><code data-end=\"1275\" data-start=\"1231\">Understand project structure and libraries</code></p>\n\t</li>\n\t<li data-end=\"1312\" data-start=\"1276\">\n\t<p data-end=\"1312\" data-start=\"1278\"><code data-end=\"1312\" data-start=\"1278\">Apply basic debugging techniques</code></p>\n\t</li>\n</ul>\n", "SearchTags": ".net, dotnet, c#, programming, backend, software development" } ], "SocialMediaProperties": [], "IsSelfEnrollmentApprovalRequired": false, "IsApprovalAllowedByCourseExperts": false, "IsApprovalAllowedByUserSupervisor": false, "Shortcode": "DOTNET101", "IsSelfEnrollmentLockedByPrerequisites": false, "IsSelfEnrollmentDrop": false, "IdParent": null, "CourseSharedScope": [], "AllowCopy": true, "AdvancedPrerequisitePattern": null } ], "learningPaths": [ { "Id": 5, "IdSite": 2, "Name": "Learning path test", "ShortDescription": "test", "LongDescription": "", "Cost": null, "IsPublished": true, "IsClosed": false, "SelfEnrollmentIsOneTimeOnly": false, "ForceCompletionInOrder": true, "DtCreated": "2026-03-13T09:41:50.973Z", "DtModified": "2026-03-13T09:41:50.973Z", "IsDeleted": false, "DtDeleted": null, "Avatar": "avatar.jpg", "SearchTags": "", "IsCallingUserEnrolled": false, "IsMultipleSelfEnrollmentEligible": true, "LanguageSpecificProperties": [ { "LangString": "en-US", "Name": "Learning path test", "ShortDescription": "test", "LongDescription": "", "SearchTags": "" } ], "Shortcode": null, "IsSelfEnrollmentDrop": false, "LookbackInterval": 1, "LookbackTimeframe": "yyyy" } ] }
|