Conversations

Get org-wide conversations (batch endpoint)

Retrieve all conversations across all campaigns and targets in one request.

Performance:

  • Replaces 100+ per-target requests with 1 batch query
  • Reduces Prisma pool usage from 100+ connections to 1
  • Response time: <500ms vs 18-24s with timeouts

Use case: Inbox list view

get/api/v1/conversations

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/conversations
  • Auth: bearerAuth (a scheme the document does not define)

Query parameters

pageinteger
limitinteger
channel'whatsapp' | 'sms' | 'email' | 'instagram'

Filter conversations by channel

campaignIdstring uuid

Filter conversations by campaign ID

targetIdstring uuid

Filter conversations by target ID

activityState'active' | 'closed'

Filter by activity state (active = open/within 24h window, closed = completed/paused/expired)

handoffState'ai' | 'human'

Filter by handoff state

autoReplyActivestring

Filter by auto-reply status

isOrphanedstring

Filter unassigned conversations (no target)

searchstring

Search by phone number (toNumber contains)

createdAtGtstring

createdAt greater than (exclusive)

createdAtGtestring

createdAt greater than or equal (inclusive)

createdAtLtstring

createdAt less than (exclusive)

createdAtLtestring

createdAt less than or equal (inclusive)

needsReplystring

Filter conversations where customer was last to message (>3 min ago, not snoozed)

assignedUserIdstring

Filter by assigned user UUID (use 'unassigned' for conversations with no assignee)

metadataobject
analysisobject

Response

Success

successtrue required
dataunknown
messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.