Members

Get members

• GET /api/v1/members returns all members.
• GET /api/v1/courses/{courseId}/members returns the members in the specified course.

Get member

• GET /api/v1/members/me returns the current member.
• GET /api/v1/members/{memberId} returns the specified member.

Create member

• POST /api/v1/members creates a new member.
• POST /api/v1/courses/{courseId}/members creates a member and add it to the specified course as learner.
• POST /api/v1/programs/{programId}/members creates a member and add it to the specified program as learner.

The required parameter for this operation is email.

You can pass the optional parameters name and company. If you don't, the API extracts the member's name from their email address.

We recommend setting the locale parameter, so the member receives their invitation email in the correct language. Please check our list of supported locales.

Invite member

This API allows you (re)send the invitation email to your members. This email will include the activation link, so your members can join the academy, course or program, and start learning right away.

• POST /api/v1/members/{memberId}/invite sends an email invite the specified member.
• POST /api/v1/courses/{courseId}/members/{memberId}/invite sends an email invite the specified member.
• POST /api/v1/programs/{programId}/members/{memberId}/invite sends an email invite the specified member.

Update member

• POST /api/v1/members/{memberId} updates the specified member.

Course participation

• POST /api/v1/courses/{courseId}/members/{memberId}/coursemember adds the specified member to the specified course.
• DELETE /api/v1/courses/{courseId}/members/{memberId}/coursemember removes the specified member from the specified course. Beware: this also deletes the learning results for that member.

Program participation

• POST /api/v1/programs/{programId}/members/{memberId}/programmember adds the specified member to the specified program.
• DELETE /api/v1/programs/{programId}/members/{memberId}/programmember removes the specified member from the specified program.

Groups

• GET /api/v1/members/{memberId}/groups returns the groups for the specified member.
• POST /api/v1/members/{memberId}/groups adds a group to the specified member. Use the required parameter name to identify the name of the group.
  
• DELETE /api/v1/members/{memberId}/groups removes a group from the specified member. Use the optional parameter name to remove a particular group. Omit the parameter name to remove all groups from the member.