Users Via API

Title

Users Via API

Article Number

000004550

URL Name

users-via-api

Get User List

Returns a list of people in your organization including active and inactive people. By default only the first 100 people are returned. The list can be filtered on first or last name and paged using the optional paging parameters.

To page through users add "&limit=####" to the end of the request. For example:

GET https://api.litmos.com/v1.svc/users?source={source}&limit=1000

To retrieve only active users, add the parameter "&showInactive=false" to the end of the request.

`GET https://api.litmos.com/v1.svc/users?source={source}&showInactive=false`

Request URI

GET /users?

Response Body (XML)

<Users>
    <User>
        <Id>string [max length 50]</Id>
        <UserName>string [max length 255]</UserName>
        <FirstName>string [max length 50]</FirstName>
        <LastName>string [max length 50]</LastName>
    </User>
</Users>

Get Paginated User List

Returns a collection of records including a list of people in your organization (active and inactive) along with a summary of the user pagination information. By default only the first 100 people are returned. The list can be filtered on first or last name and paged using the optional paging parameters.

To page through users add "&limit=####" to the end of the request. For example:

GET https://api.litmos.com/v1.svc/users/paginated?source={source}&limit=1000

To retrieve only active users, add the parameter "&showInactive=false" to the end of the request.

`GET https://api.litmos.com/v1.svc/users/paginated?source={source}&showInactive=false`

Request URI

GET /users/paginated?

Response Body (XML)

<UserCollection xmlns_i="http://www.w3.org/2001/XMLSchema-instance">;
    <Pagination>
        <BatchParam>Limit</BatchParam>
        <BatchSize>integer</BatchSize>
        <Start>integer</Start>
        <TotalCount>integer</TotalCount>
    </Pagination>
    <Items>
        <User>
            <Id>string [max length 50]</Id>
            <UserName>string [max length 255]</UserName>
            <FirstName>string [max length 50]</FirstName>
            <LastName>string [max length 50]</LastName>
            <Active>true/false</Active>
            <Email>string [max length 255]</Email>
            <AccessLevel>string</AccessLevel>
            <Brand>string</Brand>
        </User>
        <User>
            <Id>string [max length 50]</Id>
            <UserName>string [max length 255]</UserName>
            <FirstName>string [max length 50]</FirstName>
            <LastName>string [max length 50]</LastName>
            <Active>true/false</Active>
            <Email>string [max length 255]</Email>
            <AccessLevel>string</AccessLevel>
            <Brand>string</Brand>
        </User>
    </Items>
</UserCollection>

Get User

Returns a single user record.

Request URI

GET /users/{userid}?

Response Body (XML)

Returns HTTP status code 200 on success and the user profile in the response body

