get
/conversationsList conversations
Returns conversations accessible to the authenticated user. Use this before polling message history or assigning work to a teammate.
Authorization
Scheme
- bearerAuth
Required scopes
- conversation:list
Allowed roles
- owner
- admin
- agent
List conversations in the caller's conversation scope.
Parameters
- Name
pageSize- Type
- query integer
- Description
- Optional parameter.
- Name
pageToken- Type
- query string
- Description
- Optional parameter.
- Name
interacted- Type
- query boolean
- Description
- Optional parameter.
- Name
search- Type
- query string
- Description
- Case-insensitive substring search across the conversation name and external identifier.
- Name
conversationIds- Type
- query array<string>
- Description
- Return explicit conversations by ID, preserving normal authorization scope.
- Name
status- Type
- query array<enum>
- Description
- Optional parameter.
- Name
ownerType- Type
- query array<enum>
- Description
- Optional parameter.
- Name
sort- Type
- query enum
- Description
- Optional parameter.
- Name
orderDirection- Type
- query enum
- Description
- Optional parameter.
Responses
- 200
List of conversations
- application/json ListConversationsResponse
- default
Error
- application/json ProblemDetails