Aident logoAident logo centerAident Loadout
Use CasesPricingDocs
ENStart Now
AppsCanvas ToolsCanvas List Users In Course
Canvas Tools

Canvas List Users In Course

Tool to return the paginated list of users in a Canvas course. Use when you need to retrieve users enrolled in a specific course with optional enrollment details.

Write actionRisk level 2 of 5API key connection
Use Canvas List Users In Course

Pricing and limits

Aident logo

Product

Aident LoadoutAident Playbook EditorOpen-CUAK

About

AppsSkillsUse CasesDocsBlogPricingDownloadsPrivacy PolicyTerms of Service

Alternatives

vs Composiovs Zapier
llms.txtGet an AI summary of Aident LoadoutSummarize with ChatGPTSummarize with ClaudeSummarize with GeminiSummarize with Perplexity

© Aident Labs, 2024-2026

Pricing
Free
Unified payment
Not currently supported

Inputs

  • pageinteger
    Page number to fetch (1-indexed). Use to get results beyond the first page.
  • sortstring
    When set, sort the results of the search based on the given field.
  • includearray
    Optionally include additional data with each user: 'enrollments' (includes current and invited enrollments with grades if permitted), 'locked' (enrollment locked status), 'avatar_url' (user avatar), 'bio' (user bio), 'test_student' (course's Test Student if present), 'custom_lin…
  • user_idstring
    If this parameter is given and it corresponds to a user in the course, the page parameter will be ignored and the page containing the specified user will be returned instead.
  • per_pageinteger
    Number of users to return per page (max 100).
  • user_idsarray
    If included, the course users set will only include users with IDs specified by the param. Note: this will not work in conjunction with the 'user_id' argument but multiple user_ids can be included.
  • course_idstring
    Required
    The unique identifier for the Canvas course from which to list users.
  • search_termstring
    The partial name or full ID of the users to match and return in the results list.
  • section_idsarray
    When set, only return users who are enrolled in the given section(s).
  • enrollment_rolestring
    Deprecated. When set, only return users enrolled with the specified course-level role. This can be a role created with the Add Role API or a base role type of 'StudentEnrollment', 'TeacherEnrollment', 'TaEnrollment', 'ObserverEnrollment', or 'DesignerEnrollment'.
  • enrollment_typearray
    When set, only return users where the user is enrolled as this type. 'student_view' implies include[]=test_student. This argument is ignored if enrollment_role is given.
  • enrollment_statearray
    When set, only return users where the enrollment workflow state is of one of the given types. 'active' and 'invited' enrollments are returned by default.

Observable output

  • data
    Required
    Data from the action execution
  • errorstring
    Error if any occurred during the execution of the action
  • successfulboolean
    Required
    Whether or not the action execution was successful or not

Skills that use this Action

Related use cases

No verified related use cases are linked yet.

Official source

Provider source

Skills that use this Action

No published Skills explicitly reference this Action yet.