<User>
    <Id>string [max length 50]</Id>
    <UserName>string [max length 255]</UserName>
    <FirstName>string [max length 50]</FirstName>
    <LastName>string [max length 50]</LastName>
    <FullName>string [max length 200]</FullName>
    <Email>string [max length 255]</Email>
    <AccessLevel>string</AccessLevel>
    <DisableMessages>true/false</DisableMessages>
    <Active>true/false</Active>
    <Skype>string[max length 100]</Skype>
    <PhoneWork>string[max length 50]</PhoneWork>
    <PhoneMobile>string[max length 50]</PhoneMobile>
    <LastLogin>datetime [iso 8601 format, empty if never logged in]</LastLogin>
    <LoginKey>string [max length 512]</LoginKey>
    <TimeZone>string [see time zone list*]</TimeZone>
    <OriginalId>integer</OriginalId>
    <Street1>string[optional, max length 100]</Street1>
    <Street2>string[optional, max length 100]</Street2>
    <City>string[optional, max length 100]</City>
    <State>string[optional, max length 100]</State>
    <PostalCode>string[optional, max length 100]</PostalCode>
    <Country>string[optional, max length 100]</Country>
    <CompanyName>string[optional, max length 100]</CompanyName>
    <JobTitle>string[optional, max length 100]</JobTitle>
    <CustomField1>string[optional, max length 500]</CustomField1>
    <CustomField2>string[optional, max length 500]</CustomField2>
    <CustomField3>string[optional, max length 500]</CustomField3>
    <CustomField4>string[optional, max length 500]</CustomField4>
    <CustomField5>string[optional, max length 500]</CustomField5>
    <CustomField6>string[optional, max length 500]</CustomField6>
    <CustomField7>string[optional, max length 500]</CustomField7>
    <CustomField8>string[optional, max length 500]</CustomField8>
    <CustomField9>string[optional, max length 500]</CustomField9>
    <CustomField10>string[optional, max length 500]</CustomField10>
    <Culture>string[optional, max length 500]</Culture>
    <SalesforceContactId></SalesforceContactId>
    <SalesforceAccountId></SalesforceAccountId>
    <CreatedDate>2010-01-07T04:37:06.23 [ISO8601]</CreatedDate>
    <Points>int</Points>
    <Brand>String</Brand>
    <ManagerId>string [max length 50]</ManagerId>
    <ManagerName>string [max length 200]</ManagerName>
    <EnableTextNotification>true/false</EnableTextNotification>
    <Website></Website>
    <Twitter></Twitter>
    <ExpirationDate></ExpirationDate>
    <JobRole></JobRole>
    <ExternalEmployeeId>string[optional, max length 100]</ExternalEmployeeId>
    <ProfileType>Null/Internal/External</ProfileType>
</User>

Get User by UserName

Returns user data for a user that matches the UserName string.

Request URI

GET /users/{username}?

Response Body (XML)

<User>
    <Id>[ignored]</Id>
    <UserName>string [max length 255]</UserName>
    <FirstName>string [max length 50]</FirstName>
    <LastName>string [max length 50]</LastName>
    <FullName>[ignored]</FullName>
    <Email>string [optional, max length 255]</Email>
    <AccessLevel>string</AccessLevel>
    <DisableMessages>true/false</DisableMessages>
    <Active>true [all new users are created as active]</Active>
    <Skype>string[optional, max length 100]</Skype>
    <PhoneWork>string[optional, max length 50]</PhoneWork>
    <PhoneMobile>string[optional, max length 50]</PhoneMobile>
    <LastLogin>[ignored]</LastLogin> <LoginKey>[ignored]</LoginKey>
    <IsCustomUserName>true/false - set to true if UserName field is not an email address</IsCustomUserName>
    <Password>string [optional. If used must be at least 6 characters, max length 20]</Password>
    <SkipFirstLogin>true/false</SkipFirstLogin>
    <TimeZone>string [see time zone list* | optional defaults to Org Time Zone]</TimeZone>
    <Street1>string[optional, max length 100]</Street1> <Street2>string[optional, max length 100]</Street2>
    <City>string[optional, max length 100]</City>
    <State>string[optional, max length 100]</State>
    <PostalCode>string[optional, max length 100]</PostalCode>
    <Country>string[optional, max length 100]</Country>
    <CompanyName>string[optional, max length 100]</CompanyName>
    <JobTitle>string[optional, max length 100]</JobTitle>
    <CustomField1>string[optional, max length 500]</CustomField1>
    <CustomField2>string[optional, max length 500]</CustomField2>
    <CustomField3>string[optional, max length 500]</CustomField3>
    <CustomField4>string[optional, max length 500]</CustomField4>
    <CustomField5>string[optional, max length 500]</CustomField5>
    <CustomField6>string[optional, max length 500]</CustomField6>
    <CustomField7>string[optional, max length 500]</CustomField7>
    <CustomField8>string[optional, max length 500]</CustomField8>
    <CustomField9>string[optional, max length 500]</CustomField9>
    <CustomField10>string[optional, max length 500]</CustomField10>
    <Culture>string[optional, max length 500]</Culture>
    <Brand></Brand>
    <ManagerId>string [max length 50]</ManagerId>
    <ManagerName>string [max length 200]</ManagerName>
    <EnableTextNotification>true/false</EnableTextNotification>
    <Website></Website>
    <Twitter></Twitter>
    <ExpirationDate></ExpirationDate>
    <JobRole></JobRole>
    <ExternalEmployeeId>string[optional, max length 100]</ExternalEmployeeId>
    <ProfileType>Null/Internal/External</ProfileType>
