Appearance

List Course enrollments ​

Endpoint ​

http
GET /unified/lms/course-enrollments
Integrations supported
  • TalentLMS

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns 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.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_key_by
string

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.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
user
object

The learner associated with this record

Required in
  • TalentLMS
id
string
REQUIRED · 

The unique identifier for a user

name
string

The name of the user

emails
object[]

The emails of the user

email
string

The email address

type
string

The type of email address

is_primary
boolean

Whether the email address is primary

course
object

The course associated with this record

Required in
  • TalentLMS
id
string
REQUIRED · 

The unique identifier for the course

title
string

The title of the course

Response Body ​

result
object[]

List of Course enrollments

id
string
REQUIRED · 

The unique identifier for the course enrollment record

Supported in
  • TalentLMS
user
object

The learner associated with this record

Supported in
  • TalentLMS
id
string

The unique identifier for a user

name
string

The name of the user

emails
object[]

The emails of the user

email
string

The email address

type
string

The type of email address

is_primary
boolean

Whether the email address is primary

course
object

The course associated with this record

Supported in
  • TalentLMS
id
string

The unique identifier for the course

title
string

The title of the course

status
string

The lifecycle status for the user in this course

All possible enum values:
  • assigned
  • enrolled
  • in_progress
  • completed
  • passed
  • failed
  • withdrawn
  • expired
  • overdue
  • unknown
Supported in
  • TalentLMS
assigned_at
string · date-time

The date and time the course was assigned to the user, when available

due_at
string · date-time

The due date for course completion, when available

enrolled_at
string · date-time

The date and time the user enrolled or registered, when available

Supported in
  • TalentLMS
started_at
string · date-time

The date and time the user started the course, when available

last_activity_at
string · date-time

The date and time of the last recorded activity for this enrollment, when available

completed_at
string · date-time

The date and time the user completed the course, when available

Supported in
  • TalentLMS
progress_percent
number

Progress percentage from 0 to 100, when available

Supported in
  • TalentLMS
time_spent_seconds
integer

Total time spent in seconds, when available

Supported in
  • TalentLMS
score
number

The latest or final score, when available

is_mandatory
boolean

Whether this enrollment is part of a mandatory assignment, when available

assigned_by
object

The assigner of this course to the user, when available

id
string

The unique identifier for a user

name
string

The name of the user

attempt_number
integer

The latest attempt number, when the LMS supports retakes

attempts_count
integer

Total attempts count, when available

urls
object[]

The URLs of the course-enrollments

url
string

The URL

type
string

The type of URL

created_at
string · date-time

The date and time the enrollment record was created

updated_at
string · date-time

The date and time the enrollment record was last updated

Supported in
  • TalentLMS
custom_fields
object

Provider or customer specific fields mapped into a flexible key-value object

remote_data
object

Raw data returned from the remote API call.

next_cursor
string

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.