Agents Platform

Get Conversation Users

Changed on

Get distinct users from conversations with pagination.

get/v1/convai/users

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/convai/users
  • Auth
    none declared

Query parameters

agent_idstring nullable

Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.

Example:agent_3701k3ttaq12ewp8b7qv5rfyszkz
branch_idstring nullable

Filter conversations by branch ID.

call_start_before_unixinteger nullable

Unix timestamp (in seconds) to filter conversations up to this start date.

call_start_after_unixinteger nullable

Unix timestamp (in seconds) to filter conversations after to this start date.

searchstring nullable

Search/filter by user ID (exact match).

page_sizeinteger

How many users to return at maximum. Defaults to 30.

sort_by'last_contact_unix_secs' | 'conversation_count' | 'average_sentiment_score'

The field to sort the results by. Defaults to last_contact_unix_secs.

sort_direction'asc' | 'desc'

The direction to sort the results

cursorstring nullable

Used for fetching next page. Cursor is returned in the response.

Headers

xi-api-keystring 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

Successful Response

next_cursorstring nullable
has_moreboolean required

Changes

  • 009bd651509aRevision changes
    • info

      added the new optional query request parameter sort_direction

    • info

      added the new enum value average_sentiment_score to the query request parameter sort_by

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

  • deb5e58ddddfRevision changes
    • info

      endpoint added