Tabs API

A Tab object looks like:

{
  "html_url": "/courses/1/external_tools/4",
  "id": "context_external_tool_4",
  "label": "WordPress",
  "type": "external"
}

List available tabs for a course or group TabsController#index

GET /api/v1/courses/:course_id/tabs

GET /api/v1/groups/:group_id/tabs

Returns a list of navigation tabs available in the current context.

(Only has effect for courses, not groups)

Request Parameters:

  • include[]
    "external"

    Optionally include external tool tabs in the returned list of tabs

Example Request:

curl -H 'Authorization: Bearer <token>' \ 
     https://<canvas>/api/v1/courses/<course_id>/tabs\?include\="external"

curl -H 'Authorization: Bearer <token>' \ 
     https://<canvas>/api/v1/groups/<group_id>/tabs"

Example Response:

[
  {
    "html_url": "/courses/1",
    "id": "home",
    "label": "Home",
    "type": "internal"
  },
  {
    "html_url": "/courses/1/external_tools/4",
    "id": "context_external_tool_4",
    "label": "WordPress",
    "type": "external"
  },
  {
    "html_url": "/courses/1/grades",
    "id": "grades",
    "label": "Grades",
    "type": "internal"
  }
]