🗃️Endpoints - Les cours

Lister les cours du Spot

get

Get Courses

Query parameters

pageinteger | nullableoptional

The page number in a paginated set of results

limitinteger | nullableoptional

The limit of results to be returned per page

status[eq]string · enumoptional

Search Course with a specific status

Available options:

status[in]string · enum[]optional

Search Course which have the following statuses

privacy[eq]string · enumoptional

Search Course with a specific privacy

Available options:

privacy[in]string · enum[]optional

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

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

Courses returned successfully

Associer des groupes à un cours

post

Link groups to a course

Path parameters

courseIdstringrequired

The id of the course

Body

groupIdsstring[]required

The ids of the groups to link

withEmailNotificationbooleanoptional

Set to true to send notification mail to each invited members

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": [
      "text"
    ],
    "withEmailNotification": true
  }'

204

400

204

No body

Groups linked successfully

Inviter plusieurs membres à un cours

post

Invite a members as Course participants

Path parameters

courseIdstringrequired

The id of the course

Body

spotMemberIdsstring[]required

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

invitedBySpotMemberIdstringoptional

The Spot member ID on the initiative of the invitation

withEmailNotificationbooleanoptional

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~bulkInvite' \
  --header 'Content-Type: application/json' \
  --data '{
    "spotMemberIds": [
      "text"
    ],
    "invitedBySpotMemberId": "text",
    "withEmailNotification": true
  }'

200

201

400

200

No body

Members already invited

Désassocier des groupes d'un cours

post

Unlink groups from a course

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": [
      "text"
    ]
  }'

204

400

204

No body

Groups unlinked successfully

Lister les participants d'un cours

get

Get Courses participants

Path parameters

courseIdstringrequired

The id of the course

Query parameters

pageinteger | nullableoptional

The page number in a paginated set of results

limitinteger | nullableoptional

The limit of results to be returned per page

firstname[in]string[]optional

The firstnames of spot member to include in the result

lastname[in]string[]optional

The lastnames of spot member to include in the result

email[in]string[]optional

The emails of spot member to include in the result

status[eq]string · enumoptional

Search participants with a specific status

Available options:

status[in]string · enum[]optional

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

{
  "items": [
    {
      "id": "text",
      "courseId": "text",
      "spotMemberId": "text",
      "spotMemberEmail": "text",
      "spotMemberFirstname": {},
      "spotMemberLastname": {},
      "status": "Invited",
      "invitedAt": "2025-04-01T22:21:23.486Z",
      "startedAt": "2025-04-01T22:21:23.486Z",
      "completedAt": "2025-04-01T22:21:23.486Z",
      "unenrolledAt": "2025-04-01T22:21:23.486Z",
      "lastActivityAt": "2025-04-01T22:21:23.486Z",
      "completionRate": 1
    }
  ],
  "total": 1
}

Courses participants returned successfully

Inviter un membre à un cours

post

Invite a member as Course participant

Path parameters

courseIdstringrequired

The id of the course

Body

spotMemberIdstringrequired

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

invitedBySpotMemberIdstringoptional

The Spot member ID on the initiative of the invitation

withEmailNotificationbooleanoptional

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",
    "invitedBySpotMemberId": "text",
    "withEmailNotification": true
  }'

200

201

400

200

No body

Member already invited