v10

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-0582185581.9 KB
Conversations

List all conversations

Retrieve paginated conversations for the authenticated user.

Overview:

Use the optional source query parameter to choose which list to return: owned — only conversations you own (userId matches the current user). shared — conversations where you have recipient access (isShared and your user appears in sharedWith), without the owner-only branch. Defaults to owned when omitted. Each call returns one list; call twice if you need both.

Filtering:

  • Only non-archived conversations are returned by default
  • Use /conversations/show/archives for archived conversations

Sorting:

Conversations are sorted by last activity timestamp (most recent first) by default.

get/conversations

Query parameters

source'owned' | 'shared'

owned — owner list (userId filter only). shared — explicit share grant list (isShared + sharedWith). Defaults to owned when omitted.

pageinteger

Page number (1-based). Defaults to 1.

limitinteger

Page size. Defaults to 20; capped by the server (max 100).

sortBy'createdAt' | 'lastActivityAt' | 'title'

Sort field. Invalid values fall back to lastActivityAt.

sortOrder'asc' | 'desc'

Sort direction. Defaults to desc unless set to asc.

conversationIdstring

When set, restricts results to that conversation ID (if visible under the chosen source).

searchstring

Case-insensitive match on title and message content (max 1000 characters).

startDatestring date-time

Filter by createdAt ≥ this ISO date.

endDatestring date-time

Filter by createdAt ≤ this ISO date.

sharedstring

When set, filters by isShared. Accepts case-insensitive true/false, or 1/0.

Response

List of conversations for the requested source

source'owned' | 'shared' required

Echoes the requested source query value.