list_conversations
Retrieve user conversations from Canvas LMS with filtering options for scope, IDs, and participant details to organize message management.
Instructions
List conversations for the current user.
Args:
scope: Conversation scope ("unread", "starred", "sent", "archived", or "all")
filter_ids: Optional list of conversation IDs to filter by
filter_mode: How to apply filter_ids ("and" or "or")
include_participants: Include participant information
include_all_ids: Include all conversation participant IDs
Returns:
List of conversations
Input Schema
Name | Required | Description | Default |
---|---|---|---|
filter_ids | No | ||
filter_mode | No | and | |
include_all_ids | No | ||
include_participants | No | ||
scope | No | unread |
Input Schema (JSON Schema)
{
"properties": {
"filter_ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Filter Ids"
},
"filter_mode": {
"default": "and",
"title": "Filter Mode",
"type": "string"
},
"include_all_ids": {
"default": false,
"title": "Include All Ids",
"type": "boolean"
},
"include_participants": {
"default": true,
"title": "Include Participants",
"type": "boolean"
},
"scope": {
"default": "unread",
"title": "Scope",
"type": "string"
}
},
"type": "object"
}