Appearance

List Courses ​

Endpoint ​

http
GET /unified/lms/courses
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

Response Body ​

result
object[]

List of Courses

id
string
REQUIRED · 

The unique identifier for the course

Supported in
  • TalentLMS
title
string

The title of the course

Supported in
  • TalentLMS
description
string

The description of the course

Supported in
  • TalentLMS
code
string

A course code or SKU, when available

Supported in
  • TalentLMS
type
string

The type of learning item

All possible enum values:
  • course
  • path
  • curriculum
  • program
  • microlearning
  • other
Supported in
  • TalentLMS
status
string

The publication or availability status of the course

All possible enum values:
  • draft
  • published
  • archived
  • disabled
  • unknown
Supported in
  • TalentLMS
language
string

The primary language of the course, when available. Example: en

duration_seconds
integer

The estimated duration of the course in seconds, when available

level
string

The difficulty level of the course, when available

All possible enum values:
  • beginner
  • intermediate
  • advanced
  • mixed
  • unknown
urls
object[]

The URLs related to the course.

url
string

The URL

type
string

The type of URL

tags
object[]

Tags applied to the course

id
string

The tag's unique identifier

name
string

The tag's name

categories
object[]

Categories the course belongs to, when available

id
string

The category's unique identifier

name
string

The category's name

organization
object

The organization or tenant the course belongs to, when available

id
string

The unique identifier for an organization

name
string

The name of the organization

published_at
string · date-time

The date and time the course was published, when available

created_at
string · date-time

The date and time the course record was created

Supported in
  • TalentLMS
updated_at
string · date-time

The date and time the course 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.