</User>

Get User by originalID

Returns a user that matches the user's originalID.

For example: https://api.litmos.com/v1.svc/users/details?source=test&originalID=123. This returns ONLY a user with originalID 123.

Request URI

GET /users?source={source}&originalID={originalID}

Request URI

GET /users/details?source={source}&originalID={originalID}

Get User by Email

Returns a user that matches exactly the user's email address.

For example: https://api.litmos.com/v1.svc/users/details?source=test&email=name@litmos.com. This returns ONLY a user with email name@litmos.com. Any combinations such as name@litmos.com.partner will not be returned.

Request URI

GET https://api.litmos.com/v1.svc/users/details?source=test&email={email}

Get Users by Using User Name, First/Last Name, Email, or Company Name

Returns all users with a matching user name, first name, last name, email address, or company name.

Request URI

`GET /users?source={source}&search={username}`

Response Body (XML)

<Users>
    <User>
        <Id>abc12345678</Id>
        <UserName>rich_demo@litmos.com</UserName>
        <FirstName>Rich</FirstName>
        <LastName>Demo</LastName>
    </User>
</Users>

Get User Details

Returns a detailed list of people in your organization including active and inactive people. By default only the first 100 people are returned. The list can be filtered on first or last name, paged using the optional paging parameters, and created date.

To return users with a Created Date after a specific date add "&since=YYYY-MM-DD" to the end of the request. For example:

GET https://api.litmos.com/v1.svc/users/details?source=MY-APP&since=2015-12-09

Request URI

GET /users/details?

Response Body (XML)

<Users>
    <User>
        <Id>string [max length 50]</Id>
        <UserName>string [max length 255]</UserName>
        <FirstName>string [max length 50]</FirstName>
        <LastName>string [max length 50]</LastName>
        <FullName>string [max length 200]</FullName>
        <Email>string [max length 255]</Email>
        <AccessLevel>string</AccessLevel>
        <DisableMessages>true/false</DisableMessages>
        <Active>true/false</Active>
        <Skype>string[max length 100]</Skype>
        <PhoneWork>string[max length 50]</PhoneWork>
        <PhoneMobile>string[max length 50]</PhoneMobile>
        <LastLogin>datetime [iso 8601 format, empty if never logged in]</LastLogin>
        <LoginKey>string [max length 512]</LoginKey>
        <IsCustomUserName>true/false</IsCustomUserName>
        <SkipFirstLogin>true/false</SkipFirstLogin>
        <TimeZone>string [see time zone list*]</TimeZone>
        <SalesforceId i_nil="true"/>
        <OriginalId>integer</OriginalId>
        <Street1>string[optional, max length 100]</Street1>
        <Street2>string[optional, max length 100]</Street2>
        <City>string[optional, max length 100]</City>
        <State>string[optional, max length 100]</State>
        <PostalCode>string[optional, max length 100]</PostalCode>
        <Country>string[optional, max length 100]</Country>
        <CompanyName>string[optional, max length 100]</CompanyName>
        <JobTitle>string[optional, max length 100]</JobTitle>
        <CustomField1>string[optional, max length 500]</CustomField1>
        <CustomField2>string[optional, max length 500]</CustomField2>
        <CustomField3>string[optional, max length 500]</CustomField3>
        <Culture>string[optional, max length 500]</Culture>
        <CustomField4>string[optional, max length 500]</CustomField4>
        <CustomField5>string[optional, max length 500]</CustomField5>
        <CustomField6>string[optional, max length 500]</CustomField6>
        <CustomField7>string[optional, max length 500]</CustomField7>
        <CustomField8>string[optional, max length 500]</CustomField8>
        <CustomField9>string[optional, max length 500]</CustomField9>
        <CustomField10>string[optional, max length 500]</CustomField10>
        <SalesforceContactId>string[optional, max length 500]</SalesforceContactId>
        <SalesforceAccountId>string[optional, max length 500]</SalesforceAccountId>
        <CreatedDate>datetime [iso 8601 format]</CreatedDate>
        <Points>integer</Points>
        <Brand>String</Brand>
        <ManagerId>string [max length 50]</ManagerId>
        <ManagerName>string [max length 200]</ManagerName>
        <EnableTextNotification>true/false</EnableTextNotification>
        <Website></Website>
        <Twitter></Twitter>
        <ExpirationDate></ExpirationDate>
        <JobRole></JobRole>
        <ExternalEmployeeId>string[optional, max length 100]</ExternalEmployeeId>
        <ProfileType>Null/Internal/External</ProfileType>
    </User>
    <User>
        ...
    </User>
