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[in] array[string]

  The firstnames of spot member to include in the result

• lastname[in] array[string]

  The lastnames of spot member to include in the result

• email[in] array[string]

  The emails of spot member to include in the result

• 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