• Free Trial
  • Products
    • LMSThe world’s easiest-to-use learning management system.
    • Training ContentA robust library of off-the-shelf learning content.
  • Solutions
    • By Use Case
      • Employee Training
      • Sales Training
      • Customer Training
      • Partner Training
      • Compliance Training
      • View all
    • By Industry
      • Technology
      • Nonprofit
      • Retail
      • Hospitality
      • Healthcare
      • View all
  • Customers
    • Learn more about Litmos customer success stories.
      • Case Studies
      • Video Testimonials
      • I Love Litmos
      • Lenny Awards
    • Featured Customer
      • Sabre, a global travel technology provider, increases revenue by using Litmos to train their sales and technical teams.
  • Pricing
  • Resources
    • Ebooks & Infographics
    • Webinars & Podcasts
    • Events
    • Integrations
    • Blog
  • About
    • Company
    • Partners
    • Awards
    • Careers
    • Sustainability
  • Free Trial
Litmos
Log in
Contact us
Support
Search
  • Free Trial
  • Products
    • LMSThe world’s easiest-to-use learning management system.
    • Training ContentA robust library of off-the-shelf learning content.
  • Solutions
    • By Use Case
      • Employee Training
      • Sales Training
      • Customer Training
      • Partner Training
      • Compliance Training
      • View all
    • By Industry
      • Technology
      • Nonprofit
      • Retail
      • Hospitality
      • Healthcare
      • View all
  • Customers
    • Learn more about Litmos customer success stories.
      • Case Studies
      • Video Testimonials
      • I Love Litmos
      • Lenny Awards
    • Featured Customer
      • Sabre, a global travel technology provider, increases revenue by using Litmos to train their sales and technical teams.
  • Pricing
  • Resources
    • Ebooks & Infographics
    • Webinars & Podcasts
    • Events
    • Integrations
    • Blog
  • About
    • Company
    • Partners
    • Awards
    • Careers
    • Sustainability
  • Free Trial

Litmos Documentation

APIs

Home › Litmos Documentation › Gamification Via API

Gamification Via API

Get Total Badges and Points For User

Get the number of badges and point for a user.

Request URI

GET /users/{userid}/gamificationsummary?

Response Body (XML)

Returns HTTP status code 200 on success and the session list in the response body.

<GamificationAchievementSummary>
    <TotalBadgeEarned>INT</TotalBadgeEarned>
    <TotalPointEarned>DECIMAL(15,2)</TotalPointEarned>
</GamificationAchievementSummary>

Get List of Badges Earned By User

Get a list of badges and points for a user.

Request URI

GET /users/{userid}/badges?

Response Body (XML)

Returns HTTP status code 200 on success and the session list in the response body.

<Badges>
    <Badge>
        <ID>string [max length 50]</ID>
        <Title>string [max length 500]</Title>
        <Description>string</Description>
        <Icon>icon url string</Icon>
        <IconBgColor>string [max length 500]</IconBgColor>
    </Badge>
    <Badge>
        <ID>string [max length 50]</ID>
        <Title>string [max length 500]</Title>
        <Description>string</Description>
        <Icon>icon url string</Icon>
        <IconBgColor>string [max length 500]</IconBgColor>
    </Badge>
</Badges>

Get Badges and Points Earned By User

Get the badge and point details for each course record or learning path record completed by a user.

Request URI

GET /users/{userid}/gamificationdetails?

Response Body (XML)

Returns HTTP status code 200 on success and the session list in the response body.

<GamificationAchievedItems>
    <GamificationAchievedItem>
        <ID>string [max length 50]</ID>
        <ItemID>string [max length 50]</ItemID>
        <ItemName>string [max length 500]</ItemName>
        <EarnedPoint>DECIMAL(15,2)</EarnedPoint>
        <EarnedBadgeID>string [max length 50]</EarnedBadgeID>
        <DateCompleted>datetime [iso 8601 format]</DateCompleted>
        <Badge>
            <ID>string [max length 50]</ID>
            <Title>string [max length 500]</Title>
            <Description>string</Description>
            <Icon>icon url string</Icon>
            <IconBgColor>string [max length 500]</IconBgColor>
            <IconDisplayUrl>string</IconDisplayUrl>
        </Badge>
        <GamificationLearningPathItemList>
            <GamificationLearningPathItem>
                <ID>string [max length 50]</ID>
                <LearningPathID>string [max length 50]</LearningPathID>
                <LearningPathName>string [max length 255]</LearningPathName>
            </GamificationLearningPathItem>
        </GamificationLearningPathItemList>
    </GamificationAchievedItem>
    <GamificationAchievedItem>
        <ID>string [max length 50]</ID>
        <ItemID>string [max length 50]</ItemID>
        <ItemName>string [max length 500]</ItemName>
        <EarnedPoint>DECIMAL(15,2)</EarnedPoint>
        <EarnedBadgeID>string [max length 50]</EarnedBadgeID>
        <DateCompleted>datetime [iso 8601 format]</DateCompleted>
        <Badge>
            <ID>string [max length 50]</ID>
            <Title>string [max length 500]</Title>
            <Description>string</Description>
            <Icon>icon url string</Icon>
            <IconBgColor>string [max length 500]</IconBgColor>
            <IconDisplayUrl>string</IconDisplayUrl>
        </Badge>
        <GamificationLearningPathItemList>
            <GamificationLearningPathItem>
                <ID>string [max length 50]</ID>
                <LearningPathID>string [max length 50]</LearningPathID>
                <LearningPathName>string [max length 255]</LearningPathName>
            </GamificationLearningPathItem>
        </GamificationLearningPathItemList>
    </GamificationAchievedItem>
