API

List groups linked to a course

GET /v1/courses/{courseId}/groups

List groups linked to a course

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

Responses

  • 200 application/json

    Group 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 group.

      • name string Required

        The name of the group.

      • description string

        The description of the group

      • emoji string

        The emoji of the group

      • emailNotificationEnabled boolean Required

        Email notifications activation state

    • total integer Required

      The total number of items found
  • 400

    Malformed payload

  • 404

    Course not found

GET /v1/courses/{courseId}/groups 
curl \
 --request GET 'https://openapi.meltingspot.io/v1/courses/{courseId}/groups'
Response examples (200) 
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "emoji": "string",
      "emailNotificationEnabled": true
    }
  ],
  "total": 42
}