Aident logoAident logo centerAident Loadout
Use CasesPricingDocs
ENStart Now
AppsCanvas ToolsCanvas List Section Enrollments
Canvas Tools

Canvas List Section Enrollments

Tool to retrieve a paginated list of enrollments for a specific section. Use when you need to query section enrollments with filters like type, state, or role.

Write actionRisk level 2 of 5API key connection
Use Canvas List Section Enrollments

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).
  • rolearray
    Filter by enrollment roles. Accepts course-level roles created via Add Role API and base enrollment types. Overrides type parameter if provided.
  • typearray
    Filter by enrollment type. Returns all types if omitted. Ignored if role parameter is provided.
  • statearray
    Filter by enrollment state. Defaults to active and invited if omitted. Some synthetic states are only supported when querying user enrollments.
  • includearray
    Array of additional information to include on enrollment or user records. 'avatar_url' and 'group_ids' are returned on the user record. 'current_points' includes current_points and unposted_current_points in grades hash for student enrollments.
  • user_idstring
    Filter by user_id. Only valid for course or section enrollment queries. If set to current user's id, determines if user has any enrollments independent of roster view permissions.
  • per_pageinteger
    Number of enrollments to return per page (max 100).
  • section_idstring
    Required
    The ID of the section to list enrollments for.
  • sis_user_idarray
    Returns only enrollments for specified SIS user ID(s). May pass array or string.
  • sis_course_idarray
    Returns only enrollments matching specified SIS course ID(s). May pass array or string.
  • sis_account_idarray
    Returns only enrollments for specified SIS account ID(s). Does not look into sub_accounts. May pass array or string.
  • sis_section_idarray
    Returns only section enrollments matching specified SIS section ID(s). May pass array or string.

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.