</Users>

Response Header

200 OK

Get All Course Results for All Users Since a Specific Date

Get a list of all results for all Users and the current status of each Course since a specific date. In this call, the ‘since’ and 'to' parameter is required and will fail if it is not present. It will also allow a ‘limit’ parameter of up to 1000 records to keep the record set controlled. The call will fail if the limit parameter is greater than 1000. Use the paging parameters built into the API if there are more than 1000 records returned. The API will fetch all updated results, even if they are not currently assigned.

To return course results that have changed since a specific date, use the "&since=YYYY-MM-DD" and "&to=YYYY-MM-DD" parameter on the end of the request. For example:

GET https://api.litmos.com/v1.svc/results/details?source=**MY-APP**&since=2015-12-09&to=2015-12-10

Request Body (XML)

<Users>
    <User>
        <Id></Id>
        <UserOriginalId></UserOriginalId>
        <Username></Username>
        <FirstName></FirstName>
        <LastName></LastName>
        <Active></Active>
        <Email></Email>
        <AccessLevel></AccessLevel>
        <LoginKey></LoginKey>
        <CourseId></CourseId>
        <CourseOriginalId></CourseOriginalId>
        <UpdatedDate></UpdatedDate>
        <Code></Code>
        <CourseName></CourseName>
        <Completed></Completed>
        <PercentageComplete></PercentageComplete>
        <CompletedDate i_nil="true"/>
        <UpToDate></UpToDate>
        <Overdue></Overdue>
        <CompliantTillDate i_nil="true"/>
    </User>
    <User>
        <Id></Id>
        <UserOriginalId></UserOriginalId>
        <Username></Username>
        <FirstName></FirstName>
        <LastName></LastName>
        <Active></Active>
        <Email></Email>
        <AccessLevel></AccessLevel>
        <LoginKey></LoginKey>
        <CourseId></CourseId>
        <CourseOriginalId></CourseOriginalId>
        <UpdatedDate></UpdatedDate>
        <Code></Code>
        <CourseName></CourseName>
        <Completed></Completed>
        <PercentageComplete></PercentageComplete>
        <CompletedDate i_nil="true"/>
        <UpToDate></UpToDate>
        <Overdue></Overdue>
        <CompliantTillDate i_nil="true"/>
    </User>
    ....
</Users>

Create User

Creates a new user profile in your organization. By default, no emails will be sent when the user is created. To have an email sent to the user when they are created, the following query string parameter needs to be added to the request: &sendmessage=true.

NOTES:

