Canvas LMS icon

Canvas LMS

Work with Canvas LMS API and receive events

Actions57

Overview

This node interacts with the Canvas LMS API to retrieve multiple modules within a specified course. It is designed to fetch a list of modules, optionally including additional details or filtering by search terms. This operation is useful for educators or administrators who want to automate the retrieval and processing of course module data, such as generating reports, syncing content with other systems, or monitoring course structure changes.

For example, an educator could use this node to get all modules in a course along with their items to prepare a syllabus overview or to integrate module information into a learning management dashboard.

Properties

Name Meaning
Course ID The unique identifier of the course from which to retrieve modules.
Additional Fields Optional parameters to customize the request:
- Include Module Items Choose to include either "Items" (the list of module items) or "Content Details" (detailed content info) with each module.
- Search Term A string to filter modules by name, returning only those that match the term.
- Limit Maximum number of modules to return (minimum 1, default 50).

Output

The output is a JSON object containing a data field, which is an array of module objects retrieved from the Canvas LMS API. Each module object includes standard module properties, and depending on the "Include Module Items" option, may also contain nested arrays of module items or detailed content information.

Example output structure:

{
  "data": [
    {
      "id": 123,
      "name": "Module 1",
      "items": [ /* array of module items if included */ ],
      "content_details": { /* detailed content info if included */ },
      ...
    },
    ...
  ]
}

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Canvas LMS API.
  • The node must be configured with the base URL of the Canvas LMS instance and a valid access token.
  • Network connectivity to the Canvas LMS API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Course ID will cause the API call to fail.
    • Insufficient permissions or invalid API token can result in authorization errors.
    • Exceeding rate limits imposed by Canvas LMS API may cause temporary failures.
    • Providing an invalid value for "Include Module Items" or other parameters may lead to unexpected results or errors.

  • Error messages:

    • Errors returned from the Canvas API are wrapped and presented with context, e.g., Error in "module" operation "getAll": <message>.
    • Network or authentication errors will typically indicate failure to connect or unauthorized access.

  • Resolution tips:

    • Verify the Course ID is correct and accessible with the provided credentials.
    • Ensure the API key has sufficient permissions to read modules.
    • Adjust the "Limit" parameter to avoid requesting too many records at once.
    • Check network connectivity and API endpoint configuration.

Links and References

Discussion