---
title: "Get conversations"
method: GET
path: "/v1/{organization}/conversation/"
tags: ["Conversation"]
---

# Get conversations

`GET /v1/{organization}/conversation/`

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

- `organization` string, required

## Query parameters

- `user_id` string[] — The identifier of the user whose conversations to retrieve.
- `service_id` string[] — The identifier of the service whose conversation to retrieve.
- `is_finished` boolean, nullable — Whether the conversation is finished.
- `id` string[] — The ID of the conversation to retrieve.
- `limit` integer — The maximum number of conversations to retrieve.
- `continuation_token` integer — The continuation token returned from the previous response to retrieve the next set of conversations.
- `sort_by` string[] — 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.
- `tag` string[] — 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

- `x-mongo-cluster-name` string, nullable — 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.
- `Sec-WebSocket-Protocol` string[]

## Response `200`

Succeeded.

- SrcAppEndpointsConversationGetConversationsResponse
  - `conversations` ConversationInstance[], required — The conversations satisfying the filters.
    - `id` string, required — The identifier of the conversation.
    - `user_id` string, required — The identifier of the user who started this conversation.
    - `created_at` string, date-time, required — The timestamp at which this conversation was started.
    - `is_finished` boolean, required — Whether the conversation is finished.
    - `is_analyzed` boolean, required — Whether the conversation has gone through the post-conversation analysis after finishing.
    - `completed_post_processings` PostAnalysisType[], required — A list of post-processing types that have been completed for this conversation.
    - `final_message` string, required — The most recent message from the conversation. This field is empty if the authenticated user has no `Conversation:GetMessage` permission on the final message.
    - `service_id` string, required — The ID of the service that this conversation uses.
    - `version_set_info` VersionSetInfo, required
      - `name` string, required — The name of the version set. If the value is `unknown`, it means the conversation was created before this field was introduced and the version set name cannot be retroactively determined.
      - `agent_version_info` unknown[], required — The ID of the agent and version number used in this conversation.
        - unknown
      - `service_hierarchical_state_machine_version_info` unknown[], required — The ID of the state machine and version number used in this conversation.
        - unknown
      - `llm_model_preferences` object, required — The LLM model preferences for this version set.
    - `num_messages` integer, required — The number of messages in this conversation.
    - `tags` object, required — The tags associated with this conversation.
  - `has_more` boolean, required — Whether there are more conversations to retrieve.
  - `continuation_token` integer, nullable, required — A token to supply to the next request to retrieve the next page of conversations. Only populated if `has_more` is `True`.

## Other responses

- `401` — Invalid authorization credentials.
- `403` — Missing required permissions.
- `422` — Invalid request path parameter or query parameter failed validation.
- `429` — The user has exceeded the rate limit of 15 requests per minute for this endpoint.
- `503` — The service is going through temporary maintenance.

---

[API](https://skmtc.net/amigo/apis/amigo-api.md) · [All operations](https://skmtc.net/amigo/apis/amigo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/amigo/amigo-api/revisions/f0f28319e448/schema)