List users

Get distinct users from conversations with pagination.

agent_idstringOptional

The id of the agent you're taking the action on.

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.

Successful Response

userslist of objects

has_moreboolean

next_cursorstring or null

1	from elevenlabs import ElevenLabs
2
3	client = ElevenLabs()
4
5	client.conversational_ai.users.list(
6	agent_id="agent_id",
7	branch_id="branch_id",
8	call_start_before_unix=1,
9	call_start_after_unix=1,
10	search="search",
11	page_size=1,
12	sort_by="last_contact_unix_secs",
13	cursor="cursor",
14	)

1	{
2	"users": [
3	{
4	"user_id": "user_987654321",
5	"last_contact_unix_secs": 1685606400,
6	"first_contact_unix_secs": 1677628800,
7	"conversation_count": 15,
8	"last_contact_conversation_id": "conv_1234567890abcdef",
9	"last_contact_agent_id": "21m00Tcm4TlvDq8ikWAM",
10	"last_contact_agent_name": "Agent Smith"
11	}
12	],
13	"has_more": true,
14	"next_cursor": "eyJwYWdlIjoxfQ=="
15	}