filtering canvas through API

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

Find more posts tagged with

API

REST API

Accepted answers

All comments

jerry_nguyen

@aamirghanchi

I'm not quite sure what you mean by "filter the results" or what you're trying to achieve with the API. If you can explain a bit more, I can suggest a better approach.

Otherwise, you can use this endpoint to search for a user by email, login ID, or SIS ID:
/api/v1/accounts/1/users?search_term=EMAIL

aamirghanchi

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.

ColinMurtaugh

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

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?

Unanswered Questions

Concluded Course and Canvas Data Services
Canvas Data Services sent out an alert that a course was concluded (because the course was concluded) and the status of each user in the UI is set to complete, however, the enrollments API endpoint shows the status of each user in the course as active. Is this a common issue? Have I misinterpreted how the individual…
Canvas Media Question
How can one track Canvas Media use without having the reports available from Canvas Studio? Checking API endpoints and the Data 2 schema, there do not seem to be dedicated Canvas Media endpoints. Am I missing some? A method I've considered is using the body field of the wiki_pages table, as this contains the html code of…
Canvas Catalog API - Completed Certificates
Hello, I'm trying to utilize an API call to pull completed certificates and was hoping to download and store the certs as a backup. I can successfully run the API call but it will not allow me to view the certificate unless I access the URL while signed into an account where it's "my" cert. Is there a permissions setting…
UI for weekly progression idea
UI for weekly progression idea that rest in the Schedule tab of the **K-12 UI** of Canvas it's incomplete and I really would not take it and push it into instance but I am going to post it here because in the past people like @James && @robotcars || @Steve_25 have had terrific input in the past... maybe w/their eyes and…
Canvas integration with React + Flask webapp - initially for authenticaiton
I have a new React + Flask webapp. It has its own login for users to start using the app. I have added this as an external tool in Canvas. What I want initially is to see of canvas users can start using the webapp without having to login if they click on the external tool link in a canvas course. I have 2 methods…