Conversations

List conversations

Returns conversation summaries, most recently active first, filterable by status, channel, contact, mailbox, and creation time (`after`, `before`).

GET
/v1/conversations

Returns conversation summaries, most recently active first, filterable by status, channel, contact, mailbox, and creation time (after, before). Pass nextCursor back as cursor for the next page; it is null on the last page. A conversation that gains activity while you page moves ahead of the cursor, so a walk lists each conversation at most once. Read a conversation's contacts, metadata, and resolution with GET /v1/conversations/{id}.

Authorization

apiKey
headerx-api-key<token>

Query Parameters

limit?|null
cursor?string
status?string
Value in"active""waiting""resolved""escalated""archived"
channel?string
Value in"sms""whatsapp""email"
contactId?string
Match^contact_[0-9a-hjkmnp-tv-z]{16,24}$
mailboxId?string
Match^mbx_[0-9a-hjkmnp-tv-z]{16,24}$
after?string
before?string

Response Body

ConversationPage

application/json
  1. response
items*array<>
nextCursor*string|null
Example Request
import { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.conversations.list({});
Example Response
{  "items": [    {      "id": "string",      "title": "string",      "externalId": "string",      "status": "active",      "primaryChannel": "sms",      "channels": [        "sms"      ],      "priority": 0,      "urgency": "low",      "tags": [        "string"      ],      "isTest": true,      "messageCount": 0,      "lastActivityAt": "string",      "createdAt": "string"    }  ],  "nextCursor": "string"}

Related documentation