Actions94
- Account Actions
- Auth Actions
- Analytics Actions
- Chat Actions
- Feed Actions
- Graph Actions
- Identity Actions
- List Actions
- Label Actions
- Lexicon Actions
- Moderation Actions
- Notification Actions
- Post Actions
- Preferences Actions
- Repo Actions
- Search Actions
- Sync Actions
- User Actions
Chat → List Conversations
AI-generatedSummary
Retrieve a paginated list of chat conversations filtered by read state and status.
Inputs
- limit — Maximum number of conversations to return, with a minimum of 1 (default 50).
- cursor — Cursor string for pagination to fetch the next page of results.
- readState — Filter conversations by read state, either all or only unread conversations (default is all).
- status — Filter conversations by status, showing all, only accepted conversations, or only conversation requests (default is all).
Output shape
a list of conversation objects representing chat threads matching the specified filters and pagination parameters
The results respect pagination via the 'cursor' parameter and size limited by 'limit'. Filters for read state and status are optional and default to showing all conversations.
Examples
Example 1: List up to 30 unread conversation requests
Set Limit to 30, Read State Filter to Unread, and Status Filter to Requests.
Example 2: Paginate through all conversations 50 at a time
Set Limit to 50 and provide the Cursor from the previous output to fetch the next batch.