---
title: "Get Conversation Users"
method: GET
path: "/v1/convai/users"
tags: ["Agents Platform"]
---

# Get Conversation Users

`GET /v1/convai/users`

Get distinct users from conversations with pagination.

## Query parameters

- `agent_id` string, nullable — Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.
- `branch_id` string, nullable — Filter conversations by branch ID.
- `call_start_before_unix` integer, nullable — Unix timestamp (in seconds) to filter conversations up to this start date.
- `call_start_after_unix` integer, nullable — Unix timestamp (in seconds) to filter conversations after to this start date.
- `search` string, nullable — Search/filter by user ID (exact match).
- `page_size` integer — How many users to return at maximum. Defaults to 30.
- `sort_by` 'last_contact_unix_secs' | 'conversation_count' | 'average_sentiment_score'
- `sort_direction` 'asc' | 'desc'
- `cursor` string, nullable — Used for fetching next page. Cursor is returned in the response.

## Headers

- `xi-api-key` string, nullable — Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

## Response `200`

Successful Response

- GetConversationUsersPageResponseModel
  - `users` ConversationUserResponseModel[], required
    - `user_id` string, required
    - `last_contact_unix_secs` integer, required
    - `first_contact_unix_secs` integer, required
    - `conversation_count` integer, required
    - `last_contact_agent_id` string, nullable
    - `last_contact_conversation_id` string, required
    - `last_contact_agent_name` string, nullable
    - `sentiment` SentimentAggregate, required
      - `scored_conversation_count` integer, required
      - `positive_count` integer, required
      - `neutral_count` integer, required
      - `negative_count` integer, required
      - `average_sentiment_score` number, nullable, required
      - `average_frustration_score` number, nullable, required
      - `recent_scored_conversation_count` integer, required
      - `recent_positive_count` integer, required
      - `recent_neutral_count` integer, required
      - `recent_negative_count` integer, required
      - `recent_average_sentiment_score` number, nullable, required
      - `recent_average_frustration_score` number, nullable, required
    - `most_frustrated_conversations` FrustratedConversationRef[]
      - `conversation_id` string, required
      - `agent_id` string, required
      - `start_time_unix_secs` integer, required
      - `overall_label` 'positive' | 'neutral' | 'negative', required
      - `overall_sentiment_score` number, required
      - `overall_frustration_score` number, required
  - `next_cursor` string, nullable
  - `has_more` boolean, required

## Other responses

- `422` — Validation Error

---

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