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