List Learning path participants

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://help-api.meltingspot.io/mcp

Standard setup for AI tools providing an mcp.json file

{
  "API MCP server": {
    "url": "https://help-api.meltingspot.io/mcp"
  }
}

GET /v1/learningPaths/{learningPathId}/participants

List Learning path participants

Path parameters

learningPathId string Required

The id of the learning path

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
firstname object

Filters on firstname
Hide firstname attribute Show firstname attribute object
- firstname[in] array[string]
  
  The firstnames of spot member to include in the result
lastname object

Filters on lastname
Hide lastname attribute Show lastname attribute object
- lastname[in] array[string]
  
  The lastnames of spot member to include in the result
email object

Filters on email
Hide email attribute Show email attribute object
- email[in] array[string]
  
  The emails of spot member to include in the result
status object

Filters on status
Hide status attributes Show status attributes object
- status[eq] string
  
  Search participants with a specific status
  
  Values are Invited, Started, Completed, or Unenrolled.
- status[in] array[string]
  
  Search participants with one of these status
  
  Values are Invited, Started, Completed, or Unenrolled.

Responses

200 application/json

Learning path participants 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 learning path participant.
  
  learningPathId string Required
  
  The id of the learning path.
  
  spotMemberId string Required
  
  The ID of the Spot member associated to the participant
  
  spotMemberEmail string Required
  
  The email of the Spot member associated to the participant
  
  spotMemberFirstname object | null Required
  
  The Spot member firstname associated to the participant. Can be null for a participant invited by email.
  
  spotMemberLastname object | null Required
  
  The Spot member lastname associated to the participant. Can be null for a participant invited by email.
  
  status string Required
  
  The status of the learning path participant.
  
  Values are Invited, Started, Completed, or Unenrolled.
  
  invitedAt integer | null Required
  
  Timestamp in ms of invitation date of the participant.
  
  startedAt integer | null Required
  
  Timestamp in ms of start date of the participant.
  
  completedAt integer | null Required
  
  Timestamp in ms of completion date of the participant.
  
  unenrolledAt integer | null Required
  
  Timestamp in ms of unenrollment date of the participant.
  
  lastActivityAt integer | null Required
  
  Timestamp in ms of last activity date of the participant.
  
  completionRate integer Required
  
  The completion rate of the participant.
- total integer Required
  
  The total number of items found
400

Malformed payload
401

Unauthorized
403

Forbidden
404

Learning path not found

GET /v1/learningPaths/{learningPathId}/participants

curl \
 --request GET 'https://openapi.meltingspot.io/v1/learningPaths/{learningPathId}/participants'

Response examples (200)

{
  "items": [
    {
      "id": "string",
      "learningPathId": "string",
      "spotMemberId": "string",
      "spotMemberEmail": "string",
      "spotMemberFirstname": {},
      "spotMemberLastname": {},
      "status": "Invited",
      "invitedAt": 42,
      "startedAt": 42,
      "completedAt": 42,
      "unenrolledAt": 42,
      "lastActivityAt": 42,
      "completionRate": 42
    }
  ],
  "total": 42
}