v93

OpenAPI 3.1.0raw.githubusercontent.com2026-08-01218121759.7 KB
Conversations

List conversations

Lists inbox conversations with subscriber replies, filtered by status, unread flag, or search term.

get/conversations

Query parameters

status'all' | 'open' | 'closed'

Filter by conversation status.

searchstring

Search in subject, subscriber email, or subscriber name.

pageinteger

Page number.

limitinteger

Results per page.

unread'true'

Pass "true" to only return conversations with unread messages.

Response

Conversations returned

successboolean

Example response

{
  "success": true,
  "conversations": [
    {
      "id": "conv_abc123",
      "lastMessageBy": "subscriber",
      "context": {
        "type": "campaign"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 100,
    "totalPages": 5
  }
}