canvas::API method account list (public)

 <instance of canvas::API> account list [ -page page ] \
    [ -per_page per_page ] [ -max_entries max_entries ]

Defined in packages/xooauth/tcl/canvas-procs.tcl

A paginated list of accounts that the current user can view or manage. Typically, students and even teachers will get an empty list in response, only account admins can view the accounts that they are in. Details: https://canvas.instructure.com/doc/api/accounts.html

Switches:

-page (optional, defaults to "1")

Return the nth page of the result set

-per_page (optional, defaults to "10")

Return this number of entries per page

-max_entries (optional)

perform potentially multiple requests until the requested number of entries can be returned.

Testcases:

No testcase defined.

Source code:

set r [:request -method GET -token ${:token}  -url /accounts?[:params {page per_page}]]
return [:paginated_result_list -max_entries $max_entries $r 200]

XQL Not present:

Generic, PostgreSQL, Oracle