Canvas Find Recipients

• pageinteger
  Page number for pagination (1-indexed).
• typestring
  Type of recipient to search for.
• searchstring
  Search terms used for matching users/courses/groups (e.g. "bob smith"). If multiple terms are given (separated via whitespace), only results matching all terms will be returned.
• contextstring
  Limit the search to a particular course/group (e.g. "course_3" or "group_4").
• excludearray
  Array of ids to exclude from the search. These may be user ids or course/group ids prefixed with "course_" or "group_" respectively.
• user_idinteger
  Search for a specific user id. This ignores the other above parameters, and will never return more than one result.
• per_pageinteger
  Number of results per page (max 100). Canvas default is typically 10.
• permissionsarray
  Array of permission strings to be checked for each matched context (e.g. "send_messages"). This argument determines which permissions may be returned in the response; it won't prevent contexts from being returned if they don't grant the permission(s).
• from_conversation_idinteger
  When searching by user_id, only users that could be normally messaged by this user will be returned. This parameter allows you to specify a conversation that will be referenced for a shared context -- if both the current user and the searched user are in the conversation, the us…

• 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

No published Skills explicitly reference this Action yet.

No verified related use cases are linked yet.