🗃️Endpoints - Courses

Get courses

Get Courses

get

/v1/courses

Query parameters

pageinteger | nullable

The page number in a paginated set of results

limitinteger | nullable

The limit of results to be returned per page

status[eq]string · enum

Search Course with a specific status

Options: Draft, Published

status[in]string · enum[]

Search Course which have the following statuses

privacy[eq]string · enum

Search Course with a specific privacy

Options: Secret, Public

privacy[in]string · enum[]

Search Course which have the following privacy

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://openapi.meltingspot.io/v1/courses'

200

400

200

{
  "total": 1,
  "items": [
    {
      "id": "text",
      "title": "text",
      "description": "text",
      "privacy": "Secret",
      "status": "Draft",
      "navigationMode": "Flexible"
    }
  ]
}

Courses returned successfully

Link groups to a course

Link groups to a course

post

/v1/courses/{courseId}/groups~bulkAdd

Path parameters

courseIdstringrequired

The id of the course

Body

withEmailNotificationboolean

Set to true to send notification mail to each invited members

groupIdsstring[]required

The ids of the groups to link

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/courses/{courseId}/groups~bulkAdd' \
  --header 'Content-Type: application/json' \
  --data '{"groupIds":[null]}'

204

400

204

No body

Groups linked successfully

Unlink groups from a course

Unlink groups from a course

post

/v1/courses/{courseId}/groups~bulkRemove

Path parameters

courseIdstringrequired

The id of the course

Body

groupIdsstring[]required

The ids of the groups to link

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/courses/{courseId}/groups~bulkRemove' \
  --header 'Content-Type: application/json' \
  --data '{"groupIds":[null]}'

204

400

204

No body

Groups unlinked successfully

Get courses participants

Get Courses participants

get

/v1/courses/{courseId}/participants

Path parameters

courseIdstringrequired

The id of the course

Query parameters

pageinteger | nullable

The page number in a paginated set of results

limitinteger | nullable

The limit of results to be returned per page

firstname[in]string[]

The firstnames of spot member to include in the result

lastname[in]string[]

The lastnames of spot member to include in the result

email[in]string[]

The emails of spot member to include in the result

status[eq]string · enum

Search participants with a specific status

Options: Invited, Started, Completed, Unenrolled

status[in]string · enum[]

Search participants with one of theses status

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://openapi.meltingspot.io/v1/courses/{courseId}/participants'

200

400

404

200

{
  "total": 1,
  "items": [
    {
      "id": "text",
      "courseId": "text",
      "spotMemberId": "text",
      "spotMemberEmail": "text",
      "spotMemberFirstname": {},
      "spotMemberLastname": {},
      "invitedAt": "2025-02-21T18:16:43.289Z",
      "startedAt": "2025-02-21T18:16:43.289Z",
      "completedAt": "2025-02-21T18:16:43.289Z",
      "unenrolledAt": "2025-02-21T18:16:43.289Z",
      "lastActivityAt": "2025-02-21T18:16:43.289Z",
      "completionRate": 1,
      "status": "Invited"
    }
  ]
}

Courses participants returned successfully

Invite a member as course participant

Invite a member as Course participant

post

/v1/courses/{courseId}/participants

Path parameters

courseIdstringrequired

The id of the course

Body

spotMemberIdstringrequired

An uuid representing the unique identifier of the spot member to add to course

invitedBySpotMemberIdstring

The Spot member ID on the initiative of the invitation

withEmailNotificationboolean

Set to true to send notification mail to each invited members

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/courses/{courseId}/participants' \
  --header 'Content-Type: application/json' \
  --data '{"spotMemberId":"text"}'

200

201

400

200

No body

Member already invited

Invite multiple members as course participants

Invite a members as Course participants

post

/v1/courses/{courseId}/participants~bulkInvite

Path parameters

courseIdstringrequired

The id of the course

Body

invitedBySpotMemberIdstring

The Spot member ID on the initiative of the invitation

withEmailNotificationboolean

Set to true to send notification mail to each invited members

spotMemberIdsstring[]required

An array of uuid representing the unique identifier of the spot members to add to course

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://openapi.meltingspot.io/v1/courses/{courseId}/participants~bulkInvite' \
  --header 'Content-Type: application/json' \
  --data '{"spotMemberIds":[null]}'

200

201

400

200

No body

Members already invited