filtering canvas through API

Question

Hi I am very very new to Canvas. I have some API experience using Msft Power Automate. I would prefer not to use pagination and would rather filter my results from the get-go. How do I filter the users based on their email address… say in:

https://MySite.instructure.com/api/v1/accounts/1/users/

Would the regular Odata $filter parameter work. I tried that, but it didnt do anything.

Thanks

aamirghanchi · Answer

Hi Colin, can you give an example how the search term is used to filter users based on their login_id/SIS ID/email address?

ColinMurtaugh · Answer

As Jerry says you can use the search_term parameter to retrieve a subset of users that match your query.  The users endpoint doesn't have a login_id parameter, so that won't work.

See the documentation for the users endpoint here, including the list of valid request parameters: https://developerdocs.instructure.com/services/canvas/resources/users#method.users.api_index

aamirghanchi · Answer

Thank you, Jerry. I have used the login_id parameter to filter for  login id which I am sure is there in Canvas. But the API calls is bringing in all the results.

http://https//MySite.instructure.com/accounts/1/users/?login_id=aamirghanchi%40mydomain.com

By "filtering" I simply mean I want to return only select users, not all users.