List Course enrollments
/unified/lms/course-enrollments
Query Parameters
Refer Specifying query parameters in Truto APIs
The learner associated with this record
1 supported1 required
The unique identifier for a user
The emails of the user
3 properties
The email address
Whether the email address is primary
The type of email address
The name of the user
The course associated with this record
1 supported1 required
The unique identifier for the course
The title of the course
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 Course enrollments
The unique identifier for the course enrollment record
1 supported
The date and time the course was assigned to the user, when available
The assigner of this course to the user, when available
2 properties
The unique identifier for a user
The name of the user
The latest attempt number, when the LMS supports retakes
Total attempts count, when available
The date and time the user completed the course, when available
1 supported
The course associated with this record
1 supported
2 properties
The unique identifier for the course
The title of the course
The date and time the enrollment record was created
Provider or customer specific fields mapped into a flexible key-value object
The due date for course completion, when available
The date and time the user enrolled or registered, when available
1 supported
Whether this enrollment is part of a mandatory assignment, when available
The date and time of the last recorded activity for this enrollment, when available
Progress percentage from 0 to 100, when available
1 supported
Raw data returned from the remote API call.
The latest or final score, when available
The date and time the user started the course, when available
The lifecycle status for the user in this course
assignedenrolledin_progresscompletedpassedfailedwithdrawnexpiredoverdueunknown
1 supported
Total time spent in seconds, when available
1 supported
The date and time the enrollment record was last updated
1 supported
The URLs of the course-enrollments
2 properties
The type of URL
The URL
The learner associated with this record
1 supported
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
curl -X GET 'https://api.truto.one/unified/lms/course-enrollments?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/course-enrollments?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/course-enrollments"
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',
'courseenrollments',
{ 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",
"courseenrollments",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())