The page number to return (1-indexed). Defaults to 1 if not provided.
orderstring
Sorts the accounts by id or name. Only applies when recursive is false. Defaults to id.
includearray
Array of additional information to include. 'course_count' returns the number of courses directly under each account. 'sub_account_count' returns the number of sub-accounts directly under each account.
per_pageinteger
The number of results to return per page (max 100). Defaults to 10 if not provided.
recursiveboolean
If true, the entire account tree underneath this account will be returned (though still paginated). If false, only direct sub-accounts of this account will be returned. Defaults to false.
account_idstring
Required
The unique identifier of the Canvas account for which to retrieve sub-accounts.
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