</GamificationAchievedItems>

Get Badges and Points earned by a Team

Get the badge and point details for each course record or learning path record completed by a user belonging to a team record.

Request URI

GET /teams/{teamid}/gamificationdetails?

Response Body (XML)

Returns HTTP status code 200 on success and the session list in the response body.

<GamificationUsers xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <GamificationUser>
        <Id>string [max length 50]</Id>
        <FirstName>string [max length 100]</FirstName>
        <LastName>string [max length 100]</LastName>
        <GamificationAchievedItems>
            <GamificationAchievedItem>
                <ID>string [max length 50]</ID>
                <ItemID>string [max length 50]</ItemID>
                <ItemName>string [max length 500]</ItemName>
                <EarnedPoint>DECIMAL(15,2)</EarnedPoint>
                <EarnedBadgeID>string [max length 50]</EarnedBadgeID>
                <DateCompleted>datetime [iso 8601 format]</DateCompleted>
                <Badge>
                    <ID>string [max length 50]</ID>
                    <Title>string [max length 500]</Title>
                    <Description>string</Description>
                    <Icon>icon url string</Icon>
                    <IconBgColor>string [max length 500]</IconBgColor>
                    <IconDisplayUrl>string</IconDisplayUrl>
                </Badge>
                <GamificationLearningPathItemList>
                    <GamificationLearningPathItem>
                        <ID>string [max length 50]</ID>
                        <LearningPathID>string [max length 50]</LearningPathID>
                        <LearningPathName>string [max length 255]</LearningPathName>
                    </GamificationLearningPathItem>
                </GamificationLearningPathItemList>
            </GamificationAchievedItem>
        </GamificationAchievedItems>
    </GamificationUser>
    <GamificationUser>
        <Id>string [max length 50]</Id>
        <FirstName>string [max length 100]</FirstName>
        <LastName>string [max length 100]</LastName>
        <GamificationAchievedItems>
            <GamificationAchievedItem>
                <ID>string [max length 50]</ID>
                <ItemID>string [max length 50]</ItemID>
                <ItemName>string [max length 500]</ItemName>
                <EarnedPoint>DECIMAL(15,2)</EarnedPoint>
                <EarnedBadgeID>string [max length 50]</EarnedBadgeID>
                <DateCompleted>datetime [iso 8601 format]</DateCompleted>
                <Badge>
                    <ID>string [max length 50]</ID>
                    <Title>string [max length 500]</Title>
                    <Description>string</Description>
                    <Icon>icon url string</Icon>
                    <IconBgColor>string [max length 500]</IconBgColor>
                    <IconDisplayUrl>string</IconDisplayUrl>
                </Badge>
                <GamificationLearningPathItemList>
                    <GamificationLearningPathItem>
                        <ID>string [max length 50]</ID>
                        <LearningPathID>string [max length 50]</LearningPathID>
                        <LearningPathName>string [max length 255]</LearningPathName>
                    </GamificationLearningPathItem>
                </GamificationLearningPathItemList>
            </GamificationAchievedItem>
        </GamificationAchievedItems>
    </GamificationUser>
</GamificationUsers>

Reset Gamification for a User

Resets the gamification badge records and point records earned by a user.

Request URI

PUT /users/[{userid}/gamificationreset?

Response Header

200 OK

No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of Litmos.

The information contained herein may be changed without prior notice. Some software products marketed by Litmos and its distributors contain proprietary software components of other software vendors. National product specifications may vary.

These materials are provided by Litmos for informational purposes only, without representation or warranty of any kind, and Litmos or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for Litmos company products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.

In particular Litmos or its affiliated companies have no obligation to pursue any course of business outlined in this document or any related presentation, or to develop or release any functionality mentioned therein. This document, or any related presentation, and Litmos or its affiliated companies’ strategy and possible future developments, products, and/or platform directions and functionality are all subject to change and may be changed by Litmos or its affiliated companies at any time for any reason without notice.

The information in this document is not a commitment, promise, or legal obligation to deliver any material, code, or functionality. All forward-looking statements are subject to various risks and uncertainties that could cause actual results to differ materially from expectations. Readers are cautioned not to place undue reliance on these forward-looking statements, and they should not be relied upon in making purchasing decisions.

© 2022 Litmos or a Litmos affiliate company. All rights reserved.

Litmos and other Litmos products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Litmos (or a Litmos affiliate company) in the United States and other countries. All other product and service names mentioned are the trademarks of their respective companies.

Match keywords.

Useful Links

  • Release Notes
  • Customer Portal

In this article

Related articles

  1. Users Via API
  2. Instructor Led Training Via API
  3. Date Range Delta Queries Via API

Also of Interest

  • Training Software
  • Active Learning Online Courses
  • Learning
  • Corporate LMS
  • Enterprise Learning Management System
  • LMS Platform
  • eLearning Platform
  • What is a learning management system?
  • See Additional Resources

Solutions by Use Case

  • Employee Training
  • Customer Training
  • Compliance Training
  • Sales Training
  • Operations Training
  • Gig Worker Training
  • Contractor Training
  • Supplier Training

Solutions by Industry

  • Technology
  • Nonprofit
  • Retail
  • Hospitality
  • Healthcare

Contact Us

Contact
UK: +44 20 4551 1606
USA: +1 925 490 0401
AUS: +61 3 7066 4851
Email
Support
Address
Contact Us
Litmos Reviews Litmos Reviews
Litmos Careers Careers

© 2023 Litmos US, L.P. and affiliates. All rights reserved.

  • Privacy Statement
  • Terms & Conditions
  • Website Terms