Skip to main content
GET
List agent conversation users

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Path Parameters

app_id
string
required

ID of the app whose agents to read.

Query Parameters

search
string | null

Text to match, ignoring case, against the app user's email or full name, the agent's name, or a WhatsApp phone number. Only the first 200 characters are used.

owner_filter
string | null

Whose conversations to include. Either all, mine for only the ones you started as a user of the app, or others for everyone else's. Defaults to all.

agent_filter
string | null

Names of the agents to include, as a comma-separated list or a JSON array. For example, support_agent,sales_agent. Leave it out for every agent.

time_filter
string | null

Keep only conversations updated since midnight UTC (today), in the last 7 days (7d), or in the last 30 days (30d). Defaults to all.

role_filter
string | null

App roles to include, as a comma-separated list or a JSON array of user, admin, and editor. For example, user,admin. Anonymous visitors are left out when you set it. Defaults to all.

sort
string | null

Single field to sort users by, prefixed with - for descending. Either last_message_time, created_date, updated_date, agent_count, conversation_count, or credit_count. For example, -conversation_count puts the most active users first. Defaults to -last_message_time, and any other field sorts by last_message_time.

limit
integer | null

Items per page. Max 100. Defaults to 20, and 0 also means 20.

skip
integer | null

Number of users to skip before the page starts. Defaults to 0.

Response

A page of the users who have conversations with the app's agents.

A page of the app users who have conversations with the app's agents.

items
ConversationUserSummary · object[]
required

The users on this page.

total
integer
required

Total number of matching users.

Example:

42