Home › Litmos Documentation › Achievements Via API
Get a List of Achievements
When a person completes a course in Litmos, an Achievement is added to their profile. This API request enables you to get a list of achievements in descending order and also provides the ability to filter the achievements by date or user.
For example, If you wanted to keep track of when users in your organization complete courses you could make a daily request to /achievements and pass in the previous days date in the since parameter to get all of the achievements that have happened since that date.
Optional Query Filters
- userid – return all of the achievements for a given user
- since – return all achievements since a given date YYYY-MM-DD
- paging – see Search & Paging Parameters
Request URI
GET /achievements?source={source}&since={YYYY-MM-DD HH:MM:SS}&userid={userid}
Response Body (XML)
<Achievements>
<Achievement>
<UserId>string [max length 50]</UserId>
<Title>string [max length 512]</Title>
<Description>string</Description>
<AchievementDate>datetime [iso 8601 format]</AchievementDate>
<CourseId>string [max length 50]</CourseId>
<CompliantTillDate nil="true">datetime [iso 8601 format]</CompliantTillDate>
<Score>string [max length 50]</Score>
<Result>string [max length 50]</Result>
<Type>string [max length 255]</Type>
<FirstName>string [max length 50]</FirstName>
<LastName>string [max length 50]</LastName>
<AchievementId>integer</AchievementId>
<CertificateId>integer</CertificateId>
</Achievement>
<Achievement>
...
</Achievement>
</Achievements>
Field description
- UserId – The person that gained the achievement
- Title – The title of the course or achievement
- Description – The description of the achievement
- AchievementDate – The date & time the achievement was gained
- CourseId – If the achievement was completing a course in Litmos this is the course that was completed
- CompliantTillDate – If populated this indicates when a person is compliant till.
- Score – If populated this indicates the person score when gaining the achievement
- Result – A free text description of the achievement status. e.g., Completed
- Type – The type of achievement e.g., Online Course
- AchievementId – The Id of the Achievement
- CertificateId – The Id of the Certificate
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.