List Users
/unified/lms/users
Partial response — use the "get" endpoint for the full object.
Query Parameters
Refer Specifying query parameters in Truto APIs
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
Defaults to unified.
unifiedunifiedrawnormalizedstream
By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
idIgnores the limit query parameter.
Excludes the remote_data attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.
List of Users
The unique identifier for the user
1 supported
The date and time the user record was created
1 supported
Provider or customer specific fields mapped into a flexible key-value object
The emails of the user
1 supported
3 properties
The email address
Whether the email address is primary
The type of email address
The user's first name
1 supported
The user's job title, when available
The user's last name
1 supported
The locale of the user, when available. Example: en-US
The user's manager, when available
3 properties
The emails of the user
3 properties
The email address
Whether the email address is primary
The type of email address
The unique identifier for a user
The name of the user
The user's name
1 supported
The organization or tenant the user belongs to, when available
2 properties
The unique identifier for an organization
The name of the organization
The phones of the user
3 properties
The extension of the phone number
The phone number
The type of phone number
Raw data returned from the remote API call.
The primary role of the user in the LMS
learnerinstructoradminmanagerother
1 supported
The lifecycle status of the user in the LMS
activeinactiveinvitedsuspendeddeletedunknown
1 supported
The timezone of the user, when available. Example: Asia/Kolkata
1 supported
The date and time the user record was last updated
1 supported
The user's username or login identifier, when different from email
1 supported
curl -X GET 'https://api.truto.one/unified/lms/users?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json'const integratedAccountId = '<integrated_account_id>';
const response = await fetch(`https://api.truto.one/unified/lms/users?integrated_account_id=${integratedAccountId}`, {
method: 'GET',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/lms/users"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())import Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.list(
'lms',
'users',
{ integrated_account_id: '<integrated_account_id>' }
);
console.log(result);import asyncio
from truto_python_sdk import TrutoApi
truto_api = TrutoApi(token="<your_api_token>")
async def main():
async for item in truto_api.unified_api.list(
"lms",
"users",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())