The Instructure Community will enter a read-only state on November 22, 2025 as we prepare to migrate to our new Community platform in early December. Read our blog post for more info about this change.
Found this content helpful? Log in or sign up to leave a like!
Hello,
I am trying to retrieve one external tool from the course using tabs API https://canvas.instructure.com/doc/api/tabs.html but somehow it is not there in response. I have already verified that the tool is visible in course navigation, user role is 'Teacher', the number of items in response is 14 and the response has one item with type "external" (but this is not what I need). Am I missing something here? What could be the reason for not getting required tab? Appreciate any possible help in this regards
Vikas
I've used the Tabs API before as a means of reporting how many courses in a sub-account had a certain external tool tab enabled, but my credentials were that of an admin role. My suggestion is that you ask someone if you don't have the means yourself to generate an API key with an admin role and see if the results aren't any different. I'll run my report tool again on a single course to see if I can repeat the issue of less results in the API call with an instructor key than with an admin key in the meantime and report back.
So I can get the same results back no matter which role I'm under. Each time the results come back with all the tabs available to the instructor, enabled or not.
The way I tested was to make the call using my web browser while logged into Canvas. Then the resulting JSON results get copy/pasted to an online JSON->CSV conversion tool. I used JSON to CSV - Convert your JSON to CSV for Free Online
When you use your browser to make the call and copy the results you have to ignore the while(1); expression in the JSON response as that's in there to prevent JSON Hijacking
one more observation: External Tools - Canvas LMS REST API Documentation API returns the tool I need for that course.
@vikas1018 if I make this API call, I do get back results that include LTI apps exposed as "Tabs":
Here is an example of the API call made from Postman:
http://mysite.test.instructure.com/api/v1/courses/1234/tabs
The results of this call include Pearson My Lab and Mastering, Cengage, as well as a custom LTI app.
Can you give details of exactly what information you are looking for regarding the external tool?
Or did the call to External Tools get you what you need?
Community helpTo interact with Panda Bot, our automated chatbot, you need to sign up or log in:
Sign inTo interact with Panda Bot, our automated chatbot, you need to sign up or log in:
Sign in