API

List Course steps

GET /v1/courses/{courseId}/steps

List Course steps

Path parameters

  • courseId string Required

    The id of the course

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

  • title[eq] string

    Search course steps with a specific title

  • title[contains] string

    Search course steps that contains this in the title

  • solution[in] array[string]

    Search course steps with theses types of content

    Values are Page or Quiz.

  • solution[eq] string

    Search course steps with a specific content type

    Values are Page or Quiz.

Responses

  • 200 application/json

    Courses steps 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 step.

      • title string Required

        The title of the course step.

      • duration integer | null Required

        The duration of the course step.

      • contentType string Required

        The type of the course step.

        Values are Page or Quiz.

      • createdAt integer Required

        Timestamp in ms of creation date

    • total integer Required

      The total number of items found
  • 400

    Malformed payload

  • 404

    Course not found

GET /v1/courses/{courseId}/steps 
curl \
 --request GET 'https://openapi.meltingspot.io/v1/courses/{courseId}/steps'
Response examples (200) 
{
  "items": [
    {
      "id": "string",
      "title": "string",
      "duration": 42,
      "contentType": "Page",
      "createdAt": 42
    }
  ],
  "total": 42
}