Get Courses

GET /v1/courses

Get Courses

Query parameters

page integer | null

The page number in a paginated set of results
limit integer | null

The limit of results to be returned per page
status[eq] string

Search Course with a specific status

Values are Draft or Published.
status[in] array[string]

Search Course which have the following statuses

Values are Draft or Published.
privacy[eq] string

Search Course with a specific privacy

Values are Secret or Public.
privacy[in] array[string]

Search Course which have the following privacy

Values are Secret or Public.
moduleName[eq] string

Search Courses with a specific module name
moduleName[contains] string

Search Courses that contains this in the module name

Responses

200 application/json

Courses returned successfully
Hide response attributes Show response attributes object
- items array[object] Required
  
  The items found
  
  Hide items attributes Show items attributes object
  
  id string Required
  
  The id of the course.
  
  title string Required
  
  The title of the course.
  
  description string Required
  
  The description of the course.
  
  privacy string Required
  
  The privacy of the course.
  
  Values are Secret or Public.
  
  status string Required
  
  The status of the course.
  
  Values are Draft or Published.
  
  navigationMode string Required
  
  The navigation mode in the course.
  
  Values are Flexible or Sequential.
  
  moduleName string | null Required
  
  Name of the module this course belongs to, if applicable.
- total integer Required
  
  The total number of items found
400

Malformed payload

GET /v1/courses

curl \
 --request GET 'https://openapi.meltingspot.io/v1/courses'

Response examples (200)

{
  "items": [
    {
      "id": "string",
      "title": "string",
      "description": "string",
      "privacy": "Secret",
      "status": "Draft",
      "navigationMode": "Flexible",
      "moduleName": "string"
    }
  ],
  "total": 42
}