Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/canvas-external-tools-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Canvas LMS REST External Tools API
version: v1
summary: The complete Canvas LMS REST API, converted from the Swagger 1.2 documents Instructure publishes under https://canvas.instructure.com/doc/api/.
description: The Canvas LMS REST API covers courses, assignments, quizzes, grades, users, enrollments, accounts, files, modules, rubrics, submissions, SIS imports, LTI, analytics and account administration.
contact:
name: Instructure Canvas
url: https://canvas.instructure.com/doc/api/
license:
name: AGPL-3.0
url: https://github.com/instructure/canvas-lms/blob/master/LICENSE
servers:
- url: https://canvas.instructure.com/api
description: Instructure-hosted Canvas (canvas.instructure.com)
- url: https://{canvas_host}/api
description: Any Canvas instance; Canvas is multi-tenant and self-hostable, so the host is the institution's Canvas domain.
variables:
canvas_host:
default: canvas.instructure.com
description: Your institution's Canvas hostname, e.g. school.instructure.com
security:
- bearerAuth: []
- oauth2: []
tags:
- name: External Tools
x-resource: external_tools
externalDocs:
url: https://canvas.instructure.com/doc/api/external_tools.html
paths:
/v1/courses/{course_id}/external_tools:
get:
tags:
- External Tools
operationId: list_external_tools_courses
summary: List external tools
description: 'Returns the paginated list of external tools for the current context.
See the get request docs for a single tool for a list of properties on an external tool.'
parameters:
- name: course_id
in: path
schema:
type: string
required: true
description: ID
- name: search_term
in: query
schema:
type: string
required: false
description: The partial name of the tools to match and return.
- name: selectable
in: query
schema:
type: boolean
required: false
description: If true, then only tools that are meant to be selectable are returned.
- name: include_parents
in: query
schema:
type: boolean
required: false
description: If true, then include tools installed in all accounts above the current context
- name: placement
in: query
schema:
type: string
required: false
description: 'The placement type to filter by.
Return all tools at the current context as well as all tools from the parent, and filter the tools list to only those with a placement of ''editor_button'''
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ContextExternalTool'
externalDocs:
url: https://canvas.instructure.com/doc/api/external_tools.html
post:
tags:
- External Tools
operationId: create_external_tool_courses
summary: Create an external tool
description: 'Create an external tool in the specified course/account.
The created tool will be returned, see the "show" endpoint for an example.
If a client ID is supplied canvas will attempt to create a context external
tool using the LTI 1.3 standard.
See the Placements Documentation for more information on what
placements are available, the possible fields, and their accepted values.'
parameters:
- name: course_id
in: path
schema:
type: string
required: true
description: ID
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
client_id:
type: string
description: 'The client id is attached to the developer key.
If supplied all other parameters are unnecessary and will be ignored'
name:
type: string
description: The name of the tool
privacy_level:
type: string
enum:
- anonymous
- name_only
- email_only
- public
description: How much user information to send to the external tool.
consumer_key:
type: string
description: The consumer key for the external tool
shared_secret:
type: string
description: The shared secret with the external tool
description:
type: string
description: A description of the tool
url:
type: string
description: 'The url to match links against. Either "url" or "domain" should be set,
not both.'
domain:
type: string
description: 'The domain to match links against. Either "url" or "domain" should be
set, not both.'
icon_url:
type: string
description: The url of the icon to show for this tool
text:
type: string
description: The default text to show for this tool
custom_fields[field_name]:
type: string
description: 'Custom fields that will be sent to the tool consumer; can be used
multiple times'
is_rce_favorite:
type: boolean
description: '(Deprecated in favor of {api:ExternalToolsController#mark_rce_favorite Mark tool to RCE Favorites} and
{api:ExternalToolsController#unmark_rce_favorite Unmark tool from RCE Favorites})
Whether this tool should appear in a preferred location in the RCE.
This only applies to tools in root account contexts that have an editor
button placement.'
<placement_name>[<placement_configuration_key>]:
type: string
x-canvas-declared-type: variable
description: Set the <placement_configuration_key> value for a specific placement.
config_type:
type: string
enum:
- by_url
- by_xml
description: 'Configuration can be passed in as Common Cartridge XML instead of using query
parameters. If this value is "by_url" or "by_xml" then an XML
configuration will be expected in either the "config_xml" or "config_url"
parameter. Note that the name parameter overrides the tool name provided
in the XML.'
config_xml:
type: string
description: 'XML tool configuration, as specified in the Common Cartridge XML specification. This is
required if "config_type" is set to "by_xml"'
config_url:
type: string
description: 'URL where the server can retrieve an XML tool configuration, as specified
in the Common Cartridge XML specification. This is required if "config_type" is set to
"by_url"'
not_selectable:
type: boolean
description: 'Default: false. If set to true, and if resource_selection is set to false,
the tool won''t show up in the external tool
selection UI in modules and assignments'
oauth_compliant:
type: boolean
description: 'Default: false, if set to true LTI query params will not be copied to the
post body.'
unified_tool_id:
type: string
description: The unique identifier for the tool in LearnPlatform
required:
- client_id
- name
- privacy_level
- consumer_key
- shared_secret
application/x-www-form-urlencoded:
schema:
type: object
properties:
client_id:
type: string
description: 'The client id is attached to the developer key.
If supplied all other parameters are unnecessary and will be ignored'
name:
type: string
description: The name of the tool
privacy_level:
type: string
enum:
- anonymous
- name_only
- email_only
- public
description: How much user information to send to the external tool.
consumer_key:
type: string
description: The consumer key for the external tool
shared_secret:
type: string
description: The shared secret with the external tool
description:
type: string
description: A description of the tool
url:
type: string
description: 'The url to match links against. Either "url" or "domain" should be set,
not both.'
domain:
type: string
description: 'The domain to match links against. Either "url" or "domain" should be
set, not both.'
icon_url:
type: string
description: The url of the icon to show for this tool
text:
type: string
description: The default text to show for this tool
custom_fields[field_name]:
type: string
description: 'Custom fields that will be sent to the tool consumer; can be used
multiple times'
is_rce_favorite:
type: boolean
description: '(Deprecated in favor of {api:ExternalToolsController#mark_rce_favorite Mark tool to RCE Favorites} and
{api:ExternalToolsController#unmark_rce_favorite Unmark tool from RCE Favorites})
Whether this tool should appear in a preferred location in the RCE.
This only applies to tools in root account contexts that have an editor
button placement.'
<placement_name>[<placement_configuration_key>]:
type: string
x-canvas-declared-type: variable
description: Set the <placement_configuration_key> value for a specific placement.
config_type:
type: string
enum:
- by_url
- by_xml
description: 'Configuration can be passed in as Common Cartridge XML instead of using query
parameters. If this value is "by_url" or "by_xml" then an XML
configuration will be expected in either the "config_xml" or "config_url"
parameter. Note that the name parameter overrides the tool name provided
in the XML.'
config_xml:
type: string
description: 'XML tool configuration, as specified in the Common Cartridge XML specification. This is
required if "config_type" is set to "by_xml"'
config_url:
type: string
description: 'URL where the server can retrieve an XML tool configuration, as specified
in the Common Cartridge XML specification. This is required if "config_type" is set to
"by_url"'
not_selectable:
type: boolean
description: 'Default: false. If set to true, and if resource_selection is set to false,
the tool won''t show up in the external tool
selection UI in modules and assignments'
oauth_compliant:
type: boolean
description: 'Default: false, if set to true LTI query params will not be copied to the
post body.'
unified_tool_id:
type: string
description: The unique identifier for the tool in LearnPlatform
required:
- client_id
- name
- privacy_level
- consumer_key
- shared_secret
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ContextExternalTool'
externalDocs:
url: https://canvas.instructure.com/doc/api/external_tools.html
/v1/accounts/{account_id}/external_tools:
get:
tags:
- External Tools
operationId: list_external_tools_accounts
summary: List external tools
description: 'Returns the paginated list of external tools for the current context.
See the get request docs for a single tool for a list of properties on an external tool.'
parameters:
- name: account_id
in: path
schema:
type: string
required: true
description: ID
- name: search_term
in: query
schema:
type: string
required: false
description: The partial name of the tools to match and return.
- name: selectable
in: query
schema:
type: boolean
required: false
description: If true, then only tools that are meant to be selectable are returned.
- name: include_parents
in: query
schema:
type: boolean
required: false
description: If true, then include tools installed in all accounts above the current context
- name: placement
in: query
schema:
type: string
required: false
description: 'The placement type to filter by.
Return all tools at the current context as well as all tools from the parent, and filter the tools list to only those with a placement of ''editor_button'''
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ContextExternalTool'
externalDocs:
url: https://canvas.instructure.com/doc/api/external_tools.html
post:
tags:
- External Tools
operationId: create_external_tool_accounts
summary: Create an external tool
description: 'Create an external tool in the specified course/account.
The created tool will be returned, see the "show" endpoint for an example.
If a client ID is supplied canvas will attempt to create a context external
tool using the LTI 1.3 standard.
See the Placements Documentation for more information on what
placements are available, the possible fields, and their accepted values.'
parameters:
- name: account_id
in: path
schema:
type: string
required: true
description: ID
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
client_id:
type: string
description: 'The client id is attached to the developer key.
If supplied all other parameters are unnecessary and will be ignored'
name:
type: string
description: The name of the tool
privacy_level:
type: string
enum:
- anonymous
- name_only
- email_only
- public
description: How much user information to send to the external tool.
consumer_key:
type: string
description: The consumer key for the external tool
shared_secret:
type: string
description: The shared secret with the external tool
description:
type: string
description: A description of the tool
url:
type: string
description: 'The url to match links against. Either "url" or "domain" should be set,
not both.'
domain:
type: string
description: 'The domain to match links against. Either "url" or "domain" should be
set, not both.'
icon_url:
type: string
description: The url of the icon to show for this tool
text:
type: string
description: The default text to show for this tool
custom_fields[field_name]:
type: string
description: 'Custom fields that will be sent to the tool consumer; can be used
multiple times'
is_rce_favorite:
type: boolean
description: '(Deprecated in favor of {api:ExternalToolsController#mark_rce_favorite Mark tool to RCE Favorites} and
{api:ExternalToolsController#unmark_rce_favorite Unmark tool from RCE Favorites})
Whether this tool should appear in a preferred location in the RCE.
This only applies to tools in root account contexts that have an editor
button placement.'
<placement_name>[<placement_configuration_key>]:
type: string
x-canvas-declared-type: variable
description: Set the <placement_configuration_key> value for a specific placement.
config_type:
type: string
enum:
- by_url
- by_xml
description: 'Configuration can be passed in as Common Cartridge XML instead of using query
parameters. If this value is "by_url" or "by_xml" then an XML
configuration will be expected in either the "config_xml" or "config_url"
parameter. Note that the name parameter overrides the tool name provided
in the XML.'
config_xml:
type: string
description: 'XML tool configuration, as specified in the Common Cartridge XML specification. This is
required if "config_type" is set to "by_xml"'
config_url:
type: string
description: 'URL where the server can retrieve an XML tool configuration, as specified
in the Common Cartridge XML specification. This is required if "config_type" is set to
"by_url"'
not_selectable:
type: boolean
description: 'Default: false. If set to true, and if resource_selection is set to false,
the tool won''t show up in the external tool
selection UI in modules and assignments'
oauth_compliant:
type: boolean
description: 'Default: false, if set to true LTI query params will not be copied to the
post body.'
unified_tool_id:
type: string
description: The unique identifier for the tool in LearnPlatform
required:
- client_id
- name
- privacy_level
- consumer_key
- shared_secret
application/x-www-form-urlencoded:
schema:
type: object
properties:
client_id:
type: string
description: 'The client id is attached to the developer key.
If supplied all other parameters are unnecessary and will be ignored'
name:
type: string
description: The name of the tool
privacy_level:
type: string
enum:
- anonymous
- name_only
- email_only
- public
description: How much user information to send to the external tool.
consumer_key:
type: string
description: The consumer key for the external tool
shared_secret:
type: string
description: The shared secret with the external tool
description:
type: string
description: A description of the tool
url:
type: string
description: 'The url to match links against. Either "url" or "domain" should be set,
not both.'
domain:
type: string
description: 'The domain to match links against. Either "url" or "domain" should be
set, not both.'
icon_url:
type: string
description: The url of the icon to show for this tool
text:
type: string
description: The default text to show for this tool
custom_fields[field_name]:
type: string
description: 'Custom fields that will be sent to the tool consumer; can be used
multiple times'
is_rce_favorite:
type: boolean
description: '(Deprecated in favor of {api:ExternalToolsController#mark_rce_favorite Mark tool to RCE Favorites} and
{api:ExternalToolsController#unmark_rce_favorite Unmark tool from RCE Favorites})
Whether this tool should appear in a preferred location in the RCE.
This only applies to tools in root account contexts that have an editor
button placement.'
<placement_name>[<placement_configuration_key>]:
type: string
x-canvas-declared-type: variable
description: Set the <placement_configuration_key> value for a specific placement.
config_type:
type: string
enum:
- by_url
- by_xml
description: 'Configuration can be passed in as Common Cartridge XML instead of using query
parameters. If this value is "by_url" or "by_xml" then an XML
configuration will be expected in either the "config_xml" or "config_url"
parameter. Note that the name parameter overrides the tool name provided
in the XML.'
config_xml:
type: string
description: 'XML tool configuration, as specified in the Common Cartridge XML specification. This is
required if "config_type" is set to "by_xml"'
config_url:
type: string
description: 'URL where the server can retrieve an XML tool configuration, as specified
in the Common Cartridge XML specification. This is required if "config_type" is set to
"by_url"'
not_selectable:
type: boolean
description: 'Default: false. If set to true, and if resource_selection is set to false,
the tool won''t show up in the external tool
selection UI in modules and assignments'
oauth_compliant:
type: boolean
description: 'Default: false, if set to true LTI query params will not be copied to the
post body.'
unified_tool_id:
type: string
description: The unique identifier for the tool in LearnPlatform
required:
- client_id
- name
- privacy_level
- consumer_key
- shared_secret
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ContextExternalTool'
externalDocs:
url: https://canvas.instructure.com/doc/api/external_tools.html
/v1/groups/{group_id}/external_tools:
get:
tags:
- External Tools
operationId: list_external_tools_groups
summary: List external tools
description: 'Returns the paginated list of external tools for the current context.
See the get request docs for a single tool for a list of properties on an external tool.'
parameters:
- name: group_id
in: path
schema:
type: string
required: true
description: ID
- name: search_term
in: query
schema:
type: string
required: false
description: The partial name of the tools to match and return.
- name: selectable
in: query
schema:
type: boolean
required: false
description: If true, then only tools that are meant to be selectable are returned.
- name: include_parents
in: query
schema:
type: boolean
required: false
description: If true, then include tools installed in all accounts above the current context
- name: placement
in: query
schema:
type: string
required: false
description: 'The placement type to filter by.
Return all tools at the current context as well as all tools from the parent, and filter the tools list to only those with a placement of ''editor_button'''
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ContextExternalTool'
externalDocs:
url: https://canvas.instructure.com/doc/api/external_tools.html
/v1/courses/{course_id}/external_tools/sessionless_launch:
get:
tags:
- External Tools
operationId: get_sessionless_launch_url_for_external_tool_courses
summary: Get a sessionless launch url for an external tool
description: 'Returns a sessionless launch url for an external tool.
Prefers the resource_link_lookup_uuid, but defaults to the other passed
parameters id, url, and launch_type
NOTE: Either the resource_link_lookup_uuid, id, or url must be provided unless launch_type is assessment or module_item.'
parameters:
- name: course_id
in: path
schema:
type: string
required: true
description: ID
- name: id
in: query
schema:
type: string
required: false
description: The external id of the tool to launch.
- name: url
in: query
schema:
type: string
required: false
description: The LTI launch url for the external tool.
- name: assignment_id
in: query
schema:
type: string
required: false
description: The assignment id for an assignment launch. Required if launch_type is set to "assessment".
- name: module_item_id
in: query
schema:
type: string
required: false
description: The assignment id for a module item launch. Required if launch_type is set to "module_item".
- name: launch_type
in: query
schema:
type: string
enum:
- assessment
- module_item
required: false
description: 'The type of launch to perform on the external tool. Placement names (eg. "course_navigation")
can also be specified to use the custom launch url for that placement; if done, the tool id
must be provided.'
- name: resource_link_lookup_uuid
in: query
schema:
type: string
required: false
description: The identifier to lookup a resource link.
responses:
'200':
description: Success, no content returned
externalDocs:
url: https://canvas.instructure.com/doc/api/external_tools.html
/v1/accounts/{account_id}/external_tools/sessionless_launch:
get:
tags:
- External Tools
operationId: get_sessionless_launch_url_for_external_tool_accounts
summary: Get a sessionless launch url for an external tool
description: 'Returns a sessionless launch url for an external tool.
Prefers the resource_link_lookup_uuid, but defaults to the other passed
parameters id, url, and launch_type
NOTE: Either the resource_link_lookup_uuid, id, or url must be provided unless launch_type is assessment or module_item.'
parameters:
- name: account_id
in: path
schema:
type: string
required: true
description: ID
- name: id
in: query
schema:
type: string
required: false
description: The external id of the tool to launch.
- name: url
in: query
schema:
type: string
required: false
description: The LTI launch url for the external tool.
- name: assignment_id
in: query
schema:
type: string
required: false
description: The assignment id for an assignment launch. Required if launch_type is set to "assessment".
- name: module_item_id
in: query
schema:
type: string
required: false
description: The assignment id for a module item launch. Required if launch_type is set to "module_item".
- name: launch_type
in: query
schema:
type: string
enum:
- assessment
- module_item
required: false
description: 'The type of launch to perform on the external tool. Placement names (eg. "course_navigation")
can also be specified to use the custom launch url for that placement; if done, the tool id
must be provided.'
- name: resource_link_lookup_uuid
in: query
schema:
type: string
required: false
description: The identifier to lookup a resource link.
responses:
'200':
description: Success, no content returned
externalDocs:
url: https://canvas.instructure.com/doc/api/external_tools.html
/v1/courses/{course_id}/external_tools/{external_tool_id}:
get:
tags:
- External Tools
operationId: get_single_external_tool_courses
summary: Get a single external tool
description: Returns the specified external tool.
parameters:
- name: course_id
in: path
schema:
type: string
required: true
description: ID
- name: external_tool_id
in: path
schema:
type: string
required: true
description: ID
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ContextExternalTool'
externalDocs:
url: https://canvas.instructure.com/doc/api/external_tools.html
put:
tags:
- External Tools
operationId: edit_external_tool_courses
summary: Edit an external tool
# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/openapi/canvas-external-tools-api-openapi.yml