Skip to content
Proud to collaborate with Microsoft for Startups

data.chat.conversations.list ​

Paginated list of chat conversations for a (org, user) pair

List ChatConversation rows owned by a (organization, user) pair.

Inputs:

  • organization_uuid: Organization UUID (required).
  • user_uuid: User UUID (required); conversations are scoped to this user as owner.
  • cursor: Opaque pagination token from a previous page (optional).
  • limit: Page size (optional, default 20, min 1, max 100).
  • include_archived: When True include archived threads (default False).

Outputs (terminal state_data):

  • conversations: list of dicts ordered by updated_at DESC. Each item: {conversation_uuid, title, created_at (iso), updated_at (iso), last_message_preview (str|null), message_count (int), archived (bool)}
  • next_cursor: opaque cursor for the next page, or null when exhausted
  • total_estimate: approximate count for the (org, user, archived) slice; capped at 10,000 to keep the response cheap
  • error: str | None (only on the ReadOnlyDataWorkflow soft-error path)

Failure modes (raised as WorkflowBusinessError with stable codes):

  • organization_not_found_or_unauthorized — user is not a member of the org
  • invalid_cursor — cursor cannot be decoded

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-chat
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID (string form)
user_uuiduuidNo—User UUID (string form) — conversations scoped to this user
cursorstringNo—Opaque pagination cursor from a previous page
limitintegerNo20Page size (1..100, default 20)
include_archivedbooleanNoFalseWhen True, include archived conversations

Output Schema ​

FieldTypeRequiredDefaultDescription
conversationslistYes—Conversation public dicts, ordered by updated_at DESC
next_cursorstringNo—Cursor for the next page, or null when exhausted
total_estimateintegerYes—Approximate total rows in the (org,user,archived) slice
errorstringNo—Error message when query failed
error_typestringNo—Error class name when query failed

States ​

StateInitialTerminalSuccessAuto-advanceDescription
doneYesYesYes——

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "data.chat.conversations.list",
  "initial_data": {
    "organization_uuid": "value"
  }
}