By default all new users that you create will be prompted to change their password the first time they login. If you are using the single sign-on approach then this may not be desirable. To stop this from happening you need to set the SkipFirstLogin field to true. By default it is assumed that a username will be a valid email address. If you want to use a non-email address as username you must also set the IsCustomUserName property to true.
Mobile phone validation. When you create or update a user, the PhoneMobile value must be in full international format: a plus sign (+), the country code, and the number, with no spaces or punctuation (for example, +17147185078). If the value is invalid, the request returns an Invalid Mobile Phone Number error and the user record is not created or updated. An empty PhoneMobile value is still accepted.
You will need to use the same order listed below to update the information. Do not change the order of items or the PUT or POST request will not update/create the users. You can either use the short body or the full body for the request.

Request URI:

POST /users?

Request Body (XML)

Entire list of fields for a PUT or POST request:

<User>
    <Id>[ignored]</Id>
    <UserName>string [max length 255]</UserName>
    <FirstName>string [max length 50]</FirstName>
    <LastName>string [max length 50]</LastName>
    <FullName>[ignored]</FullName>
    <Email>string [optional, max length 255]</Email>
    <AccessLevel>Account_Owner/Admin/Team_Leader/Learner/roleID</AccessLevel>
    <DisableMessages>true/false</DisableMessages>
    <Active>true [all new users are created as active]</Active>
    <Skype>string[optional, max length 100]</Skype>
    <PhoneWork>string[optional, max length 50]</PhoneWork>
    <PhoneMobile>string[optional, max length 50]</PhoneMobile>
    <LastLogin>[ignored]</LastLogin>
    <LoginKey>[ignored]</LoginKey>
    <IsCustomUserName>true/false - set to true if UserName field is not an email address</IsCustomUserName>
    <Password>string [optional. If used must be at least 6 characters, max length 20]</Password>
    <SkipFirstLogin>true/false</SkipFirstLogin>
    <TimeZone>string [see time zone list* | optional defaults to Organisation Time Zone]</TimeZone>
    <Street1>string[optional, max length 100]</Street1>
    <Street2>string[optional, max length 100]</Street2>
    <City>string[optional, max length 100]</City>
    <State>string[optional, max length 100]</State>
    <PostalCode>string[optional, max length 100]</PostalCode>
    <Country>string[optional, max length 100]</Country>
    <CompanyName>string[optional, max length 100]</CompanyName>
    <JobTitle>string[optional, max length 100]</JobTitle>
    <CustomField1>string[optional, max length 500]</CustomField1>
    <CustomField2>string[optional, max length 500]</CustomField2>
    <CustomField3>string[optional, max length 500]</CustomField3>
    <CustomField4>string[optional, max length 500]</CustomField4>
    <CustomField5>string[optional, max length 500]</CustomField5>
    <CustomField6>string[optional, max length 500]</CustomField6>
    <CustomField7>string[optional, max length 500]</CustomField7>
    <CustomField8>string[optional, max length 500]</CustomField8>
    <CustomField9>string[optional, max length 500]</CustomField9>
    <CustomField10>string[optional, max length 500]</CustomField10>
    <Culture>string[optional, max length 500]</Culture>
    <Brand></Brand>
    <ManagerId>string [max length 50]</ManagerId>
    <ManagerName>string [max length 200]</ManagerName>
    <EnableTextNotification>true/false</EnableTextNotification>
    <Website></Website>
    <Twitter></Twitter>
    <ExpirationDate></ExpirationDate>
    <JobRole></JobRole>
    <ExternalEmployeeId>string[optional, max length 100]</ExternalEmployeeId>
    <ProfileType>Null/Internal/External</ProfileType>
</User>

Mandatory list of fields:

<User>
    <Id>[Mandatory for PUT]</Id>
    <UserName>MyUserName</UserName>
    <FirstName>MyFirstName</FirstName>
    <LastName>MyLastName</LastName>
    <FullName></FullName>
    <Email>testing124@test.com</Email>
    <AccessLevel>Learner</AccessLevel>
    <DisableMessages>false</DisableMessages>
    <Active>true</Active>
    <LastLogin></LastLogin>
    <LoginKey></LoginKey>
    <IsCustomUserName>true</IsCustomUserName>
    <SkipFirstLogin>false</SkipFirstLogin>
    <TimeZone></TimeZone>
