Skip to main content
GET
Get Agent Conversations
Returns conversations sorted by timestamp (newest first). Empty conversations without essential data are filtered out.
Use page and limit query parameters to paginate large conversation lists efficiently.

Query Parameters

Example Response

Response Fields

Each conversation in the array includes:

Lead Information

  • userName, userEmail, userPhone - Contact details
  • userAddress, userCompany, userWebsite - Additional information
  • notes - Internal notes about the lead
  • userProfilePic - Profile picture URL

Conversation Metadata

  • ID, userID - Identifiers
  • messagesNum - Message count
  • tags - Categorization tags
  • origin - Channel (e.g., “web-chat”, “whatsapp”)
  • Timestamps: ts, firstMessageTS, lastMessageTS

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agentId
string
required

Query Parameters

cursor
string
limit
integer
default:20
Required range: 1 <= x <= 100
page
integer
default:1
Required range: x >= 1

Response

Successful response

success
boolean
required
message
string
required
data
object[]
required
hasMore
boolean
required
nextCursor
string | null
required
limit
number
required
cached
boolean
rateLimit
object