[ARCHIVED] What is an API Call to get a list of users enrolled with a particular course role?

[baxl]

Can anyone share an API call to get a list of users enrolled with a particular course role?  I need to get a list of all users enrolled in courses with a custom created course role called Demo Viewer.  The role is based off of the observer role. 

Thanks!

Lisa

[kona]

Due to the technical nature of this question I'm going to share it with the Canvas Developers​ group in the Community. Hopefully they'll be able to help!

[baxl]

Thank you! 

[garth · Accepted solution]

 @baxl ​ use the Enrollments API, specifically the call to "List enrollments":

• Enrollments - Canvas LMS REST API Documentation

The "role[]" parameter should get you what you are looking for: 

role[]

string

A list of enrollment roles to return. Accepted values include course-level roles created by the Add Role API as well as the base enrollment types accepted by the `type` argument above.

Let me know if this helps.

[baxl]

Is there a way to find a list of users enrolled in an account?  For instance, we have a custom course role called Demo Viewer and I'd like to find all users that are enrolled with that type of role in a sub-account. 

[garth]

 @baxl ​ have you looked at the "Provisioning" report for the sub-account?

Can you use the results for "Enrollments" to filter out what you are looking for?

[baxl]

That's perfect!  That's exactly what I need!  Thanks so much!