</User>

Response Body (XML)

Returns a HTTP status code 201 (Created) on success with the new user Id populated in the response body.

<User>
    <Id>string [max length 50]</Id>
    <UserName>string [max length 255]</UserName>
    <FirstName>string [max length 50]</FirstName>
    <LastName>string [max length 50]</LastName>
    <FullName>string [max length 200]</FullName>
    <Email>string [optional, max length 255]</Email>
    <LoginKey>string [max length 50]</LoginKey>
    <AccessLevel>string</AccessLevel>
    <DisableMessages>true/false</DisableMessages>
    <Active>true/false</Active>
    <Skype>string[optional, max length 100]</Skype>
    <PhoneWork>string[optional, max length 50]</PhoneWork>
    <PhoneMobile>string[optional, max length 50]</PhoneMobile>
    <LastLogin>datetime [iso 8601 format, empty if never logged in]</LastLogin>
    <IsCustomUserName>true</IsCustomUserName>
    <Password></Password>
    <SkipFirstLogin>false</SkipFirstLogin>
    <TimeZone>string [see time zone* list]</TimeZone>
    <OriginalId>integer</OriginalId>
    <Street1>string[optional, max length 100]</Street1>
    <Street2>string[optional, max length 100]</Street2>
    <City>string[optional, max length 100]</City>
    <State>string[optional, max length 100]</State>
    <PostalCode>string[optional, max length 100]</PostalCode>
    <Country>string[optional, max length 100]</Country>
    <CompanyName>string[optional, max length 100]</CompanyName>
    <JobTitle>string[optional, max length 100]</JobTitle>
    <CustomField1>string[optional, max length 500]</CustomField1>
    <CustomField2>string[optional, max length 500]</CustomField2>
    <CustomField3>string[optional, max length 500]</CustomField3>
    <CustomField4>string[optional, max length 500]</CustomField4>
    <CustomField5>string[optional, max length 500]</CustomField5>
    <CustomField6>string[optional, max length 500]</CustomField6>
    <CustomField7>string[optional, max length 500]</CustomField7>
    <CustomField8>string[optional, max length 500]</CustomField8>
    <CustomField9>string[optional, max length 500]</CustomField9>
    <CustomField10>string[optional, max length 500]</CustomField10>
    <Culture>string[optional, max length 500]</Culture>
    <Brand></Brand>
    <ManagerId>string [max length 50]</ManagerId>
    <ManagerName>string [max length 200]</ManagerName>
    <EnableTextNotification>true/false</EnableTextNotification>
    <Website></Website>
    <Twitter></Twitter>
    <ExpirationDate></ExpirationDate>
    <JobRole></JobRole>
    <ExternalEmployeeId>string[optional, max length 100]</ExternalEmployeeId>
    <ProfileType>Null/Internal/External</ProfileType>
</User>

Important Note: Although many of the fields of the body request are optional, the order of the included fields must be in the same default order.

Update User

Update a user record.

Important Notes:

The user Id in the URI must match the Id specified in the request body.
The same mobile phone validation applies to updates. A request with an invalid PhoneMobile value returns an Invalid Mobile Phone Number error, and none of the changes in that request are saved.

Request URI

PUT /users/{userid}?

Request Body (XML)

