🗃️Endpoints - Courses
Get courses
Get Courses
The page number in a paginated set of results
The limit of results to be returned per page
Search Course with a specific status
Search Course with a specific privacy
Courses returned successfully
Malformed payload
GET /v1/courses HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
"items": [
{
"id": "text",
"title": "text",
"description": "text",
"privacy": "Secret",
"status": "Draft",
"navigationMode": "Flexible"
}
],
"total": 1
}
Link groups to a course
Link groups to a course
The id of the course
The ids of the groups to link
Set to true to send notification mail to each invited members
Groups linked successfully
Malformed payload
POST /v1/courses/{courseId}/groups~bulkAdd HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 50
{
"groupIds": [
"text"
],
"withEmailNotification": true
}
Aucun contenu
Unlink groups from a course
Unlink groups from a course
The id of the course
The ids of the groups to link
Groups unlinked successfully
Malformed payload
POST /v1/courses/{courseId}/groups~bulkRemove HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"groupIds": [
"text"
]
}
Aucun contenu
Get courses participants
Get Courses participants
The id of the course
The page number in a paginated set of results
The limit of results to be returned per page
The firstnames of spot member to include in the result
The lastnames of spot member to include in the result
The emails of spot member to include in the result
Search participants with a specific status
Courses participants returned successfully
Malformed payload
Course not found
GET /v1/courses/{courseId}/participants HTTP/1.1
Host: openapi.meltingspot.io
Accept: */*
{
"items": [
{
"id": "text",
"courseId": "text",
"spotMemberId": "text",
"spotMemberEmail": "text",
"spotMemberFirstname": {},
"spotMemberLastname": {},
"status": "Invited",
"invitedAt": "2025-08-22T17:45:44.919Z",
"startedAt": "2025-08-22T17:45:44.919Z",
"completedAt": "2025-08-22T17:45:44.919Z",
"unenrolledAt": "2025-08-22T17:45:44.919Z",
"lastActivityAt": "2025-08-22T17:45:44.919Z",
"completionRate": 1
}
],
"total": 1
}
Invite a member as course participant
Invite a member as Course participant
The id of the course
An uuid representing the unique identifier of the spot member to add to course
The Spot member ID on the initiative of the invitation
Set to true to send notification mail to each invited members
Member already invited
Member has been successfully invited
Malformed payload
POST /v1/courses/{courseId}/participants HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 83
{
"spotMemberId": "text",
"invitedBySpotMemberId": "text",
"withEmailNotification": true
}
Aucun contenu
Invite multiple members as course participants
Invite a members as Course participants
The id of the course
An array of uuid representing the unique identifier of the spot members to add to course
The Spot member ID on the initiative of the invitation
Set to true to send notification mail to each invited members
Members already invited
Members has been successfully invited
Malformed payload
POST /v1/courses/{courseId}/participants~bulkInvite HTTP/1.1
Host: openapi.meltingspot.io
Content-Type: application/json
Accept: */*
Content-Length: 86
{
"spotMemberIds": [
"text"
],
"invitedBySpotMemberId": "text",
"withEmailNotification": true
}
Aucun contenu
Mis à jour
Ce contenu vous a-t-il été utile ?