Found this content helpful? Log in or sign up to leave a like!

Search API - return Courses with include[] data ?

nbpenn
Community Member

The Course API has a handy [include] parameter that you can use to pass in additional properties you wish to have returned on the Course object: banner_image, course_image, etc. 

Is there a way to pass include parameters to the Search API, so that when you search for Courses, the results contain the additional include parameters?

Something along the lines of:

https://my.canvas.com/api/v1/search/all_courses?search=Test&include[]=banner_image&include[]=course_image

This would be very helpful - otherwise you end up making a ton of additional api calls for each Course object returned from the Search API to pull the include data from the Course API.

Thx

Labels (3)
0 Likes