Canvas List Calendar Events For User

• pagestring
  Page number or bookmark token for pagination. Use the next_page value from a previous response to fetch subsequent pages.
• typestring
  Type of calendar item to filter by. Use 'event' for general calendar events or 'assignment' for assignments.
• undatedboolean
  If true, only undated events will be returned. This filter is ignored if 'all_events' is true.
• user_idinteger

  Required
  The unique identifier for the Canvas user whose calendar events are to be listed.
• end_datestring
  The end date for filtering events, in ISO 8601 format (e.g., 'YYYY-MM-DDTHH:MM:SSZ' or 'YYYY-MM-DD'). Events occurring on or before this date will be returned. This filter is ignored if 'all_events' is true.
• excludesarray
  Assignment attributes to exclude (e.g., 'description', 'html_url') if items are assignments. No effect on non-assignment events.
• includesarray
  Optional related resources to include in the response (e.g., 'submission', 'assignment_visibility'). E.g., 'submission' adds submission data for assignments.
• per_pageinteger
  Number of calendar events to return per page (max 100).
• all_eventsboolean
  If true, returns all calendar events for the user, overriding 'start_date', 'end_date', and 'undated' filters.
• start_datestring
  The start date for filtering events, in ISO 8601 format (e.g., 'YYYY-MM-DDTHH:MM:SSZ' or 'YYYY-MM-DD'). Events occurring on or after this date will be returned. This filter is ignored if 'all_events' is true.
• blackout_dateboolean
  If true, retrieves only 'blackout dates' (e.g., dates when a course might be unavailable).
• context_codesarray
  Context codes (e.g., 'course_123', 'group_456', 'user_self') to filter events by. If omitted, events from all contexts visible to the user are returned.

• 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 verified related use cases are linked yet.

No published Skills explicitly reference this Action yet.