API to fetch enrollment Id for an user (or) enrollment details.


Problem Statement:

How to get the  enrollment Id for an user (or) enrollment details of an user.

Role: Integration Admin user.

Brief Description:

There are cases where customers wanted to know more details about enrollment of an user for a specific course. In order to fetch this infromation, the enrollment ID needs to provided in the api call.  This article explains how an integration admin can fetch the enrollment Id for an user.

Steps to be carried out by the Integration admin to fetch the enrollment ID.

1. log in as Integration Admin.
2. Select Developer Resources < API reference
3. Switch to V2 API
4. Authorize as Admin
5. Click on User : Set of User API >
6. Click on GET /users/{id}/enrollments

7. Under Parameters >>ID >>enter the User ID as shown in the below screenshot.

Click on try it out and you will get the results.

Note: You can leave all the parameters empty and click on try it out and you will get details of users all enrollments in the API response.

Please refer the below api response to know how an enrollment Id looks like. The User will have specific enrollment Id for each of his enrollment (An user will have different enrollment ID for different course)

For more clarity, please refer to the below video.

Leave a Reply

Your email address will not be published. Required fields are marked *