List users

GET

/v1/convai/users

GET

/v1/convai/users

$ curl -G https://api.elevenlabs.io/v1/convai/users \
>      -H "Content-Type: application/json" \
>      -d agent_id=agent_id \
>      -d branch_id=branch_id \
>      -d call_start_before_unix=1 \
>      -d call_start_after_unix=1 \
>      -d search=search \
>      -d page_size=1 \
>      -d sort_by=last_contact_unix_secs \
>      -d cursor=cursor

1 {
2   "users": [
3     {
4       "user_id": "user_9f8b7c6d5e4a3b2c1d0e",
5       "last_contact_unix_secs": 1685606400,
6       "first_contact_unix_secs": 1672531200,
7       "conversation_count": 42,
8       "last_contact_conversation_id": "conv_5a6b7c8d9e0f1a2b3c4d",
9       "last_contact_agent_id": "agent_3701k3ttaq12ewp8b7qv5rfyszkz",
10       "last_contact_agent_name": "SupportBot Alpha"
11     }
12   ],
13   "has_more": true,
14   "next_cursor": "eyJwYWdlIjoxfQ=="
15 }

Get distinct users from conversations with pagination.

Query parameters

agent_idstringOptional

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

branch_idstringOptional

Filter conversations by branch ID.

call_start_before_unixintegerOptional

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

call_start_after_unixintegerOptional

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

searchstringOptional

Search/filter by user ID (exact match).

page_sizeintegerOptional1-100Defaults to 30

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

sort_byenumOptional

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

Allowed values:

cursorstringOptional

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

Response

Successful Response

userslist of objects

has_moreboolean

next_cursorstring

Errors

422

Users List Request Unprocessable Entity Error

Headers

Query parameters

Response

Errors