<User>
    <Id>string [user id to update, max length 50]</Id>
    <UserName>string [max length 255]</UserName>
    <FirstName>string [max length 50]</FirstName>
    <LastName>string [max length 50]</LastName>
    <FullName>[ignored]</FullName>
    <Email>testing124@test.com</Email>
    <AccessLevel>Account_Owner/Admin/Team_Leader/Learner/roleID</AccessLevel>
    <DisableMessages>true/false [optional, default to false]</DisableMessages>
    <Active>true/false</Active>
    <Skype>string[optional, max length 100]</Skype>
    <PhoneWork>string[optional, max length 50]</PhoneWork>
    <PhoneMobile>string[optional, max length 50]</PhoneMobile>
    <LastLogin>[ignored]</LastLogin>
    <LoginKey>[ignored]</LoginKey>
    <Password>string [optional. If used must be at least 6 characters, max length 20]</Password>
    <SkipFirstLogin>true/false</SkipFirstLogin>
    <TimeZone>string [see time zone list* | optional]</TimeZone>
    <Street1>string[optional, max length 100]</Street1>
    <Street2>string[optional, max length 100]</Street2>
    <City>string[optional, max length 100]</City>
    <State>string[optional, max length 100]</State>
    <PostalCode>string[optional, max length 100]</PostalCode>
    <Country>string[optional, max length 100]</Country>
    <CompanyName>string[optional, max length 100]</CompanyName>
    <JobTitle>string[optional, max length 100]</JobTitle>
    <CustomField1>string[optional, max length 500]</CustomField1>
    <CustomField2>string[optional, max length 500]</CustomField2>
    <CustomField3>string[optional, max length 5

Resolution

Owner

Jason van Ravenswaay

Validation Status

Not Validated

Publication Status

Published

Article Total View Count

Created By

Jason van Ravenswaay, 10/29/2026, 6:14 AM

Assigned By

Created Date

10/29/2026, 6:14 AM

Assigned To

First Published Date

9/26/2026, 6:02 AM

Last Published Date

9/26/2026, 6:02 AM

Last Modified By

App Integration User, 10/29/2026, 6:14 AM

Last Modified Date

10/29/2026, 6:14 AM

Archived Date

Users Via API

Get User List

`GET https://api.litmos.com/v1.svc/users?source={source}&showInactive=false`

Request URI

Response Body (XML)

Get Paginated User List

`GET https://api.litmos.com/v1.svc/users/paginated?source={source}&showInactive=false`

Request URI

Response Body (XML)

Get User

Request URI

Response Body (XML)

Get User by UserName

Request URI

Response Body (XML)

Get User by originalID

Request URI

Request URI

Get User by Email

Request URI

Get Users by Using User Name, First/Last Name, Email, or Company Name

Request URI

`GET /users?source={source}&search={username}`

Response Body (XML)

Get User Details

Request URI

Response Body (XML)

Response Header

Get All Course Results for All Users Since a Specific Date

Request Body (XML)

Create User

Request URI:

Request Body (XML)

Response Body (XML)

Update User

Request URI

Request Body (XML)

Files(0)

Need Answers Fast?

Users Via API

Article Information

Content

Get User List

GET https://api.litmos.com/v1.svc/users?source={source}&showInactive=false

Request URI

Response Body (XML)

Get Paginated User List

GET https://api.litmos.com/v1.svc/users/paginated?source={source}&showInactive=false

Request URI

Response Body (XML)

Get User

Request URI

Response Body (XML)

Get User by UserName

Request URI

Response Body (XML)

Get User by originalID

Request URI

Request URI

Get User by Email

Request URI

Get Users by Using User Name, First/Last Name, Email, or Company Name

Request URI

GET /users?source={source}&search={username}

Response Body (XML)

Get User Details

Request URI

Response Body (XML)

Response Header

Get All Course Results for All Users Since a Specific Date

Request Body (XML)

Create User

Request URI:

Request Body (XML)

Response Body (XML)

Update User

Request URI

Request Body (XML)

Information

Visibility

Administration

Archive Information

Trending Articles

Need Answers Fast?

`GET https://api.litmos.com/v1.svc/users?source={source}&showInactive=false`

`GET https://api.litmos.com/v1.svc/users/paginated?source={source}&showInactive=false`

`GET /users?source={source}&search={username}`