f0f28319e448
Get conversations
Retrieve conversations in an organization based on supplied filters.
Permissions
This endpoint may be impacted by the following permissions:
- The final_message field in the response is only non-empty if the authenticated user has the Conversation.GetMessage permission on the final message.
- The version_set_info field in the response is only non-empty if the authenticated user has the Service.GetVersionSet permission on the version set.
- Only conversations for which the user has the Conversation.GetConversation permission are returned.
Path parameters
Query parameters
The identifier of the user whose conversations to retrieve.
The identifier of the user whose conversations to retrieve.
The identifier of the service whose conversation to retrieve.
The identifier of the service whose conversation to retrieve.
Whether the conversation is finished.
Whether the conversation is finished.
The ID of the conversation to retrieve.
The ID of the conversation to retrieve.
The maximum number of conversations to retrieve.
The maximum number of conversations to retrieve.
The continuation token returned from the previous response to retrieve the next set of conversations.
The continuation token returned from the previous response to retrieve the next set of conversations.
The field to sort the conversations by. Supported fields are created_at. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.
The field to sort the conversations by. Supported fields are created_at. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.
The tags of the dynamic behavior sets. Must be specified using the syntax key:value, which means to match all sets with the given key and value pair among its tags. If value is *, it means the value does not matter. If value is empty, it matches against when the value is None.
The tags of the dynamic behavior sets. Must be specified using the syntax key:value, which means to match all sets with the given key and value pair among its tags. If value is *, it means the value does not matter. If value is empty, it matches against when the value is None.
Headers
The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
Response
Succeeded.