lms
course

List all courses

Changed on
get/lms/{connection_id}/course

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/lms/{connection_id}/course
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

class_idstring

The class ID to filter by (reference to LmsClass)

company_idstring

The company ID to filter by (reference to HrisCompany)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring
descriptionstring
is_privateboolean
is_activeboolean
price_amountnumber

How much the course costs

languagesstring[]
categoriesstring[]
currencystring

The currency code (ISO) of the course price

content_idsstring[]
skillsstring[]
duration_minutesnumber
provider_namestring
published_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

time_estimate_minutesnumber
rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status